Package software.amazon.awssdk.services.forecast.model

Class SchemaAttribute

java.lang.Object

software.amazon.awssdk.services.forecast.model.SchemaAttribute

All Implemented Interfaces:

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

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

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The Schema object contains an array of SchemaAttribute objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchemaAttribute.Builder

Method Summary

Modifier and Type	Method	Description
String	attributeName()	The name of the dataset field.
AttributeType	attributeType()	The data type of the field.
String	attributeTypeAsString()	The data type of the field.
static SchemaAttribute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SchemaAttribute.Builder>	serializableBuilderClass()
SchemaAttribute.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

attributeName

public final String attributeName()

The name of the dataset field.

Returns:

The name of the dataset field.

attributeType

public final AttributeType attributeType()

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

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

Returns:

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

See Also:

AttributeType

attributeTypeAsString

public final String attributeTypeAsString()

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

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

Returns:

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

See Also:

AttributeType

toBuilder

public SchemaAttribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SchemaAttribute.Builder,SchemaAttribute>

builder

public static SchemaAttribute.Builder builder()

serializableBuilderClass

public static Class<? extends SchemaAttribute.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