Package com.azure.resourcemanager.datafactory.models

Class DocumentDbCollectionSource

  • public final class DocumentDbCollectionSource
extends CopySource
    A copy activity Document Database Collection source.

    • Constructor Detail

      • DocumentDbCollectionSource

        public DocumentDbCollectionSource()

    • Method Detail

      • query

        public Object query()
        Get the query property: Documents query. Type: string (or Expression with resultType string).
        Returns:
        the query value.

      • withQuery

        public DocumentDbCollectionSource withQuery​(Object query)
        Set the query property: Documents query. Type: string (or Expression with resultType string).
        Parameters:
        query - the query value to set.
        Returns:
        the DocumentDbCollectionSource object itself.

      • nestingSeparator

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

      • withNestingSeparator

        public DocumentDbCollectionSource withNestingSeparator​(Object nestingSeparator)
        Set the nestingSeparator property: Nested properties separator. Type: string (or Expression with resultType string).
        Parameters:
        nestingSeparator - the nestingSeparator value to set.
        Returns:
        the DocumentDbCollectionSource object itself.

      • queryTimeout

        public Object queryTimeout()
        Get the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Returns:
        the queryTimeout value.

      • withQueryTimeout

        public DocumentDbCollectionSource withQueryTimeout​(Object queryTimeout)
        Set the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Parameters:
        queryTimeout - the queryTimeout value to set.
        Returns:
        the DocumentDbCollectionSource object itself.

      • additionalColumns

        public Object additionalColumns()
        Get the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
        Returns:
        the additionalColumns value.

      • withAdditionalColumns

        public DocumentDbCollectionSource withAdditionalColumns​(Object additionalColumns)
        Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
        Parameters:
        additionalColumns - the additionalColumns value to set.
        Returns:
        the DocumentDbCollectionSource object itself.

      • withSourceRetryCount

        public DocumentDbCollectionSource withSourceRetryCount​(Object sourceRetryCount)
        Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        withSourceRetryCount in class CopySource
        Parameters:
        sourceRetryCount - the sourceRetryCount value to set.
        Returns:
        the CopySource object itself.

      • withSourceRetryWait

        public DocumentDbCollectionSource withSourceRetryWait​(Object sourceRetryWait)
        Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        withSourceRetryWait in class CopySource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • withMaxConcurrentConnections

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

      • withDisableMetricsCollection

        public DocumentDbCollectionSource 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 CopySource
        Parameters:
        disableMetricsCollection - the disableMetricsCollection value to set.
        Returns:
        the CopySource object itself.