Class CosmosDbMongoDbApiSink
java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.CosmosDbMongoDbApiSink
A copy activity sink for a CosmosDB (MongoDB API) database.
-
Constructor Summary
ConstructorDescriptionCreates an instance of CosmosDbMongoDbApiSink class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
validate()
Validates the instance.withDisableMetricsCollection
(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.withMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.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.withWriteBehavior
(Object writeBehavior) Set the writeBehavior property: Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert).Get the writeBehavior property: Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert).Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySink
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sinkRetryCount, sinkRetryWait, withAdditionalProperties, writeBatchSize, writeBatchTimeout
-
Constructor Details
-
CosmosDbMongoDbApiSink
public CosmosDbMongoDbApiSink()Creates an instance of CosmosDbMongoDbApiSink class.
-
-
Method Details
-
writeBehavior
Get the writeBehavior property: Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).- Returns:
- the writeBehavior value.
-
withWriteBehavior
Set the writeBehavior property: Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).- Parameters:
writeBehavior
- the writeBehavior value to set.- Returns:
- the CosmosDbMongoDbApiSink 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.
-