Class CosmosDbMongoDbApiCollectionDataset
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.Dataset
-
- com.azure.analytics.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset
-
public class CosmosDbMongoDbApiCollectionDataset extends Dataset
The CosmosDB (MongoDB API) database dataset.
-
-
Constructor Summary
Constructors Constructor Description CosmosDbMongoDbApiCollectionDataset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getCollection()
Get the collection property: The collection name of the CosmosDB (MongoDB API) database.CosmosDbMongoDbApiCollectionDataset
setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the Dataset.CosmosDbMongoDbApiCollectionDataset
setCollection(Object collection)
Set the collection property: The collection name of the CosmosDB (MongoDB API) database.CosmosDbMongoDbApiCollectionDataset
setDescription(String description)
Set the description property: Dataset description.CosmosDbMongoDbApiCollectionDataset
setFolder(DatasetFolder folder)
Set the folder property: The folder that this Dataset is in.CosmosDbMongoDbApiCollectionDataset
setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.CosmosDbMongoDbApiCollectionDataset
setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for dataset.CosmosDbMongoDbApiCollectionDataset
setSchema(Object schema)
Set the schema property: Columns that define the physical type schema of the dataset.CosmosDbMongoDbApiCollectionDataset
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
-
-
-
-
Method Detail
-
getCollection
public Object getCollection()
Get the collection property: The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).- Returns:
- the collection value.
-
setCollection
public CosmosDbMongoDbApiCollectionDataset setCollection(Object collection)
Set the collection property: The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).- Parameters:
collection
- the collection value to set.- Returns:
- the CosmosDbMongoDbApiCollectionDataset object itself.
-
setDescription
public CosmosDbMongoDbApiCollectionDataset setDescription(String description)
Set the description property: Dataset description.- Overrides:
setDescription
in classDataset
- Parameters:
description
- the description value to set.- Returns:
- the Dataset object itself.
-
setStructure
public CosmosDbMongoDbApiCollectionDataset 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 classDataset
- Parameters:
structure
- the structure value to set.- Returns:
- the Dataset object itself.
-
setSchema
public CosmosDbMongoDbApiCollectionDataset 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.
-
setLinkedServiceName
public CosmosDbMongoDbApiCollectionDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.- Overrides:
setLinkedServiceName
in classDataset
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the Dataset object itself.
-
setParameters
public CosmosDbMongoDbApiCollectionDataset setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for dataset.- Overrides:
setParameters
in classDataset
- Parameters:
parameters
- the parameters value to set.- Returns:
- the Dataset object itself.
-
setAnnotations
public CosmosDbMongoDbApiCollectionDataset setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the Dataset.- Overrides:
setAnnotations
in classDataset
- Parameters:
annotations
- the annotations value to set.- Returns:
- the Dataset object itself.
-
setFolder
public CosmosDbMongoDbApiCollectionDataset setFolder(DatasetFolder folder)
Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
-
-