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

Class DocumentDbCollectionSource

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

    • Constructor Detail

      • DocumentDbCollectionSource

        public DocumentDbCollectionSource()

    • Method Detail

      • getQuery

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

      • setQuery

        public DocumentDbCollectionSource setQuery​(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.

      • getNestingSeparator

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

      • setNestingSeparator

        public DocumentDbCollectionSource setNestingSeparator​(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.

      • getQueryTimeout

        public Object getQueryTimeout()
        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.

      • setQueryTimeout

        public DocumentDbCollectionSource setQueryTimeout​(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.

      • getAdditionalColumns

        public Object getAdditionalColumns()
        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.

      • setAdditionalColumns

        public DocumentDbCollectionSource setAdditionalColumns​(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.

      • setSourceRetryCount

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

      • setSourceRetryWait

        public DocumentDbCollectionSource setSourceRetryWait​(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:
        setSourceRetryWait in class CopySource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • setMaxConcurrentConnections

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