software.amazon.awssdk.services.quicksight.model

Class RelativeDatesFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RelativeDatesFilter

All Implemented Interfaces:

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

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

A RelativeDatesFilter filters relative dates values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RelativeDatesFilter.Builder

Method Summary

Modifier and Type	Method and Description
AnchorDateConfiguration	anchorDateConfiguration() The date configuration of the filter.
static RelativeDatesFilter.Builder	builder()
ColumnIdentifier	column() The column that the filter is applied to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExcludePeriodConfiguration	excludePeriodConfiguration() The configuration for the exclude period of the filter.
String	filterId() An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
TimeGranularity	minimumGranularity() The minimum granularity (period granularity) of the relative dates filter.
String	minimumGranularityAsString() The minimum granularity (period granularity) of the relative dates filter.
FilterNullOption	nullOption() This option determines how null values should be treated when filtering data.
String	nullOptionAsString() This option determines how null values should be treated when filtering data.
String	parameterName() The parameter whose value should be used for the filter value.
RelativeDateType	relativeDateType() The range date type of the filter.
String	relativeDateTypeAsString() The range date type of the filter.
Integer	relativeDateValue() The date value of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends RelativeDatesFilter.Builder>	serializableBuilderClass()
TimeGranularity	timeGranularity() The level of time precision that is used to aggregate DateTime values.
String	timeGranularityAsString() The level of time precision that is used to aggregate DateTime values.
RelativeDatesFilter.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

filterId

public final String filterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

public final ColumnIdentifier column()

The column that the filter is applied to.

Returns:

The column that the filter is applied to.

anchorDateConfiguration

public final AnchorDateConfiguration anchorDateConfiguration()

The date configuration of the filter.

Returns:

The date configuration of the filter.

minimumGranularity

public final TimeGranularity minimumGranularity()

The minimum granularity (period granularity) of the relative dates filter.

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

Returns:

The minimum granularity (period granularity) of the relative dates filter.

See Also:

TimeGranularity

minimumGranularityAsString

public final String minimumGranularityAsString()

The minimum granularity (period granularity) of the relative dates filter.

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

Returns:

The minimum granularity (period granularity) of the relative dates filter.

See Also:

TimeGranularity

timeGranularity

public final TimeGranularity timeGranularity()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

timeGranularityAsString

public final String timeGranularityAsString()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

relativeDateType

public final RelativeDateType relativeDateType()

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

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

Returns:

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

See Also:

RelativeDateType

relativeDateTypeAsString

public final String relativeDateTypeAsString()

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

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

Returns:

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

See Also:

RelativeDateType

relativeDateValue

public final Integer relativeDateValue()

The date value of the filter.

Returns:

The date value of the filter.

parameterName

public final String parameterName()

The parameter whose value should be used for the filter value.

Returns:

The parameter whose value should be used for the filter value.

nullOption

public final FilterNullOption nullOption()

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

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

Returns:

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

See Also:

FilterNullOption

nullOptionAsString

public final String nullOptionAsString()

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

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

Returns:

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

See Also:

FilterNullOption

excludePeriodConfiguration

public final ExcludePeriodConfiguration excludePeriodConfiguration()

The configuration for the exclude period of the filter.

Returns:

The configuration for the exclude period of the filter.

toBuilder

public RelativeDatesFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RelativeDatesFilter.Builder,RelativeDatesFilter>

builder

public static RelativeDatesFilter.Builder builder()

serializableBuilderClass

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