Package com.azure.resourcemanager.datafactory.models

Class RestSource

java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySource
com.azure.resourcemanager.datafactory.models.RestSource
public final class RestSource extends CopySource
A copy activity Rest service source.

  • Constructor Details

    • RestSource

      public RestSource()

  • Method Details

    • requestMethod

      public Object requestMethod()
      Get the requestMethod property: The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
      Returns:
      the requestMethod value.

    • withRequestMethod

      public RestSource withRequestMethod(Object requestMethod)
      Set the requestMethod property: The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
      Parameters:
      requestMethod - the requestMethod value to set.
      Returns:
      the RestSource object itself.

    • requestBody

      public Object requestBody()
      Get the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
      Returns:
      the requestBody value.

    • withRequestBody

      public RestSource withRequestBody(Object requestBody)
      Set the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
      Parameters:
      requestBody - the requestBody value to set.
      Returns:
      the RestSource object itself.

    • additionalHeaders

      public Object additionalHeaders()
      Get the additionalHeaders property: The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
      Returns:
      the additionalHeaders value.

    • withAdditionalHeaders

      public RestSource withAdditionalHeaders(Object additionalHeaders)
      Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
      Parameters:
      additionalHeaders - the additionalHeaders value to set.
      Returns:
      the RestSource object itself.

    • paginationRules

      public Object paginationRules()
      Get the paginationRules property: The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
      Returns:
      the paginationRules value.

    • withPaginationRules

      public RestSource withPaginationRules(Object paginationRules)
      Set the paginationRules property: The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
      Parameters:
      paginationRules - the paginationRules value to set.
      Returns:
      the RestSource object itself.

    • httpRequestTimeout

      public Object httpRequestTimeout()
      Get the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Returns:
      the httpRequestTimeout value.

    • withHttpRequestTimeout

      public RestSource withHttpRequestTimeout(Object httpRequestTimeout)
      Set the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Parameters:
      httpRequestTimeout - the httpRequestTimeout value to set.
      Returns:
      the RestSource object itself.

    • requestInterval

      public Object requestInterval()
      Get the requestInterval property: The time to await before sending next page request.
      Returns:
      the requestInterval value.

    • withRequestInterval

      public RestSource withRequestInterval(Object requestInterval)
      Set the requestInterval property: The time to await before sending next page request.
      Parameters:
      requestInterval - the requestInterval value to set.
      Returns:
      the RestSource object itself.

    • additionalColumns

      public Object additionalColumns()
      Get the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
      Returns:
      the additionalColumns value.

    • withAdditionalColumns

      public RestSource withAdditionalColumns(Object additionalColumns)
      Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
      Parameters:
      additionalColumns - the additionalColumns value to set.
      Returns:
      the RestSource object itself.

    • withSourceRetryCount

      public RestSource withSourceRetryCount(Object sourceRetryCount)
      Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
      Overrides:
      withSourceRetryCount in class CopySource
      Parameters:
      sourceRetryCount - the sourceRetryCount value to set.
      Returns:
      the CopySource object itself.

    • withSourceRetryWait

      public RestSource withSourceRetryWait(Object sourceRetryWait)
      Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Overrides:
      withSourceRetryWait in class CopySource
      Parameters:
      sourceRetryWait - the sourceRetryWait value to set.
      Returns:
      the CopySource object itself.

    • withMaxConcurrentConnections

      public RestSource withMaxConcurrentConnections(Object maxConcurrentConnections)
      Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
      Overrides:
      withMaxConcurrentConnections in class CopySource
      Parameters:
      maxConcurrentConnections - the maxConcurrentConnections value to set.
      Returns:
      the CopySource object itself.

    • withDisableMetricsCollection

      public RestSource withDisableMetricsCollection(Object disableMetricsCollection)
      Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
      Overrides:
      withDisableMetricsCollection in class CopySource
      Parameters:
      disableMetricsCollection - the disableMetricsCollection value to set.
      Returns:
      the CopySource object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class CopySource
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.