DocumentDbCollectionSource Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public final class DocumentDbCollectionSource
extends CopySource

A copy activity Document Database Collection source.

Constructor Summary

Constructor Description
DocumentDbCollectionSource()

Creates an instance of DocumentDbCollectionSource class.

Method Summary

Modifier and Type Method and Description
static DocumentDbCollectionSource fromJson(JsonReader jsonReader)

Reads an instance of DocumentDbCollectionSource from the JsonReader.
Object getAdditionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data.
Object getNestingSeparator()

Get the nestingSeparator property: Nested properties separator.
Object getQuery()

Get the query property: Documents query.
Object getQueryTimeout()

Get the queryTimeout property: Query timeout.
String getType()

Get the type property: Copy source type.
DocumentDbCollectionSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.
DocumentDbCollectionSource setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
DocumentDbCollectionSource setNestingSeparator(Object nestingSeparator)

Set the nestingSeparator property: Nested properties separator.
DocumentDbCollectionSource setQuery(Object query)

Set the query property: Documents query.
DocumentDbCollectionSource setQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.
DocumentDbCollectionSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.
DocumentDbCollectionSource setSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from CopySource

fromJson getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait getType setAdditionalProperties setMaxConcurrentConnections setSourceRetryCount setSourceRetryWait toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentDbCollectionSource

public DocumentDbCollectionSource()

Creates an instance of DocumentDbCollectionSource class.

Method Details

fromJson

public static DocumentDbCollectionSource fromJson(JsonReader jsonReader)

Reads an instance of DocumentDbCollectionSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentDbCollectionSource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the DocumentDbCollectionSource.

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.

getNestingSeparator

public Object getNestingSeparator()

Get the nestingSeparator property: Nested properties separator. Type: string (or Expression with resultType string).

Returns:

the nestingSeparator value.

getQuery

public Object getQuery()

Get the query property: Documents query. Type: string (or Expression with resultType string).

Returns:

the query 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.

getType

public String getType()

Get the type property: Copy source type.

Overrides:

DocumentDbCollectionSource.getType()

Returns:

the type value.

setAdditionalColumns

public DocumentDbCollectionSource 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 DocumentDbCollectionSource object itself.

setMaxConcurrentConnections

public DocumentDbCollectionSource 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:

DocumentDbCollectionSource.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setNestingSeparator

public DocumentDbCollectionSource setNestingSeparator(Object nestingSeparator)

Set the nestingSeparator property: Nested properties separator. Type: string (or Expression with resultType string).

Parameters:

nestingSeparator - the nestingSeparator value to set.

Returns:

the DocumentDbCollectionSource object itself.

setQuery

public DocumentDbCollectionSource setQuery(Object query)

Set the query property: Documents query. Type: string (or Expression with resultType string).

Parameters:

query - the query value to set.

Returns:

the DocumentDbCollectionSource object itself.

setQueryTimeout

public DocumentDbCollectionSource 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 DocumentDbCollectionSource object itself.

setSourceRetryCount

public DocumentDbCollectionSource setSourceRetryCount(Object sourceRetryCount)

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

Overrides:

DocumentDbCollectionSource.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

setSourceRetryWait

public DocumentDbCollectionSource 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:

DocumentDbCollectionSource.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentDbCollectionSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to