java.lang.Object
- software.amazon.awssdk.services.quicksight.model.TopicIRFilterOption

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TopicIRFilterOption.Builder,TopicIRFilterOption>

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

The definition for a TopicIRFilterOption.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TopicIRFilterOption.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<FilterAggMetrics>`	`aggMetrics()`	The agg metrics for the `TopicIRFilterOption`.
`AggType`	`aggregation()`	The aggregation for the `TopicIRFilterOption`.
`String`	`aggregationAsString()`	The aggregation for the `TopicIRFilterOption`.
`Map<String,String>`	`aggregationFunctionParameters()`	The aggregation function parameters for the `TopicIRFilterOption`.
`List<AggregationPartitionBy>`	`aggregationPartitionBy()`	The `AggregationPartitionBy` for the `TopicIRFilterOption`.
`Anchor`	`anchor()`	The anchor for the `TopicIRFilterOption`.
`static TopicIRFilterOption.Builder`	`builder()`
`TopicConstantValue`	`constant()`	The constant for the `TopicIRFilterOption`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FilterClass`	`filterClass()`	The filter class for the `TopicIRFilterOption`.
`String`	`filterClassAsString()`	The filter class for the `TopicIRFilterOption`.
`TopicIRFilterType`	`filterType()`	The filter type for the `TopicIRFilterOption`.
`String`	`filterTypeAsString()`	The filter type for the `TopicIRFilterOption`.
`TopicIRFilterFunction`	`function()`	The function for the `TopicIRFilterOption`.
`String`	`functionAsString()`	The function for the `TopicIRFilterOption`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAggMetrics()`	For responses, this returns true if the service returned a value for the AggMetrics property.
`boolean`	`hasAggregationFunctionParameters()`	For responses, this returns true if the service returned a value for the AggregationFunctionParameters property.
`boolean`	`hasAggregationPartitionBy()`	For responses, this returns true if the service returned a value for the AggregationPartitionBy property.
`int`	`hashCode()`
`Boolean`	`inclusive()`	The inclusive for the `TopicIRFilterOption`.
`Boolean`	`inverse()`	The inverse for the `TopicIRFilterOption`.
`TopicConstantValue`	`lastNextOffset()`	The last next offset for the `TopicIRFilterOption`.
`NullFilterOption`	`nullFilter()`	The null filter for the `TopicIRFilterOption`.
`String`	`nullFilterAsString()`	The null filter for the `TopicIRFilterOption`.
`Identifier`	`operandField()`	The operand field for the `TopicIRFilterOption`.
`TopicConstantValue`	`range()`	The range for the `TopicIRFilterOption`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TopicIRFilterOption.Builder>`	`serializableBuilderClass()`
`TopicSortDirection`	`sortDirection()`	The sort direction for the `TopicIRFilterOption`.
`String`	`sortDirectionAsString()`	The sort direction for the `TopicIRFilterOption`.
`TimeGranularity`	`timeGranularity()`	The time granularity for the `TopicIRFilterOption`.
`String`	`timeGranularityAsString()`	The time granularity for the `TopicIRFilterOption`.
`TopicIRFilterOption.Builder`	`toBuilder()`
`TopicConstantValue`	`topBottomLimit()`	The `TopBottomLimit` for the `TopicIRFilterOption`.
`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
  - filterType
```
public final TopicIRFilterType filterType()
```
    The filter type for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, filterType will return TopicIRFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterTypeAsString().
    
    Returns:
    
    The filter type for the TopicIRFilterOption.
    
    See Also:
    
    TopicIRFilterType
  - filterTypeAsString
```
public final String filterTypeAsString()
```
    The filter type for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, filterType will return TopicIRFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterTypeAsString().
    
    Returns:
    
    The filter type for the TopicIRFilterOption.
    
    See Also:
    
    TopicIRFilterType
  - filterClass
```
public final FilterClass filterClass()
```
    The filter class for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, filterClass will return FilterClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterClassAsString().
    
    Returns:
    
    The filter class for the TopicIRFilterOption.
    
    See Also:
    
    FilterClass
  - filterClassAsString
```
public final String filterClassAsString()
```
    The filter class for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, filterClass will return FilterClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterClassAsString().
    
    Returns:
    
    The filter class for the TopicIRFilterOption.
    
    See Also:
    
    FilterClass
  - operandField
```
public final Identifier operandField()
```
    The operand field for the TopicIRFilterOption.
    
    Returns:
    
    The operand field for the TopicIRFilterOption.
  - function
```
public final TopicIRFilterFunction function()
```
    The function for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, function will return TopicIRFilterFunction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionAsString().
    
    Returns:
    
    The function for the TopicIRFilterOption.
    
    See Also:
    
    TopicIRFilterFunction
  - functionAsString
```
public final String functionAsString()
```
    The function for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, function will return TopicIRFilterFunction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionAsString().
    
    Returns:
    
    The function for the TopicIRFilterOption.
    
    See Also:
    
    TopicIRFilterFunction
  - constant
```
public final TopicConstantValue constant()
```
    The constant for the TopicIRFilterOption.
    
    Returns:
    
    The constant for the TopicIRFilterOption.
  - inverse
```
public final Boolean inverse()
```
    The inverse for the TopicIRFilterOption.
    
    Returns:
    
    The inverse for the TopicIRFilterOption.
  - nullFilter
```
public final NullFilterOption nullFilter()
```
    The null filter for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, nullFilter will return NullFilterOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullFilterAsString().
    
    Returns:
    
    The null filter for the TopicIRFilterOption.
    
    See Also:
    
    NullFilterOption
  - nullFilterAsString
```
public final String nullFilterAsString()
```
    The null filter for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, nullFilter will return NullFilterOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullFilterAsString().
    
    Returns:
    
    The null filter for the TopicIRFilterOption.
    
    See Also:
    
    NullFilterOption
  - aggregation
```
public final AggType aggregation()
```
    The aggregation for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, aggregation will return AggType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().
    
    Returns:
    
    The aggregation for the TopicIRFilterOption.
    
    See Also:
    
    AggType
  - aggregationAsString
```
public final String aggregationAsString()
```
    The aggregation for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, aggregation will return AggType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().
    
    Returns:
    
    The aggregation for the TopicIRFilterOption.
    
    See Also:
    
    AggType
  - hasAggregationFunctionParameters
```
public final boolean hasAggregationFunctionParameters()
```
    For responses, this returns true if the service returned a value for the AggregationFunctionParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - aggregationFunctionParameters
```
public final Map<String,String> aggregationFunctionParameters()
```
    The aggregation function parameters for the TopicIRFilterOption.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggregationFunctionParameters() method.
    
    Returns:
    
    The aggregation function parameters for the TopicIRFilterOption.
  - hasAggregationPartitionBy
```
public final boolean hasAggregationPartitionBy()
```
    For responses, this returns true if the service returned a value for the AggregationPartitionBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - aggregationPartitionBy
```
public final List<AggregationPartitionBy> aggregationPartitionBy()
```
    The AggregationPartitionBy for the TopicIRFilterOption.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggregationPartitionBy() method.
    
    Returns:
    
    The AggregationPartitionBy for the TopicIRFilterOption.
  - range
```
public final TopicConstantValue range()
```
    The range for the TopicIRFilterOption.
    
    Returns:
    
    The range for the TopicIRFilterOption.
  - inclusive
```
public final Boolean inclusive()
```
    The inclusive for the TopicIRFilterOption.
    
    Returns:
    
    The inclusive for the TopicIRFilterOption.
  - timeGranularity
```
public final TimeGranularity timeGranularity()
```
    The time granularity for the TopicIRFilterOption.
    
    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 time granularity for the TopicIRFilterOption.
    
    See Also:
    
    TimeGranularity
  - timeGranularityAsString
```
public final String timeGranularityAsString()
```
    The time granularity for the TopicIRFilterOption.
    
    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 time granularity for the TopicIRFilterOption.
    
    See Also:
    
    TimeGranularity
  - lastNextOffset
```
public final TopicConstantValue lastNextOffset()
```
    The last next offset for the TopicIRFilterOption.
    
    Returns:
    
    The last next offset for the TopicIRFilterOption.
  - hasAggMetrics
```
public final boolean hasAggMetrics()
```
    For responses, this returns true if the service returned a value for the AggMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - aggMetrics
```
public final List<FilterAggMetrics> aggMetrics()
```
    The agg metrics for the TopicIRFilterOption.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggMetrics() method.
    
    Returns:
    
    The agg metrics for the TopicIRFilterOption.
  - topBottomLimit
```
public final TopicConstantValue topBottomLimit()
```
    The TopBottomLimit for the TopicIRFilterOption.
    
    Returns:
    
    The TopBottomLimit for the TopicIRFilterOption.
  - sortDirection
```
public final TopicSortDirection sortDirection()
```
    The sort direction for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, sortDirection will return TopicSortDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortDirectionAsString().
    
    Returns:
    
    The sort direction for the TopicIRFilterOption.
    
    See Also:
    
    TopicSortDirection
  - sortDirectionAsString
```
public final String sortDirectionAsString()
```
    The sort direction for the TopicIRFilterOption.
    
    If the service returns an enum value that is not available in the current SDK version, sortDirection will return TopicSortDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortDirectionAsString().
    
    Returns:
    
    The sort direction for the TopicIRFilterOption.
    
    See Also:
    
    TopicSortDirection
  - anchor
```
public final Anchor anchor()
```
    The anchor for the TopicIRFilterOption.
    
    Returns:
    
    The anchor for the TopicIRFilterOption.
  - toBuilder
```
public TopicIRFilterOption.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicIRFilterOption.Builder,TopicIRFilterOption>
  - builder
```
public static TopicIRFilterOption.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TopicIRFilterOption.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TopicIRFilterOption

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

filterType

filterTypeAsString

filterClass

filterClassAsString

operandField

function

functionAsString

constant

inverse

nullFilter

nullFilterAsString

aggregation

aggregationAsString

hasAggregationFunctionParameters

aggregationFunctionParameters

hasAggregationPartitionBy

aggregationPartitionBy

range

inclusive

timeGranularity

timeGranularityAsString

lastNextOffset

hasAggMetrics

aggMetrics

topBottomLimit

sortDirection

sortDirectionAsString

anchor

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField