DocumentDbCollectionDataset Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.3.0-beta.1

• 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

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

Method Summary

Modifier and Type	Method and Description
Object	collectionName() Get the collectionName property: Document Database collection name.
static DocumentDbCollectionDataset	fromJson(JsonReader jsonReader) Reads an instance of DocumentDbCollectionDataset from the JsonReader.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of dataset.
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 Dataset

additionalProperties annotations description folder fromJson linkedServiceName parameters schema structure toJson type withAdditionalProperties withAnnotations withDescription withFolder withLinkedServiceName withParameters withSchema withStructure

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentDbCollectionDataset

public DocumentDbCollectionDataset()

Creates an instance of DocumentDbCollectionDataset class.

Method Details

collectionName

public Object collectionName()

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

Returns:

the collectionName value.

fromJson

public static DocumentDbCollectionDataset fromJson(JsonReader jsonReader)

Reads an instance of DocumentDbCollectionDataset from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentDbCollectionDataset.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of dataset.

Overrides:

DocumentDbCollectionDataset.type()

Returns:

the type value.

withAnnotations

public DocumentDbCollectionDataset withAnnotations(List<Object> annotations)

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

Overrides:

DocumentDbCollectionDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

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.

withDescription

public DocumentDbCollectionDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

DocumentDbCollectionDataset.withDescription(String description)

Parameters:

description

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:

DocumentDbCollectionDataset.withFolder(DatasetFolder folder)

Parameters:

folder

withLinkedServiceName

public DocumentDbCollectionDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

DocumentDbCollectionDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

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

Parameters:

parameters

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:

DocumentDbCollectionDataset.withSchema(Object schema)

Parameters:

schema

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:

DocumentDbCollectionDataset.withStructure(Object structure)

Parameters:

structure