quicksight/aws.sdk.kotlin.services.quicksight.model/RelativeDatesFilter

RelativeDatesFilter

class RelativeDatesFilter

A RelativeDatesFilter filters relative dates values.

Types

Builder

class Builder

Companion

object Companion

Properties

anchorDateConfiguration

val anchorDateConfiguration: AnchorDateConfiguration?

The date configuration of the filter.

column

val column: ColumnIdentifier?

The column that the filter is applied to.

defaultFilterControlConfiguration

val defaultFilterControlConfiguration: DefaultFilterControlConfiguration?

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

excludePeriodConfiguration

val excludePeriodConfiguration: ExcludePeriodConfiguration?

The configuration for the exclude period of the filter.

filterId

val filterId: String

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

minimumGranularity

val minimumGranularity: TimeGranularity?

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

nullOption

val nullOption: FilterNullOption

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

parameterName

val parameterName: String?

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

relativeDateType

val relativeDateType: RelativeDateType

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

relativeDateValue

val relativeDateValue: Int?

The date value of the filter.

timeGranularity

val timeGranularity: TimeGranularity

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

Functions

copy

inline fun copy(block: RelativeDatesFilter.Builder.() -> Unit = {}): RelativeDatesFilter

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String