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

Class MongoDbCollectionDataset

java.lang.Object

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

com.azure.analytics.synapse.artifacts.models.MongoDbCollectionDataset

public class MongoDbCollectionDataset
extends Dataset

The MongoDB database dataset.

Constructor Summary

Constructors

Constructor	Description
MongoDbCollectionDataset()

Method Summary

Modifier and Type	Method	Description
Object	getCollectionName()	Get the collectionName property: The table name of the MongoDB database.
MongoDbCollectionDataset	setAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the Dataset.
MongoDbCollectionDataset	setCollectionName(Object collectionName)	Set the collectionName property: The table name of the MongoDB database.
MongoDbCollectionDataset	setDescription(String description)	Set the description property: Dataset description.
MongoDbCollectionDataset	setFolder(DatasetFolder folder)	Set the folder property: The folder that this Dataset is in.
MongoDbCollectionDataset	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
MongoDbCollectionDataset	setParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for dataset.
MongoDbCollectionDataset	setSchema(Object schema)	Set the schema property: Columns that define the physical type schema of the dataset.
MongoDbCollectionDataset	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

MongoDbCollectionDataset

public MongoDbCollectionDataset()

Method Detail

getCollectionName

public Object getCollectionName()

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

Returns:

the collectionName value.

setCollectionName

public MongoDbCollectionDataset setCollectionName(Object collectionName)

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

Parameters:

collectionName - the collectionName value to set.

Returns:

the MongoDbCollectionDataset object itself.

setDescription

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