HttpDataset Class

public final class HttpDataset
extends Dataset

A file in an HTTP web server.

Constructor Summary

Constructor Description
HttpDataset()

Creates an instance of HttpDataset class.

Method Summary

Modifier and Type Method and Description
Object additionalHeaders()

Get the additionalHeaders property: The headers for the HTTP Request.

DatasetCompression compression()

Get the compression property: The data compression method used on files.

DatasetStorageFormat format()

Get the format property: The format of files.

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).

Object requestBody()

Get the requestBody property: The body for the HTTP request.

Object requestMethod()

Get the requestMethod property: The HTTP method for the HTTP request.

String type()

Get the type property: Type of dataset.

void validate()

Validates the instance.

HttpDataset withAdditionalHeaders(Object additionalHeaders)

Set the additionalHeaders property: The headers for the HTTP Request.

HttpDataset withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

HttpDataset withCompression(DatasetCompression compression)

Set the compression property: The data compression method used on files.

HttpDataset withDescription(String description)

Set the description property: Dataset description.

HttpDataset withFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in.

HttpDataset withFormat(DatasetStorageFormat format)

Set the format property: The format of files.

HttpDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

HttpDataset withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

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).

HttpDataset withRequestBody(Object requestBody)

Set the requestBody property: The body for the HTTP request.

HttpDataset withRequestMethod(Object requestMethod)

Set the requestMethod property: The HTTP method for the HTTP request.

HttpDataset withSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset.

HttpDataset withStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset.

Methods inherited from Dataset

Methods inherited from java.lang.Object

Constructor Details

HttpDataset

public HttpDataset()

Creates an instance of HttpDataset class.

Method Details

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.

compression

public DatasetCompression compression()

Get the compression property: The data compression method used on files.

Returns:

the compression value.

format

public DatasetStorageFormat format()

Get the format property: The format of files.

Returns:

the format value.

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.

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.

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.

type

public String type()

Get the type property: Type of dataset.

Overrides:

HttpDataset.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

HttpDataset.validate()

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.

withAnnotations

public HttpDataset withAnnotations(List annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Overrides:

HttpDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

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.

withDescription

public HttpDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

HttpDataset.withDescription(String description)

Parameters:

description

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:

HttpDataset.withFolder(DatasetFolder folder)

Parameters:

folder

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.

withLinkedServiceName

public HttpDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

HttpDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withParameters

public HttpDataset withParameters(Map parameters)

Set the parameters property: Parameters for dataset.

Overrides:

HttpDataset.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

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.

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.

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.

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:

HttpDataset.withSchema(Object schema)

Parameters:

schema

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:

HttpDataset.withStructure(Object structure)

Parameters:

structure

Applies to