Package com.azure.analytics.synapse.artifacts.models

Class CosmosDbSqlApiSink

  • public final class CosmosDbSqlApiSink
extends CopySink
    A copy activity Azure CosmosDB (SQL API) Collection sink.

    • Constructor Detail

      • CosmosDbSqlApiSink

        public CosmosDbSqlApiSink()

    • Method Detail

      • 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 CosmosDbSqlApiSink 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 CosmosDbSqlApiSink object itself.

      • setWriteBatchSize

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

      • setWriteBatchTimeout

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

      • setSinkRetryCount

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

      • setSinkRetryWait

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

      • setMaxConcurrentConnections

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