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

Class ExcludePeriodConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.ExcludePeriodConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExcludePeriodConfiguration.Builder,ExcludePeriodConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ExcludePeriodConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExcludePeriodConfiguration.Builder,ExcludePeriodConfiguration>

The exclude period of TimeRangeFilter or RelativeDatesFilter.

See Also:

  • Method Details

    • amount

      public final Integer amount()

      The amount or number of the exclude period.

      Returns:
      The amount or number of the exclude period.

    • granularity

      public final TimeGranularity granularity()

      The granularity or unit (day, month, year) of the exclude period.

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

      Returns:
      The granularity or unit (day, month, year) of the exclude period.
      See Also:

    • granularityAsString

      public final String granularityAsString()

      The granularity or unit (day, month, year) of the exclude period.

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

      Returns:
      The granularity or unit (day, month, year) of the exclude period.
      See Also:

    • status

      public final WidgetStatus status()

      The status of the exclude period. Choose from the following options:

      • ENABLED

      • DISABLED

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

      Returns:
      The status of the exclude period. Choose from the following options:

      • ENABLED

      • DISABLED

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the exclude period. Choose from the following options:

      • ENABLED

      • DISABLED

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

      Returns:
      The status of the exclude period. Choose from the following options:

      • ENABLED

      • DISABLED

      See Also:

    • toBuilder

      public ExcludePeriodConfiguration.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<ExcludePeriodConfiguration.Builder,ExcludePeriodConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ExcludePeriodConfiguration.Builder builder()

    • serializableBuilderClass

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