Class RestResourceDataset


  • public final class RestResourceDataset
    extends Dataset
    A Rest service dataset.
    • Constructor Detail

      • RestResourceDataset

        public RestResourceDataset()
    • Method Detail

      • withDescription

        public RestResourceDataset withDescription​(String description)
        Set the description property: Dataset description.
        Overrides:
        withDescription in class Dataset
        Parameters:
        description - the description value to set.
        Returns:
        the Dataset object itself.
      • withStructure

        public RestResourceDataset 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:
        withStructure in class Dataset
        Parameters:
        structure - the structure value to set.
        Returns:
        the Dataset object itself.
      • withSchema

        public RestResourceDataset 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:
        withSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.
      • withAnnotations

        public RestResourceDataset withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the Dataset.
        Overrides:
        withAnnotations in class Dataset
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Dataset object itself.
      • withFolder

        public RestResourceDataset 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:
        withFolder in class Dataset
        Parameters:
        folder - the folder value to set.
        Returns:
        the Dataset object itself.
      • relativeUrl

        public Object relativeUrl()
        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.
      • withRelativeUrl

        public RestResourceDataset withRelativeUrl​(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.
      • requestMethod

        public Object requestMethod()
        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.
      • withRequestMethod

        public RestResourceDataset withRequestMethod​(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.
      • requestBody

        public Object requestBody()
        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.
      • withRequestBody

        public RestResourceDataset withRequestBody​(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.
      • additionalHeaders

        public Object additionalHeaders()
        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.
      • withAdditionalHeaders

        public RestResourceDataset withAdditionalHeaders​(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.
      • paginationRules

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

        public RestResourceDataset withPaginationRules​(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.