Class CosmosDbMongoDbApiSource
java.lang.Object
com.azure.analytics.synapse.artifacts.models.CopySource
com.azure.analytics.synapse.artifacts.models.CosmosDbMongoDbApiSource
A copy activity source for a CosmosDB (MongoDB API) database.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the additionalColumns property: Specifies the additional columns to be added to source data.Get the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.Get the cursorMethods property: Cursor methods for Mongodb query.Get the filter property: Specifies selection filter using query operators.Get the queryTimeout property: Query timeout.setAdditionalColumns
(Object additionalColumns) Set the additionalColumns property: Specifies the additional columns to be added to source data.setBatchSize
(Object batchSize) Set the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.setCursorMethods
(MongoDbCursorMethodsProperties cursorMethods) Set the cursorMethods property: Cursor methods for Mongodb query.Set the filter property: Specifies selection filter using query operators.setMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.setQueryTimeout
(Object queryTimeout) Set the queryTimeout property: Query timeout.setSourceRetryCount
(Object sourceRetryCount) Set the sourceRetryCount property: Source retry count.setSourceRetryWait
(Object sourceRetryWait) Set the sourceRetryWait property: Source retry wait.Methods inherited from class com.azure.analytics.synapse.artifacts.models.CopySource
getAdditionalProperties, getMaxConcurrentConnections, getSourceRetryCount, getSourceRetryWait, setAdditionalProperties
-
Constructor Details
-
CosmosDbMongoDbApiSource
public CosmosDbMongoDbApiSource()
-
-
Method Details
-
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
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
Get the cursorMethods property: Cursor methods for Mongodb query.- Returns:
- the cursorMethods value.
-
setCursorMethods
Set the cursorMethods property: Cursor methods for Mongodb query.- Parameters:
cursorMethods
- the cursorMethods value to set.- Returns:
- the CosmosDbMongoDbApiSource object itself.
-
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
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
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
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
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
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
Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).- Overrides:
setSourceRetryCount
in classCopySource
- Parameters:
sourceRetryCount
- the sourceRetryCount value to set.- Returns:
- the CopySource object itself.
-
setSourceRetryWait
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 classCopySource
- Parameters:
sourceRetryWait
- the sourceRetryWait value to set.- Returns:
- the CopySource object itself.
-
setMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).- Overrides:
setMaxConcurrentConnections
in classCopySource
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySource object itself.
-