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

Interface DateDimensionField.Builder

All Superinterfaces:

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

Enclosing class:

DateDimensionField

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

Method Summary

Modifier and Type	Method	Description
default DateDimensionField.Builder	column(Consumer<ColumnIdentifier.Builder> column)	The column that is used in the DateDimensionField.
DateDimensionField.Builder	column(ColumnIdentifier column)	The column that is used in the DateDimensionField.
DateDimensionField.Builder	dateGranularity(String dateGranularity)	The date granularity of the DateDimensionField.
DateDimensionField.Builder	dateGranularity(TimeGranularity dateGranularity)	The date granularity of the DateDimensionField.
DateDimensionField.Builder	fieldId(String fieldId)	The custom field ID.
default DateDimensionField.Builder	formatConfiguration(Consumer<DateTimeFormatConfiguration.Builder> formatConfiguration)	The format configuration of the field.
DateDimensionField.Builder	formatConfiguration(DateTimeFormatConfiguration formatConfiguration)	The format configuration of the field.
DateDimensionField.Builder	hierarchyId(String hierarchyId)	The custom hierarchy ID.

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, sdkFields

Method Details

fieldId

DateDimensionField.Builder fieldId(String fieldId)

The custom field ID.

Parameters:

fieldId - The custom field ID.

Returns:

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

column

DateDimensionField.Builder column(ColumnIdentifier column)

The column that is used in the DateDimensionField.

Parameters:

column - The column that is used in the DateDimensionField.

Returns:

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

column

default DateDimensionField.Builder column(Consumer<ColumnIdentifier.Builder> column)

The column that is used in the DateDimensionField.

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

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

Parameters:

column - a consumer that will call methods on ColumnIdentifier.Builder

Returns:

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

See Also:

• column(ColumnIdentifier)

dateGranularity

DateDimensionField.Builder dateGranularity(String dateGranularity)

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

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

Parameters:

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

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

Returns:

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

See Also:

• TimeGranularity
• TimeGranularity

dateGranularity

DateDimensionField.Builder dateGranularity(TimeGranularity dateGranularity)

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

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

Parameters:

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

• YEAR

• QUARTER

• MONTH

• WEEK

• DAY

• HOUR

• MINUTE

• SECOND

• MILLISECOND

Returns:

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

See Also:

• TimeGranularity
• TimeGranularity

hierarchyId

DateDimensionField.Builder hierarchyId(String hierarchyId)

The custom hierarchy ID.

Parameters:

hierarchyId - The custom hierarchy ID.

Returns:

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

formatConfiguration

DateDimensionField.Builder formatConfiguration(DateTimeFormatConfiguration formatConfiguration)

The format configuration of the field.

Parameters:

formatConfiguration - The format configuration of the field.

Returns:

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

formatConfiguration

default DateDimensionField.Builder formatConfiguration(Consumer<DateTimeFormatConfiguration.Builder> formatConfiguration)

The format configuration of the field.

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

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

Parameters:

formatConfiguration - a consumer that will call methods on DateTimeFormatConfiguration.Builder

Returns:

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

See Also:

• formatConfiguration(DateTimeFormatConfiguration)