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