Package com.azure.analytics.synapse.artifacts.models

Class RestSource

  • public final class RestSource
extends CopySource
    A copy activity Rest service source.

    • Constructor Detail

      • RestSource

        public RestSource()

    • Method Detail

      • getRequestMethod

        public Object getRequestMethod()
        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.

      • setRequestMethod

        public RestSource setRequestMethod​(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.

      • getRequestBody

        public Object getRequestBody()
        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.

      • setRequestBody

        public RestSource setRequestBody​(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.

      • getAdditionalHeaders

        public Object getAdditionalHeaders()
        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.

      • setAdditionalHeaders

        public RestSource setAdditionalHeaders​(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.

      • getPaginationRules

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

      • setPaginationRules

        public RestSource setPaginationRules​(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.

      • getHttpRequestTimeout

        public Object getHttpRequestTimeout()
        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.

      • setHttpRequestTimeout

        public RestSource setHttpRequestTimeout​(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.

      • getRequestInterval

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

      • setRequestInterval

        public RestSource setRequestInterval​(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.

      • getAdditionalColumns

        public Object getAdditionalColumns()
        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.

      • setAdditionalColumns

        public RestSource setAdditionalColumns​(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.

      • setSourceRetryCount

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

      • setSourceRetryWait

        public RestSource setSourceRetryWait​(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:
        setSourceRetryWait in class CopySource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • setMaxConcurrentConnections

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