Class HttpDataset


  • public final class HttpDataset
    extends Dataset
    A file in an HTTP web server.
    • Constructor Detail

      • HttpDataset

        public HttpDataset()
    • Method Detail

      • withDescription

        public HttpDataset 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 HttpDataset 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 HttpDataset 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.
      • withLinkedServiceName

        public HttpDataset withLinkedServiceName​(LinkedServiceReference linkedServiceName)
        Set the linkedServiceName property: Linked service reference.
        Overrides:
        withLinkedServiceName in class Dataset
        Parameters:
        linkedServiceName - the linkedServiceName value to set.
        Returns:
        the Dataset object itself.
      • withAnnotations

        public HttpDataset 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 HttpDataset 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 based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
        Returns:
        the relativeUrl value.
      • withRelativeUrl

        public HttpDataset withRelativeUrl​(Object relativeUrl)
        Set the relativeUrl property: The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
        Parameters:
        relativeUrl - the relativeUrl value to set.
        Returns:
        the HttpDataset object itself.
      • requestMethod

        public Object requestMethod()
        Get the requestMethod property: The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
        Returns:
        the requestMethod value.
      • withRequestMethod

        public HttpDataset withRequestMethod​(Object requestMethod)
        Set the requestMethod property: The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
        Parameters:
        requestMethod - the requestMethod value to set.
        Returns:
        the HttpDataset object itself.
      • requestBody

        public Object requestBody()
        Get the requestBody property: The body for the HTTP request. Type: string (or Expression with resultType string).
        Returns:
        the requestBody value.
      • withRequestBody

        public HttpDataset withRequestBody​(Object requestBody)
        Set the requestBody property: The body for the HTTP request. Type: string (or Expression with resultType string).
        Parameters:
        requestBody - the requestBody value to set.
        Returns:
        the HttpDataset object itself.
      • additionalHeaders

        public Object additionalHeaders()
        Get the additionalHeaders property: The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
        Returns:
        the additionalHeaders value.
      • withAdditionalHeaders

        public HttpDataset withAdditionalHeaders​(Object additionalHeaders)
        Set the additionalHeaders property: The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
        Parameters:
        additionalHeaders - the additionalHeaders value to set.
        Returns:
        the HttpDataset object itself.
      • format

        public DatasetStorageFormat format()
        Get the format property: The format of files.
        Returns:
        the format value.
      • withFormat

        public HttpDataset withFormat​(DatasetStorageFormat format)
        Set the format property: The format of files.
        Parameters:
        format - the format value to set.
        Returns:
        the HttpDataset object itself.
      • compression

        public DatasetCompression compression()
        Get the compression property: The data compression method used on files.
        Returns:
        the compression value.
      • withCompression

        public HttpDataset withCompression​(DatasetCompression compression)
        Set the compression property: The data compression method used on files.
        Parameters:
        compression - the compression value to set.
        Returns:
        the HttpDataset object itself.