Class MongoDbV2Source
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.CopySource
-
- com.azure.analytics.synapse.artifacts.models.MongoDbV2Source
-
public final class MongoDbV2Source extends CopySource
A copy activity source for a MongoDB database.
-
-
Constructor Summary
Constructors Constructor Description MongoDbV2Source()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getAdditionalColumns()
Get the additionalColumns property: Specifies the additional columns to be added to source data.Object
getBatchSize()
Get the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.MongoDbCursorMethodsProperties
getCursorMethods()
Get the cursorMethods property: Cursor methods for Mongodb query.Object
getFilter()
Get the filter property: Specifies selection filter using query operators.Object
getQueryTimeout()
Get the queryTimeout property: Query timeout.MongoDbV2Source
setAdditionalColumns(Object additionalColumns)
Set the additionalColumns property: Specifies the additional columns to be added to source data.MongoDbV2Source
setBatchSize(Object batchSize)
Set the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.MongoDbV2Source
setCursorMethods(MongoDbCursorMethodsProperties cursorMethods)
Set the cursorMethods property: Cursor methods for Mongodb query.MongoDbV2Source
setFilter(Object filter)
Set the filter property: Specifies selection filter using query operators.MongoDbV2Source
setMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.MongoDbV2Source
setQueryTimeout(Object queryTimeout)
Set the queryTimeout property: Query timeout.MongoDbV2Source
setSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count.MongoDbV2Source
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
-
-
-
-
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 MongoDbV2Source 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 MongoDbV2Source object itself.
-
getCursorMethods
public MongoDbCursorMethodsProperties getCursorMethods()
Get the cursorMethods property: Cursor methods for Mongodb query.- Returns:
- the cursorMethods value.
-
setCursorMethods
public MongoDbV2Source setCursorMethods(MongoDbCursorMethodsProperties cursorMethods)
Set the cursorMethods property: Cursor methods for Mongodb query.- Parameters:
cursorMethods
- the cursorMethods value to set.- Returns:
- the MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source object itself.
-
setSourceRetryCount
public MongoDbV2Source setSourceRetryCount(Object sourceRetryCount)
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
public MongoDbV2Source 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 classCopySource
- Parameters:
sourceRetryWait
- the sourceRetryWait value to set.- Returns:
- the CopySource object itself.
-
setMaxConcurrentConnections
public MongoDbV2Source 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 classCopySource
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySource object itself.
-
-