ReferenceInputProperties Class

public final class ReferenceInputProperties
extends InputProperties

The properties that are associated with an input containing reference data.

Constructor Summary

Constructor Description
ReferenceInputProperties()

Creates an instance of ReferenceInputProperties class.

Method Summary

Modifier and Type Method and Description
ReferenceInputDataSource datasource()

Get the datasource property: Describes an input data source that contains reference data.

static ReferenceInputProperties fromJson(JsonReader jsonReader)

Reads an instance of ReferenceInputProperties from the JsonReader.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Indicates whether the input is a source of reference data or stream data.

void validate()

Validates the instance.

ReferenceInputProperties withCompression(Compression compression)

Set the compression property: Describes how input data is compressed.

ReferenceInputProperties withDatasource(ReferenceInputDataSource datasource)

Set the datasource property: Describes an input data source that contains reference data.

ReferenceInputProperties withPartitionKey(String partitionKey)

Set the partitionKey property: partitionKey Describes a key in the input data which is used for partitioning the input data.

ReferenceInputProperties withSerialization(Serialization serialization)

Set the serialization property: Describes how data from an input is serialized or how data is serialized when written to an output.

Methods inherited from InputProperties

Methods inherited from java.lang.Object

Constructor Details

ReferenceInputProperties

public ReferenceInputProperties()

Creates an instance of ReferenceInputProperties class.

Method Details

datasource

public ReferenceInputDataSource datasource()

Get the datasource property: Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests.

Returns:

the datasource value.

fromJson

public static ReferenceInputProperties fromJson(JsonReader jsonReader)

Reads an instance of ReferenceInputProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ReferenceInputProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ReferenceInputProperties.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ReferenceInputProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

Overrides:

ReferenceInputProperties.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ReferenceInputProperties.validate()

withCompression

public ReferenceInputProperties withCompression(Compression compression)

Set the compression property: Describes how input data is compressed.

Overrides:

ReferenceInputProperties.withCompression(Compression compression)

Parameters:

compression

withDatasource

public ReferenceInputProperties withDatasource(ReferenceInputDataSource datasource)

Set the datasource property: Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests.

Parameters:

datasource - the datasource value to set.

Returns:

the ReferenceInputProperties object itself.

withPartitionKey

public ReferenceInputProperties withPartitionKey(String partitionKey)

Set the partitionKey property: partitionKey Describes a key in the input data which is used for partitioning the input data.

Overrides:

ReferenceInputProperties.withPartitionKey(String partitionKey)

Parameters:

partitionKey

withSerialization

public ReferenceInputProperties withSerialization(Serialization serialization)

Set the serialization property: Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.

Overrides:

ReferenceInputProperties.withSerialization(Serialization serialization)

Parameters:

serialization

Applies to