MongoDbAtlasCollectionDataset 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.MongoDbAtlasCollectionDataset

public final class MongoDbAtlasCollectionDataset
extends Dataset

The MongoDB Atlas database dataset.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Object	collection() Get the collection property: The collection name of the MongoDB Atlas database.
static MongoDbAtlasCollectionDataset	fromJson(JsonReader jsonReader) Reads an instance of MongoDbAtlasCollectionDataset from the JsonReader.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of dataset.
MongoDbAtlasCollectionDataset	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.
MongoDbAtlasCollectionDataset	withCollection(Object collection) Set the collection property: The collection name of the MongoDB Atlas database.
MongoDbAtlasCollectionDataset	withDescription(String description) Set the description property: Dataset description.
MongoDbAtlasCollectionDataset	withFolder(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.
MongoDbAtlasCollectionDataset	withLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
MongoDbAtlasCollectionDataset	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.
MongoDbAtlasCollectionDataset	withSchema(Object schema) Set the schema property: Columns that define the physical type schema of the dataset.
MongoDbAtlasCollectionDataset	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

MongoDbAtlasCollectionDataset

public MongoDbAtlasCollectionDataset()

Creates an instance of MongoDbAtlasCollectionDataset class.

Method Details

collection

public Object collection()

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

Returns:

the collection value.

fromJson

public static MongoDbAtlasCollectionDataset fromJson(JsonReader jsonReader)

Reads an instance of MongoDbAtlasCollectionDataset from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MongoDbAtlasCollectionDataset 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:

MongoDbAtlasCollectionDataset.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of dataset.

Overrides:

MongoDbAtlasCollectionDataset.type()

Returns:

the type value.

withAnnotations

public MongoDbAtlasCollectionDataset withAnnotations(List<Object> annotations)

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

Overrides:

MongoDbAtlasCollectionDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

withCollection

public MongoDbAtlasCollectionDataset withCollection(Object collection)

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

Parameters:

collection - the collection value to set.

Returns:

the MongoDbAtlasCollectionDataset object itself.

withDescription

public MongoDbAtlasCollectionDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

MongoDbAtlasCollectionDataset.withDescription(String description)

Parameters:

description

withFolder

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

MongoDbAtlasCollectionDataset.withFolder(DatasetFolder folder)

Parameters:

folder

withLinkedServiceName

public MongoDbAtlasCollectionDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

MongoDbAtlasCollectionDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

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

Parameters:

parameters

withSchema

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

MongoDbAtlasCollectionDataset.withSchema(Object schema)

Parameters:

schema

withStructure

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

MongoDbAtlasCollectionDataset.withStructure(Object structure)

Parameters:

structure