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

Class DatasetParameter

java.lang.Object

software.amazon.awssdk.services.databrew.model.DatasetParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DatasetParameter.Builder,DatasetParameter>

@Generated("software.amazon.awssdk:codegen")
public final class DatasetParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DatasetParameter.Builder,DatasetParameter>

Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetParameter.Builder

Method Summary

Modifier and Type	Method	Description
static DatasetParameter.Builder	builder()
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.
DatetimeOptions	datetimeOptions()	Additional parameter options such as a format and a timezone.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilterExpression	filter()	The optional filter expression structure to apply additional matching criteria to the parameter.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the parameter that is used in the dataset's Amazon S3 path.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DatasetParameter.Builder>	serializableBuilderClass()
DatasetParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterType	type()	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
String	typeAsString()	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

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

Returns:

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

type

public final ParameterType type()

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

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

ParameterType

typeAsString

public final String typeAsString()

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

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

ParameterType

datetimeOptions

public final DatetimeOptions datetimeOptions()

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

Returns:

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

createColumn

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

Returns:

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

filter

public final FilterExpression filter()

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

Returns:

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

toBuilder

public DatasetParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetParameter.Builder,DatasetParameter>

builder

public static DatasetParameter.Builder builder()

serializableBuilderClass

public static Class<? extends DatasetParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo