MongoDbAtlasCollectionDataset Class

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.

void validate()

Validates the instance.

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

Methods inherited from java.lang.Object

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.

validate

public void validate()

Validates the instance.

Overrides:

MongoDbAtlasCollectionDataset.validate()

withAnnotations

public MongoDbAtlasCollectionDataset withAnnotations(List 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 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

Applies to