Package software.amazon.awssdk.services.databrew.model

Interface DatasetParameter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DatasetParameter.Builder,DatasetParameter>, SdkBuilder<DatasetParameter.Builder,DatasetParameter>, SdkPojo

Enclosing class:

DatasetParameter

public static interface DatasetParameter.Builder
extends SdkPojo, CopyableBuilder<DatasetParameter.Builder,DatasetParameter>

Method Summary

Modifier and Type	Method	Description
DatasetParameter.Builder	createColumn(Boolean createColumn)	Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
default DatasetParameter.Builder	datetimeOptions(Consumer<DatetimeOptions.Builder> datetimeOptions)	Additional parameter options such as a format and a timezone.
DatasetParameter.Builder	datetimeOptions(DatetimeOptions datetimeOptions)	Additional parameter options such as a format and a timezone.
default DatasetParameter.Builder	filter(Consumer<FilterExpression.Builder> filter)	The optional filter expression structure to apply additional matching criteria to the parameter.
DatasetParameter.Builder	filter(FilterExpression filter)	The optional filter expression structure to apply additional matching criteria to the parameter.
DatasetParameter.Builder	name(String name)	The name of the parameter that is used in the dataset's Amazon S3 path.
DatasetParameter.Builder	type(String type)	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
DatasetParameter.Builder	type(ParameterType type)	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

name

DatasetParameter.Builder name(String name)

The name of the parameter that is used in the dataset's Amazon S3 path.

Parameters:

name - The name of the parameter that is used in the dataset's Amazon S3 path.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

DatasetParameter.Builder type(String type)

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Parameters:

type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

type

DatasetParameter.Builder type(ParameterType type)

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Parameters:

type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

datetimeOptions

DatasetParameter.Builder datetimeOptions(DatetimeOptions datetimeOptions)

Additional parameter options such as a format and a timezone. Required for datetime parameters.

Parameters:

datetimeOptions - Additional parameter options such as a format and a timezone. Required for datetime parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

datetimeOptions

default DatasetParameter.Builder datetimeOptions(Consumer<DatetimeOptions.Builder> datetimeOptions)

Additional parameter options such as a format and a timezone. Required for datetime parameters.

This is a convenience method that creates an instance of the DatetimeOptions.Builder avoiding the need to create one manually via DatetimeOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datetimeOptions(DatetimeOptions).

Parameters:

datetimeOptions - a consumer that will call methods on DatetimeOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

datetimeOptions(DatetimeOptions)

createColumn

DatasetParameter.Builder createColumn(Boolean createColumn)

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

Parameters:

createColumn - Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

DatasetParameter.Builder filter(FilterExpression filter)

The optional filter expression structure to apply additional matching criteria to the parameter.

Parameters:

filter - The optional filter expression structure to apply additional matching criteria to the parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default DatasetParameter.Builder filter(Consumer<FilterExpression.Builder> filter)

The optional filter expression structure to apply additional matching criteria to the parameter.

This is a convenience method that creates an instance of the FilterExpression.Builder avoiding the need to create one manually via FilterExpression.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(FilterExpression).

Parameters:

filter - a consumer that will call methods on FilterExpression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(FilterExpression)