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

Class RestSink

  • public final class RestSink
extends CopySink
    A copy activity Rest service Sink.

    • Constructor Detail

      • RestSink

        public RestSink()

    • Method Detail

      • getRequestMethod

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

      • setRequestMethod

        public RestSink setRequestMethod​(Object requestMethod)
        Set the requestMethod property: The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).
        Parameters:
        requestMethod - the requestMethod value to set.
        Returns:
        the RestSink 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 RestSink 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 RestSink 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 RestSink 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 RestSink object itself.

      • getRequestInterval

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

      • setRequestInterval

        public RestSink setRequestInterval​(Object requestInterval)
        Set the requestInterval property: The time to await before sending next request, in milliseconds.
        Parameters:
        requestInterval - the requestInterval value to set.
        Returns:
        the RestSink object itself.

      • getHttpCompressionType

        public Object getHttpCompressionType()
        Get the httpCompressionType property: Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.
        Returns:
        the httpCompressionType value.

      • setHttpCompressionType

        public RestSink setHttpCompressionType​(Object httpCompressionType)
        Set the httpCompressionType property: Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.
        Parameters:
        httpCompressionType - the httpCompressionType value to set.
        Returns:
        the RestSink object itself.

      • setWriteBatchSize

        public RestSink setWriteBatchSize​(Object writeBatchSize)
        Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
        Overrides:
        setWriteBatchSize in class CopySink
        Parameters:
        writeBatchSize - the writeBatchSize value to set.
        Returns:
        the CopySink object itself.

      • setWriteBatchTimeout

        public RestSink setWriteBatchTimeout​(Object writeBatchTimeout)
        Set the writeBatchTimeout property: Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        setWriteBatchTimeout in class CopySink
        Parameters:
        writeBatchTimeout - the writeBatchTimeout value to set.
        Returns:
        the CopySink object itself.

      • setSinkRetryCount

        public RestSink setSinkRetryCount​(Object sinkRetryCount)
        Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        setSinkRetryCount in class CopySink
        Parameters:
        sinkRetryCount - the sinkRetryCount value to set.
        Returns:
        the CopySink object itself.

      • setSinkRetryWait

        public RestSink setSinkRetryWait​(Object sinkRetryWait)
        Set the sinkRetryWait property: Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        setSinkRetryWait in class CopySink
        Parameters:
        sinkRetryWait - the sinkRetryWait value to set.
        Returns:
        the CopySink object itself.

      • setMaxConcurrentConnections

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