Class DocumentDbCollectionSink
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.CopySink
-
- com.azure.analytics.synapse.artifacts.models.DocumentDbCollectionSink
-
public final class DocumentDbCollectionSink extends CopySink
A copy activity Document Database Collection sink.
-
-
Constructor Summary
Constructors Constructor Description DocumentDbCollectionSink()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getNestingSeparator()
Get the nestingSeparator property: Nested properties separator.Object
getWriteBehavior()
Get the writeBehavior property: Describes how to write data to Azure Cosmos DB.DocumentDbCollectionSink
setMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.DocumentDbCollectionSink
setNestingSeparator(Object nestingSeparator)
Set the nestingSeparator property: Nested properties separator.DocumentDbCollectionSink
setSinkRetryCount(Object sinkRetryCount)
Set the sinkRetryCount property: Sink retry count.DocumentDbCollectionSink
setSinkRetryWait(Object sinkRetryWait)
Set the sinkRetryWait property: Sink retry wait.DocumentDbCollectionSink
setWriteBatchSize(Object writeBatchSize)
Set the writeBatchSize property: Write batch size.DocumentDbCollectionSink
setWriteBatchTimeout(Object writeBatchTimeout)
Set the writeBatchTimeout property: Write batch timeout.DocumentDbCollectionSink
setWriteBehavior(Object writeBehavior)
Set the writeBehavior property: Describes how to write data to Azure Cosmos DB.-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.CopySink
getAdditionalProperties, getMaxConcurrentConnections, getSinkRetryCount, getSinkRetryWait, getWriteBatchSize, getWriteBatchTimeout, setAdditionalProperties
-
-
-
-
Method Detail
-
getNestingSeparator
public Object getNestingSeparator()
Get the nestingSeparator property: Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).- Returns:
- the nestingSeparator value.
-
setNestingSeparator
public DocumentDbCollectionSink setNestingSeparator(Object nestingSeparator)
Set the nestingSeparator property: Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).- Parameters:
nestingSeparator
- the nestingSeparator value to set.- Returns:
- the DocumentDbCollectionSink object itself.
-
getWriteBehavior
public Object getWriteBehavior()
Get the writeBehavior property: Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.- Returns:
- the writeBehavior value.
-
setWriteBehavior
public DocumentDbCollectionSink setWriteBehavior(Object writeBehavior)
Set the writeBehavior property: Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.- Parameters:
writeBehavior
- the writeBehavior value to set.- Returns:
- the DocumentDbCollectionSink object itself.
-
setWriteBatchSize
public DocumentDbCollectionSink setWriteBatchSize(Object writeBatchSize)
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
public DocumentDbCollectionSink 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 classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
setSinkRetryCount
public DocumentDbCollectionSink setSinkRetryCount(Object sinkRetryCount)
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
public DocumentDbCollectionSink 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 classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
setMaxConcurrentConnections
public DocumentDbCollectionSink 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 classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-
-