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

Class CosmosDbMongoDbApiSource

  • public final class CosmosDbMongoDbApiSource
extends CopySource
    A copy activity source for a CosmosDB (MongoDB API) database.

    • Constructor Detail

      • CosmosDbMongoDbApiSource

        public CosmosDbMongoDbApiSource()

    • Method Detail

      • getFilter

        public Object getFilter()
        Get the filter property: Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
        Returns:
        the filter value.

      • setFilter

        public CosmosDbMongoDbApiSource setFilter​(Object filter)
        Set the filter property: Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
        Parameters:
        filter - the filter value to set.
        Returns:
        the CosmosDbMongoDbApiSource object itself.

      • getCursorMethods

        public MongoDbCursorMethodsProperties getCursorMethods()
        Get the cursorMethods property: Cursor methods for Mongodb query.
        Returns:
        the cursorMethods value.

      • setCursorMethods

        public CosmosDbMongoDbApiSource setCursorMethods​(MongoDbCursorMethodsProperties cursorMethods)
        Set the cursorMethods property: Cursor methods for Mongodb query.
        Parameters:
        cursorMethods - the cursorMethods value to set.
        Returns:
        the CosmosDbMongoDbApiSource object itself.

      • getBatchSize

        public Object getBatchSize()
        Get the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
        Returns:
        the batchSize value.

      • setBatchSize

        public CosmosDbMongoDbApiSource setBatchSize​(Object batchSize)
        Set the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
        Parameters:
        batchSize - the batchSize value to set.
        Returns:
        the CosmosDbMongoDbApiSource 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 CosmosDbMongoDbApiSource 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 CosmosDbMongoDbApiSource 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 CosmosDbMongoDbApiSource 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 CosmosDbMongoDbApiSource object itself.

      • setSourceRetryCount

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