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

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

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

The definition for a TopicIR.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TopicIR.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TopicIR.Builder`	`builder()`
`TopicIRContributionAnalysis`	`contributionAnalysis()`	The contribution analysis for the `TopicIR`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<List<TopicIRFilterOption>>`	`filters()`	The filters for the `TopicIR`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<TopicIRGroupBy>`	`groupByList()`	The GroupBy list for the `TopicIR`.
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`boolean`	`hasGroupByList()`	For responses, this returns true if the service returned a value for the GroupByList property.
`int`	`hashCode()`
`boolean`	`hasMetrics()`	For responses, this returns true if the service returned a value for the Metrics property.
`List<TopicIRMetric>`	`metrics()`	The metrics for the `TopicIR`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TopicIR.Builder>`	`serializableBuilderClass()`
`TopicSortClause`	`sort()`	The sort for the `TopicIR`.
`TopicIR.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VisualOptions`	`visual()`	The visual for the `TopicIR`.

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
  - hasMetrics
```
public final boolean hasMetrics()
```
    For responses, this returns true if the service returned a value for the Metrics 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.
  - metrics
```
public final List<TopicIRMetric> metrics()
```
    The metrics for the TopicIR.
    
    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 hasMetrics() method.
    
    Returns:
    
    The metrics for the TopicIR.
  - hasGroupByList
```
public final boolean hasGroupByList()
```
    For responses, this returns true if the service returned a value for the GroupByList 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.
  - groupByList
```
public final List<TopicIRGroupBy> groupByList()
```
    The GroupBy list for the TopicIR.
    
    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 hasGroupByList() method.
    
    Returns:
    
    The GroupBy list for the TopicIR.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters 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.
  - filters
```
public final List<List<TopicIRFilterOption>> filters()
```
    The filters for the TopicIR.
    
    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 hasFilters() method.
    
    Returns:
    
    The filters for the TopicIR.
  - sort
```
public final TopicSortClause sort()
```
    The sort for the TopicIR.
    
    Returns:
    
    The sort for the TopicIR.
  - contributionAnalysis
```
public final TopicIRContributionAnalysis contributionAnalysis()
```
    The contribution analysis for the TopicIR.
    
    Returns:
    
    The contribution analysis for the TopicIR.
  - visual
```
public final VisualOptions visual()
```
    The visual for the TopicIR.
    
    Returns:
    
    The visual for the TopicIR.
  - toBuilder
```
public TopicIR.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicIR.Builder,TopicIR>
  - builder
```
public static TopicIR.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TopicIR.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 TopicIR

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasMetrics

metrics

hasGroupByList

groupByList

hasFilters

filters

sort

contributionAnalysis

visual

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField