Class RestSink


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

      • RestSink

        public RestSink()
    • Method Detail

      • requestMethod

        public Object requestMethod()
        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.
      • withRequestMethod

        public RestSink withRequestMethod​(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.
      • 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 RestSink 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 RestSink 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 RestSink 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 RestSink object itself.
      • requestInterval

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

        public RestSink withRequestInterval​(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.
      • httpCompressionType

        public Object httpCompressionType()
        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.
      • withHttpCompressionType

        public RestSink withHttpCompressionType​(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.
      • withWriteBatchSize

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

        public RestSink withWriteBatchTimeout​(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:
        withWriteBatchTimeout in class CopySink
        Parameters:
        writeBatchTimeout - the writeBatchTimeout value to set.
        Returns:
        the CopySink object itself.
      • withSinkRetryCount

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

        public RestSink withSinkRetryWait​(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:
        withSinkRetryWait in class CopySink
        Parameters:
        sinkRetryWait - the sinkRetryWait value to set.
        Returns:
        the CopySink object itself.
      • withMaxConcurrentConnections

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

        public RestSink 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 CopySink
        Parameters:
        disableMetricsCollection - the disableMetricsCollection value to set.
        Returns:
        the CopySink object itself.