Class RestSink
java.lang.Object
com.azure.analytics.synapse.artifacts.models.CopySink
com.azure.analytics.synapse.artifacts.models.RestSink
A copy activity Rest service Sink.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.Get the httpCompressionType property: Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None.Get the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response.Get the requestInterval property: The time to await before sending next request, in milliseconds.Get the requestMethod property: The HTTP method used to call the RESTful API.setAdditionalHeaders
(Object additionalHeaders) Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.setHttpCompressionType
(Object httpCompressionType) Set the httpCompressionType property: Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None.setHttpRequestTimeout
(Object httpRequestTimeout) Set the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response.setMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.setRequestInterval
(Object requestInterval) Set the requestInterval property: The time to await before sending next request, in milliseconds.setRequestMethod
(Object requestMethod) Set the requestMethod property: The HTTP method used to call the RESTful API.setSinkRetryCount
(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.setSinkRetryWait
(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.setWriteBatchSize
(Object writeBatchSize) Set the writeBatchSize property: Write batch size.setWriteBatchTimeout
(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.Methods inherited from class com.azure.analytics.synapse.artifacts.models.CopySink
getAdditionalProperties, getMaxConcurrentConnections, getSinkRetryCount, getSinkRetryWait, getWriteBatchSize, getWriteBatchTimeout, setAdditionalProperties
-
Constructor Details
-
RestSink
public RestSink()
-
-
Method Details
-
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
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
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
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
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
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
Get the requestInterval property: The time to await before sending next request, in milliseconds.- Returns:
- the requestInterval value.
-
setRequestInterval
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
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
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
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.- Overrides:
setWriteBatchSize
in classCopySink
- Parameters:
writeBatchSize
- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
-
setWriteBatchTimeout
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 classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
setSinkRetryCount
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).- Overrides:
setSinkRetryCount
in classCopySink
- Parameters:
sinkRetryCount
- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
-
setSinkRetryWait
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 classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
setMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).- Overrides:
setMaxConcurrentConnections
in classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-