Package software.amazon.awssdk.services.quicksight.model

Class DateDimensionField

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DateDimensionField

All Implemented Interfaces:

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

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

The dimension type field with date type columns.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DateDimensionField.Builder

Method Summary

Modifier and Type	Method	Description
static DateDimensionField.Builder	builder()
ColumnIdentifier	column()	The column that is used in the DateDimensionField.
TimeGranularity	dateGranularity()	The date granularity of the DateDimensionField.
String	dateGranularityAsString()	The date granularity of the DateDimensionField.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldId()	The custom field ID.
DateTimeFormatConfiguration	formatConfiguration()	The format configuration of the field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hierarchyId()	The custom hierarchy ID.
List<SdkField<?>>	sdkFields()
static Class<? extends DateDimensionField.Builder>	serializableBuilderClass()
DateDimensionField.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

fieldId

public final String fieldId()

The custom field ID.

Returns:

The custom field ID.

column

public final ColumnIdentifier column()

The column that is used in the DateDimensionField.

Returns:

The column that is used in the DateDimensionField.

dateGranularity

public final TimeGranularity dateGranularity()

The date granularity of the DateDimensionField. Choose one of the following options:

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

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

Returns:

The date granularity of the DateDimensionField. Choose one of the following options:

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

See Also:

TimeGranularity

dateGranularityAsString

public final String dateGranularityAsString()

The date granularity of the DateDimensionField. Choose one of the following options:

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

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

Returns:

The date granularity of the DateDimensionField. Choose one of the following options:

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

See Also:

TimeGranularity

hierarchyId

public final String hierarchyId()

The custom hierarchy ID.

Returns:

The custom hierarchy ID.

formatConfiguration

public final DateTimeFormatConfiguration formatConfiguration()

The format configuration of the field.

Returns:

The format configuration of the field.

toBuilder

public DateDimensionField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DateDimensionField.Builder,DateDimensionField>

builder

public static DateDimensionField.Builder builder()

serializableBuilderClass

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