DocumentDbCollectionSource Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

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
Object additionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data.
static DocumentDbCollectionSource fromJson(JsonReader jsonReader)

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

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

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

Get the queryTimeout property: Query timeout.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.
void validate()

Validates the instance.
DocumentDbCollectionSource withAdditionalColumns(Object additionalColumns)

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

Set the disableMetricsCollection property: If true, disable data store metrics collection.
DocumentDbCollectionSource withMaxConcurrentConnections(Object maxConcurrentConnections)

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

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

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

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

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

Set the sourceRetryWait property: Source retry wait.

Methods inherited from CopySource

additionalProperties disableMetricsCollection fromJson maxConcurrentConnections sourceRetryCount sourceRetryWait toJson type validate withAdditionalProperties withDisableMetricsCollection withMaxConcurrentConnections withSourceRetryCount withSourceRetryWait

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

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.

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.

nestingSeparator

public Object nestingSeparator()

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

Returns:

the nestingSeparator value.

query

public Object query()

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

Returns:

the query value.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentDbCollectionSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

DocumentDbCollectionSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

DocumentDbCollectionSource.validate()

withAdditionalColumns

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

withDisableMetricsCollection

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

DocumentDbCollectionSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

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

DocumentDbCollectionSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withNestingSeparator

public DocumentDbCollectionSource withNestingSeparator(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.

withQuery

public DocumentDbCollectionSource withQuery(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.

withQueryTimeout

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

withSourceRetryCount

public DocumentDbCollectionSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

DocumentDbCollectionSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

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

DocumentDbCollectionSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

Applies to