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 Details

    • CosmosDbSqlApiCollectionDataset

      public CosmosDbSqlApiCollectionDataset()
  • Method Details

    • 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 class Dataset
      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 class Dataset
      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.
      Overrides:
      setSchema in class Dataset
      Parameters:
      schema - the schema value to set.
      Returns:
      the Dataset object itself.
    • setLinkedServiceName

      public CosmosDbSqlApiCollectionDataset 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

      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 CosmosDbSqlApiCollectionDataset 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

      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.