Class MongoDbV2Source
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.CopySource
-
- com.azure.resourcemanager.datafactory.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
additionalColumns()
Get the additionalColumns property: Specifies the additional columns to be added to source data.Object
batchSize()
Get the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.MongoDbCursorMethodsProperties
cursorMethods()
Get the cursorMethods property: Cursor methods for Mongodb query.Object
filter()
Get the filter property: Specifies selection filter using query operators.Object
queryTimeout()
Get the queryTimeout property: Query timeout.void
validate()
Validates the instance.MongoDbV2Source
withAdditionalColumns(Object additionalColumns)
Set the additionalColumns property: Specifies the additional columns to be added to source data.MongoDbV2Source
withBatchSize(Object batchSize)
Set the batchSize property: Specifies the number of documents to return in each batch of the response from MongoDB instance.MongoDbV2Source
withCursorMethods(MongoDbCursorMethodsProperties cursorMethods)
Set the cursorMethods property: Cursor methods for Mongodb query.MongoDbV2Source
withDisableMetricsCollection(Object disableMetricsCollection)
Set the disableMetricsCollection property: If true, disable data store metrics collection.MongoDbV2Source
withFilter(Object filter)
Set the filter property: Specifies selection filter using query operators.MongoDbV2Source
withMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.MongoDbV2Source
withQueryTimeout(Object queryTimeout)
Set the queryTimeout property: Query timeout.MongoDbV2Source
withSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count.MongoDbV2Source
withSourceRetryWait(Object sourceRetryWait)
Set the sourceRetryWait property: Source retry wait.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySource
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sourceRetryCount, sourceRetryWait, withAdditionalProperties
-
-
-
-
Method Detail
-
filter
public Object filter()
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.
-
withFilter
public MongoDbV2Source withFilter(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.
-
cursorMethods
public MongoDbCursorMethodsProperties cursorMethods()
Get the cursorMethods property: Cursor methods for Mongodb query.- Returns:
- the cursorMethods value.
-
withCursorMethods
public MongoDbV2Source withCursorMethods(MongoDbCursorMethodsProperties cursorMethods)
Set the cursorMethods property: Cursor methods for Mongodb query.- Parameters:
cursorMethods
- the cursorMethods value to set.- Returns:
- the MongoDbV2Source object itself.
-
batchSize
public Object batchSize()
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.
-
withBatchSize
public MongoDbV2Source withBatchSize(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.
-
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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source 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 MongoDbV2Source object itself.
-
withSourceRetryCount
public MongoDbV2Source withSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).- Overrides:
withSourceRetryCount
in classCopySource
- Parameters:
sourceRetryCount
- the sourceRetryCount value to set.- Returns:
- the CopySource object itself.
-
withSourceRetryWait
public MongoDbV2Source 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 classCopySource
- Parameters:
sourceRetryWait
- the sourceRetryWait value to set.- Returns:
- the CopySource object itself.
-
withMaxConcurrentConnections
public MongoDbV2Source 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 classCopySource
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySource object itself.
-
withDisableMetricsCollection
public MongoDbV2Source 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 classCopySource
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the CopySource object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classCopySource
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-