Class RestSink
java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.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.void
validate()
Validates the instance.withAdditionalHeaders
(Object additionalHeaders) Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.withDisableMetricsCollection
(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.withHttpCompressionType
(Object httpCompressionType) Set the httpCompressionType property: Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None.withHttpRequestTimeout
(Object httpRequestTimeout) Set the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response.withMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.withRequestInterval
(Object requestInterval) Set the requestInterval property: The time to await before sending next request, in milliseconds.withRequestMethod
(Object requestMethod) Set the requestMethod property: The HTTP method used to call the RESTful API.withSinkRetryCount
(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.withSinkRetryWait
(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.withWriteBatchSize
(Object writeBatchSize) Set the writeBatchSize property: Write batch size.withWriteBatchTimeout
(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySink
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sinkRetryCount, sinkRetryWait, withAdditionalProperties, writeBatchSize, writeBatchTimeout
-
Constructor Details
-
RestSink
public RestSink()Creates an instance of RestSink class.
-
-
Method Details
-
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
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
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
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
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
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
Get the requestInterval property: The time to await before sending next request, in milliseconds.- Returns:
- the requestInterval value.
-
withRequestInterval
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
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
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
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.- Overrides:
withWriteBatchSize
in classCopySink
- Parameters:
writeBatchSize
- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
-
withWriteBatchTimeout
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 classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryCount
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).- Overrides:
withSinkRetryCount
in classCopySink
- Parameters:
sinkRetryCount
- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryWait
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 classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
withMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).- Overrides:
withMaxConcurrentConnections
in classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-
withDisableMetricsCollection
Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).- Overrides:
withDisableMetricsCollection
in classCopySink
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the CopySink object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classCopySink
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-