MongoDbV2Source Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• 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

Constructor	Description
MongoDbV2Source()	Creates an instance of MongoDbV2Source class.

Method Summary

Modifier and Type	Method and 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 CopySource

getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait setAdditionalProperties setMaxConcurrentConnections setSourceRetryCount setSourceRetryWait

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MongoDbV2Source

public MongoDbV2Source()

Creates an instance of MongoDbV2Source class.

Method Details

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.

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.

getCursorMethods

public MongoDbCursorMethodsProperties getCursorMethods()

Get the cursorMethods property: Cursor methods for Mongodb query.

Returns:

the cursorMethods value.

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.

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.

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.

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.

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.

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.

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:

MongoDbV2Source.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

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.

setSourceRetryCount

public MongoDbV2Source setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

MongoDbV2Source.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

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:

MongoDbV2Source.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait