Package com.azure.resourcemanager.datafactory.models

Class CosmosDbMongoDbApiCollectionDataset

java.lang.Object

com.azure.resourcemanager.datafactory.models.Dataset

com.azure.resourcemanager.datafactory.models.CosmosDbMongoDbApiCollectionDataset

public final class CosmosDbMongoDbApiCollectionDataset
extends Dataset

The CosmosDB (MongoDB API) database dataset.

Constructor Summary

Constructors

Constructor	Description
CosmosDbMongoDbApiCollectionDataset()

Method Summary

Modifier and Type	Method	Description
Object	collection()	Get the collection property: The collection name of the CosmosDB (MongoDB API) database.
void	validate()	Validates the instance.
CosmosDbMongoDbApiCollectionDataset	withAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the Dataset.
CosmosDbMongoDbApiCollectionDataset	withCollection(Object collection)	Set the collection property: The collection name of the CosmosDB (MongoDB API) database.
CosmosDbMongoDbApiCollectionDataset	withDescription(String description)	Set the description property: Dataset description.
CosmosDbMongoDbApiCollectionDataset	withFolder(DatasetFolder folder)	Set the folder property: The folder that this Dataset is in.
CosmosDbMongoDbApiCollectionDataset	withLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
CosmosDbMongoDbApiCollectionDataset	withParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for dataset.
CosmosDbMongoDbApiCollectionDataset	withSchema(Object schema)	Set the schema property: Columns that define the physical type schema of the dataset.
CosmosDbMongoDbApiCollectionDataset	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

CosmosDbMongoDbApiCollectionDataset

public CosmosDbMongoDbApiCollectionDataset()

Method Detail

withDescription

public CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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 CosmosDbMongoDbApiCollectionDataset 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.

collection

public Object collection()

Get the collection property: The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

Returns:

the collection value.

withCollection

public CosmosDbMongoDbApiCollectionDataset withCollection(Object collection)

Set the collection property: The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

Parameters:

collection - the collection value to set.

Returns:

the CosmosDbMongoDbApiCollectionDataset object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class Dataset

Throws:

IllegalArgumentException - thrown if the instance is not valid.