TopicColumn (AWS Java SDK :: Services :: QuickSight 2.20.133 API)

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

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

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

Represents a column in a dataset.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TopicColumn.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TopicColumn.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultAggregation`	`aggregation()` The type of aggregation that is performed on the column data when it's queried.
`String`	`aggregationAsString()` The type of aggregation that is performed on the column data when it's queried.
`List<AuthorSpecifiedAggregation>`	`allowedAggregations()` The list of aggregation types that are allowed for the column.
`List<String>`	`allowedAggregationsAsStrings()` The list of aggregation types that are allowed for the column.
`static TopicColumn.Builder`	`builder()`
`List<CellValueSynonym>`	`cellValueSynonyms()` The other names or aliases for the column cell value.
`ColumnDataRole`	`columnDataRole()` The role of the column in the data.
`String`	`columnDataRoleAsString()` The role of the column in the data.
`String`	`columnDescription()` A description of the column and its contents.
`String`	`columnFriendlyName()` A user-friendly name for the column.
`String`	`columnName()` The name of the column.
`List<String>`	`columnSynonyms()` The other names or aliases for the column.
`ComparativeOrder`	`comparativeOrder()` The order in which data is displayed for the column when it's used in a comparative context.
`DefaultFormatting`	`defaultFormatting()` The default formatting used for values in the column.
`Boolean`	`disableIndexing()` A Boolean value that indicates whether the column shows in the autocomplete functionality.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedAggregations()` For responses, this returns true if the service returned a value for the AllowedAggregations property.
`boolean`	`hasCellValueSynonyms()` For responses, this returns true if the service returned a value for the CellValueSynonyms property.
`boolean`	`hasColumnSynonyms()` For responses, this returns true if the service returned a value for the ColumnSynonyms property.
`int`	`hashCode()`
`boolean`	`hasNotAllowedAggregations()` For responses, this returns true if the service returned a value for the NotAllowedAggregations property.
`Boolean`	`isIncludedInTopic()` A Boolean value that indicates whether the column is included in the query results.
`Boolean`	`neverAggregateInFilter()` A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
`Boolean`	`nonAdditive()` The non additive value for the column.
`List<AuthorSpecifiedAggregation>`	`notAllowedAggregations()` The list of aggregation types that are not allowed for the column.
`List<String>`	`notAllowedAggregationsAsStrings()` The list of aggregation types that are not allowed for the column.
`List<SdkField<?>>`	`sdkFields()`
`SemanticType`	`semanticType()` The semantic type of data contained in the column.
`static Class<? extends TopicColumn.Builder>`	`serializableBuilderClass()`
`TopicTimeGranularity`	`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.
`TopicColumn.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
  - columnName
```
public final String columnName()
```
    The name of the column.
    
    Returns:
    
    The name of the column.
  - columnFriendlyName
```
public final String columnFriendlyName()
```
    A user-friendly name for the column.
    
    Returns:
    
    A user-friendly name for the column.
  - columnDescription
```
public final String columnDescription()
```
    A description of the column and its contents.
    
    Returns:
    
    A description of the column and its contents.
  - hasColumnSynonyms
```
public final boolean hasColumnSynonyms()
```
    For responses, this returns true if the service returned a value for the ColumnSynonyms 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.
  - columnSynonyms
```
public final List<String> columnSynonyms()
```
    The other names or aliases for the column.
    
    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 hasColumnSynonyms() method.
    
    Returns:
    
    The other names or aliases for the column.
  - columnDataRole
```
public final ColumnDataRole columnDataRole()
```
    The role of the column in the data. Valid values are DIMENSION and MEASURE.
    
    If the service returns an enum value that is not available in the current SDK version, columnDataRole will return ColumnDataRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnDataRoleAsString().
    
    Returns:
    
    The role of the column in the data. Valid values are DIMENSION and MEASURE.
    
    See Also:
    
    ColumnDataRole
  - columnDataRoleAsString
```
public final String columnDataRoleAsString()
```
    The role of the column in the data. Valid values are DIMENSION and MEASURE.
    
    If the service returns an enum value that is not available in the current SDK version, columnDataRole will return ColumnDataRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnDataRoleAsString().
    
    Returns:
    
    The role of the column in the data. Valid values are DIMENSION and MEASURE.
    
    See Also:
    
    ColumnDataRole
  - aggregation
```
public final DefaultAggregation aggregation()
```
    The type of aggregation that is performed on the column data when it's queried.
    
    If the service returns an enum value that is not available in the current SDK version, aggregation will return DefaultAggregation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().
    
    Returns:
    
    The type of aggregation that is performed on the column data when it's queried.
    
    See Also:
    
    DefaultAggregation
  - aggregationAsString
```
public final String aggregationAsString()
```
    The type of aggregation that is performed on the column data when it's queried.
    
    If the service returns an enum value that is not available in the current SDK version, aggregation will return DefaultAggregation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().
    
    Returns:
    
    The type of aggregation that is performed on the column data when it's queried.
    
    See Also:
    
    DefaultAggregation
  - isIncludedInTopic
```
public final Boolean isIncludedInTopic()
```
    A Boolean value that indicates whether the column is included in the query results.
    
    Returns:
    
    A Boolean value that indicates whether the column is included in the query results.
  - disableIndexing
```
public final Boolean disableIndexing()
```
    A Boolean value that indicates whether the column shows in the autocomplete functionality.
    
    Returns:
    
    A Boolean value that indicates whether the column shows in the autocomplete functionality.
  - comparativeOrder
```
public final ComparativeOrder comparativeOrder()
```
    The order in which data is displayed for the column when it's used in a comparative context.
    
    Returns:
    
    The order in which data is displayed for the column when it's used in a comparative context.
  - semanticType
```
public final SemanticType semanticType()
```
    The semantic type of data contained in the column.
    
    Returns:
    
    The semantic type of data contained in the column.
  - timeGranularity
```
public final TopicTimeGranularity 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 TopicTimeGranularity.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:
    
    TopicTimeGranularity
  - 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 TopicTimeGranularity.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:
    
    TopicTimeGranularity
  - allowedAggregations
```
public final List<AuthorSpecifiedAggregation> allowedAggregations()
```
    The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
    
    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 hasAllowedAggregations() method.
    
    Returns:
    
    The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  - hasAllowedAggregations
```
public final boolean hasAllowedAggregations()
```
    For responses, this returns true if the service returned a value for the AllowedAggregations 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.
  - allowedAggregationsAsStrings
```
public final List<String> allowedAggregationsAsStrings()
```
    The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
    
    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 hasAllowedAggregations() method.
    
    Returns:
    
    The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  - notAllowedAggregations
```
public final List<AuthorSpecifiedAggregation> notAllowedAggregations()
```
    The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
    
    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 hasNotAllowedAggregations() method.
    
    Returns:
    
    The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  - hasNotAllowedAggregations
```
public final boolean hasNotAllowedAggregations()
```
    For responses, this returns true if the service returned a value for the NotAllowedAggregations 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.
  - notAllowedAggregationsAsStrings
```
public final List<String> notAllowedAggregationsAsStrings()
```
    The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
    
    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 hasNotAllowedAggregations() method.
    
    Returns:
    
    The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  - defaultFormatting
```
public final DefaultFormatting defaultFormatting()
```
    The default formatting used for values in the column.
    
    Returns:
    
    The default formatting used for values in the column.
  - neverAggregateInFilter
```
public final Boolean neverAggregateInFilter()
```
    A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
    
    Returns:
    
    A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
  - hasCellValueSynonyms
```
public final boolean hasCellValueSynonyms()
```
    For responses, this returns true if the service returned a value for the CellValueSynonyms 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.
  - cellValueSynonyms
```
public final List<CellValueSynonym> cellValueSynonyms()
```
    The other names or aliases for the column cell value.
    
    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 hasCellValueSynonyms() method.
    
    Returns:
    
    The other names or aliases for the column cell value.
  - nonAdditive
```
public final Boolean nonAdditive()
```
    The non additive value for the column.
    
    Returns:
    
    The non additive value for the column.
  - toBuilder
```
public TopicColumn.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicColumn.Builder,TopicColumn>
  - builder
```
public static TopicColumn.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TopicColumn.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

Class TopicColumn

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

columnName

columnFriendlyName

columnDescription

hasColumnSynonyms

columnSynonyms

columnDataRole

columnDataRoleAsString

aggregation

aggregationAsString

isIncludedInTopic

disableIndexing

comparativeOrder

semanticType

timeGranularity

timeGranularityAsString

allowedAggregations

hasAllowedAggregations

allowedAggregationsAsStrings

notAllowedAggregations

hasNotAllowedAggregations

notAllowedAggregationsAsStrings

defaultFormatting

neverAggregateInFilter

hasCellValueSynonyms

cellValueSynonyms

nonAdditive

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields