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

Class RestResourceDataset

java.lang.Object
com.azure.analytics.synapse.artifacts.models.Dataset
com.azure.analytics.synapse.artifacts.models.RestResourceDataset
public class RestResourceDataset extends Dataset
A Rest service dataset.

  • Constructor Details

    • RestResourceDataset

      public RestResourceDataset()

  • Method Details

    • getRelativeUrl

      public Object getRelativeUrl()
      Get the relativeUrl property: The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
      Returns:
      the relativeUrl value.

    • setRelativeUrl

      public RestResourceDataset setRelativeUrl(Object relativeUrl)
      Set the relativeUrl property: The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
      Parameters:
      relativeUrl - the relativeUrl value to set.
      Returns:
      the RestResourceDataset object itself.

    • getRequestMethod

      public Object getRequestMethod()
      Get the requestMethod property: The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
      Returns:
      the requestMethod value.

    • setRequestMethod

      public RestResourceDataset setRequestMethod(Object requestMethod)
      Set the requestMethod property: The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
      Parameters:
      requestMethod - the requestMethod value to set.
      Returns:
      the RestResourceDataset object itself.

    • getRequestBody

      public Object getRequestBody()
      Get the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
      Returns:
      the requestBody value.

    • setRequestBody

      public RestResourceDataset setRequestBody(Object requestBody)
      Set the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
      Parameters:
      requestBody - the requestBody value to set.
      Returns:
      the RestResourceDataset object itself.

    • getAdditionalHeaders

      public Object getAdditionalHeaders()
      Get the additionalHeaders property: The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
      Returns:
      the additionalHeaders value.

    • setAdditionalHeaders

      public RestResourceDataset setAdditionalHeaders(Object additionalHeaders)
      Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
      Parameters:
      additionalHeaders - the additionalHeaders value to set.
      Returns:
      the RestResourceDataset object itself.

    • getPaginationRules

      public Object getPaginationRules()
      Get the paginationRules property: The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
      Returns:
      the paginationRules value.

    • setPaginationRules

      public RestResourceDataset setPaginationRules(Object paginationRules)
      Set the paginationRules property: The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
      Parameters:
      paginationRules - the paginationRules value to set.
      Returns:
      the RestResourceDataset object itself.

    • setDescription

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