Package com.azure.resourcemanager.datafactory.models

Class DocumentDbCollectionDataset

java.lang.Object

com.azure.resourcemanager.datafactory.models.Dataset

com.azure.resourcemanager.datafactory.models.DocumentDbCollectionDataset

public final class DocumentDbCollectionDataset
extends Dataset

Microsoft Azure Document Database Collection dataset.

Constructor Summary

Constructors

Constructor	Description
DocumentDbCollectionDataset()

Method Summary

Modifier and Type	Method	Description
Object	collectionName()	Get the collectionName property: Document Database collection name.
void	validate()	Validates the instance.
DocumentDbCollectionDataset	withAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the Dataset.
DocumentDbCollectionDataset	withCollectionName(Object collectionName)	Set the collectionName property: Document Database collection name.
DocumentDbCollectionDataset	withDescription(String description)	Set the description property: Dataset description.
DocumentDbCollectionDataset	withFolder(DatasetFolder folder)	Set the folder property: The folder that this Dataset is in.
DocumentDbCollectionDataset	withLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
DocumentDbCollectionDataset	withParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for dataset.
DocumentDbCollectionDataset	withSchema(Object schema)	Set the schema property: Columns that define the physical type schema of the dataset.
DocumentDbCollectionDataset	withStructure(Object structure)	Set the structure property: Columns that define the structure of the dataset.

Methods inherited from class com.azure.resourcemanager.datafactory.models.Dataset

additionalProperties, annotations, description, folder, linkedServiceName, parameters, schema, structure, withAdditionalProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentDbCollectionDataset

public DocumentDbCollectionDataset()

Method Detail

withDescription

public DocumentDbCollectionDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

withDescription in class Dataset

Parameters:

description - the description value to set.

Returns:

the Dataset object itself.

withStructure

public DocumentDbCollectionDataset withStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Overrides:

withStructure in class Dataset

Parameters:

structure - the structure value to set.

Returns:

the Dataset object itself.

withSchema

public DocumentDbCollectionDataset withSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Overrides:

withSchema in class Dataset

Parameters:

schema - the schema value to set.

Returns:

the Dataset object itself.

withLinkedServiceName

public DocumentDbCollectionDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

withLinkedServiceName in class Dataset

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the Dataset object itself.

withParameters

public DocumentDbCollectionDataset withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

Overrides:

withParameters in class Dataset

Parameters:

parameters - the parameters value to set.

Returns:

the Dataset object itself.

withAnnotations

public DocumentDbCollectionDataset withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Overrides:

withAnnotations in class Dataset

Parameters:

annotations - the annotations value to set.

Returns:

the Dataset object itself.

withFolder

public DocumentDbCollectionDataset withFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Overrides:

withFolder in class Dataset

Parameters:

folder - the folder value to set.

Returns:

the Dataset object itself.

collectionName

public Object collectionName()

Get the collectionName property: Document Database collection name. Type: string (or Expression with resultType string).

Returns:

the collectionName value.

withCollectionName

public DocumentDbCollectionDataset withCollectionName(Object collectionName)

Set the collectionName property: Document Database collection name. Type: string (or Expression with resultType string).

Parameters:

collectionName - the collectionName value to set.

Returns:

the DocumentDbCollectionDataset object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class Dataset

Throws:

IllegalArgumentException - thrown if the instance is not valid.