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

Class HttpDataset

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

    • Constructor Detail

      • HttpDataset

        public HttpDataset()

    • Method Detail

      • getRelativeUrl

        public Object getRelativeUrl()
        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.

      • setRelativeUrl

        public HttpDataset setRelativeUrl​(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.

      • getRequestMethod

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

      • setRequestMethod

        public HttpDataset setRequestMethod​(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.

      • getRequestBody

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

      • setRequestBody

        public HttpDataset setRequestBody​(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.

      • getAdditionalHeaders

        public Object getAdditionalHeaders()
        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.

      • setAdditionalHeaders

        public HttpDataset setAdditionalHeaders​(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.

      • getFormat

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

      • setFormat

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

      • getCompression

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

      • setCompression

        public HttpDataset setCompression​(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.

      • setDescription

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

      • setAnnotations

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