Package com.azure.analytics.synapse.artifacts.models

Class MongoDbAtlasCollectionDataset

java.lang.Object

com.azure.analytics.synapse.artifacts.models.Dataset

com.azure.analytics.synapse.artifacts.models.MongoDbAtlasCollectionDataset

public class MongoDbAtlasCollectionDataset
extends Dataset

The MongoDB Atlas database dataset.

Constructor Summary

Constructors

Constructor	Description
MongoDbAtlasCollectionDataset()

Method Summary

Modifier and Type	Method	Description
Object	getCollection()	Get the collection property: The collection name of the MongoDB Atlas database.
MongoDbAtlasCollectionDataset	setAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the Dataset.
MongoDbAtlasCollectionDataset	setCollection(Object collection)	Set the collection property: The collection name of the MongoDB Atlas database.
MongoDbAtlasCollectionDataset	setDescription(String description)	Set the description property: Dataset description.
MongoDbAtlasCollectionDataset	setFolder(DatasetFolder folder)	Set the folder property: The folder that this Dataset is in.
MongoDbAtlasCollectionDataset	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
MongoDbAtlasCollectionDataset	setParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for dataset.
MongoDbAtlasCollectionDataset	setSchema(Object schema)	Set the schema property: Columns that define the physical type schema of the dataset.
MongoDbAtlasCollectionDataset	setStructure(Object structure)	Set the structure property: Columns that define the structure of the dataset.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.Dataset

getAdditionalProperties, getAnnotations, getDescription, getFolder, getLinkedServiceName, getParameters, getSchema, getStructure, setAdditionalProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDbAtlasCollectionDataset

public MongoDbAtlasCollectionDataset()

Method Detail

getCollection

public Object getCollection()

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

Returns:

the collection value.

setCollection

public MongoDbAtlasCollectionDataset setCollection(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.

setDescription

public MongoDbAtlasCollectionDataset setDescription(String description)

Set the description property: Dataset description.

Overrides:

setDescription in class Dataset

Parameters:

description - the description value to set.

Returns:

the Dataset object itself.

setStructure

public MongoDbAtlasCollectionDataset setStructure(Object structure)

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

Overrides:

setStructure in class Dataset

Parameters:

structure - the structure value to set.

Returns:

the Dataset object itself.

setSchema

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

setSchema in class Dataset

Parameters:

schema - the schema value to set.

Returns:

the Dataset object itself.

setLinkedServiceName

public MongoDbAtlasCollectionDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

setLinkedServiceName in class Dataset

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the Dataset object itself.

setParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

setParameters in class Dataset

Parameters:

parameters - the parameters value to set.

Returns:

the Dataset object itself.

setAnnotations

public MongoDbAtlasCollectionDataset setAnnotations(List<Object> annotations)

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

Overrides:

setAnnotations in class Dataset

Parameters:

annotations - the annotations value to set.

Returns:

the Dataset object itself.

setFolder

public MongoDbAtlasCollectionDataset setFolder(DatasetFolder folder)

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

Overrides:

setFolder in class Dataset

Parameters:

folder - the folder value to set.

Returns:

the Dataset object itself.