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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExcludePeriodConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Integer	amount()	The amount or number of the exclude period.
static ExcludePeriodConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
TimeGranularity	granularity()	The granularity or unit (day, month, year) of the exclude period.
String	granularityAsString()	The granularity or unit (day, month, year) of the exclude period.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ExcludePeriodConfiguration.Builder>	serializableBuilderClass()
WidgetStatus	status()	The status of the exclude period.
String	statusAsString()	The status of the exclude period.
ExcludePeriodConfiguration.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

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:

TimeGranularity

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:

TimeGranularity

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:

WidgetStatus

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:

WidgetStatus

toBuilder

public ExcludePeriodConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExcludePeriodConfiguration.Builder,ExcludePeriodConfiguration>

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)

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