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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DateDimensionField.Builder,DateDimensionField>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.