Class DocumentDbCollectionSink


  • public final class DocumentDbCollectionSink
    extends CopySink
    A copy activity Document Database Collection sink.
    • Constructor Detail

      • DocumentDbCollectionSink

        public DocumentDbCollectionSink()
    • Method Detail

      • nestingSeparator

        public Object nestingSeparator()
        Get the nestingSeparator property: Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).
        Returns:
        the nestingSeparator value.
      • withNestingSeparator

        public DocumentDbCollectionSink withNestingSeparator​(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.
      • 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 DocumentDbCollectionSink 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 DocumentDbCollectionSink object itself.
      • withWriteBatchSize

        public DocumentDbCollectionSink 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 DocumentDbCollectionSink 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 DocumentDbCollectionSink 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 DocumentDbCollectionSink 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 DocumentDbCollectionSink 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 DocumentDbCollectionSink 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.