Class CosmosDbSqlApiSink

java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.CosmosDbSqlApiSink

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

    • CosmosDbSqlApiSink

      public CosmosDbSqlApiSink()
      Creates an instance of CosmosDbSqlApiSink class.
  • Method Details

    • writeBehavior

      public Object writeBehavior()
      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.
    • withWriteBehavior

      public CosmosDbSqlApiSink withWriteBehavior(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.
    • withWriteBatchSize

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

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

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

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

      public CosmosDbSqlApiSink withMaxConcurrentConnections(Object maxConcurrentConnections)
      Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
      Overrides:
      withMaxConcurrentConnections in class CopySink
      Parameters:
      maxConcurrentConnections - the maxConcurrentConnections value to set.
      Returns:
      the CopySink object itself.
    • withDisableMetricsCollection

      public CosmosDbSqlApiSink withDisableMetricsCollection(Object disableMetricsCollection)
      Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
      Overrides:
      withDisableMetricsCollection in class CopySink
      Parameters:
      disableMetricsCollection - the disableMetricsCollection value to set.
      Returns:
      the CopySink object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class CopySink
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.