Interface TopicColumn.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<TopicColumn.Builder,TopicColumn>
,SdkBuilder<TopicColumn.Builder,TopicColumn>
,SdkPojo
- Enclosing class:
- TopicColumn
public static interface TopicColumn.Builder extends SdkPojo, CopyableBuilder<TopicColumn.Builder,TopicColumn>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TopicColumn.Builder
aggregation(String aggregation)
The type of aggregation that is performed on the column data when it's queried.TopicColumn.Builder
aggregation(DefaultAggregation aggregation)
The type of aggregation that is performed on the column data when it's queried.TopicColumn.Builder
allowedAggregations(Collection<AuthorSpecifiedAggregation> allowedAggregations)
The list of aggregation types that are allowed for the column.TopicColumn.Builder
allowedAggregations(AuthorSpecifiedAggregation... allowedAggregations)
The list of aggregation types that are allowed for the column.TopicColumn.Builder
allowedAggregationsWithStrings(String... allowedAggregations)
The list of aggregation types that are allowed for the column.TopicColumn.Builder
allowedAggregationsWithStrings(Collection<String> allowedAggregations)
The list of aggregation types that are allowed for the column.TopicColumn.Builder
cellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the column cell value.TopicColumn.Builder
cellValueSynonyms(Consumer<CellValueSynonym.Builder>... cellValueSynonyms)
The other names or aliases for the column cell value.TopicColumn.Builder
cellValueSynonyms(CellValueSynonym... cellValueSynonyms)
The other names or aliases for the column cell value.TopicColumn.Builder
columnDataRole(String columnDataRole)
The role of the column in the data.TopicColumn.Builder
columnDataRole(ColumnDataRole columnDataRole)
The role of the column in the data.TopicColumn.Builder
columnDescription(String columnDescription)
A description of the column and its contents.TopicColumn.Builder
columnFriendlyName(String columnFriendlyName)
A user-friendly name for the column.TopicColumn.Builder
columnName(String columnName)
The name of the column.TopicColumn.Builder
columnSynonyms(String... columnSynonyms)
The other names or aliases for the column.TopicColumn.Builder
columnSynonyms(Collection<String> columnSynonyms)
The other names or aliases for the column.default TopicColumn.Builder
comparativeOrder(Consumer<ComparativeOrder.Builder> comparativeOrder)
The order in which data is displayed for the column when it's used in a comparative context.TopicColumn.Builder
comparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the column when it's used in a comparative context.default TopicColumn.Builder
defaultFormatting(Consumer<DefaultFormatting.Builder> defaultFormatting)
The default formatting used for values in the column.TopicColumn.Builder
defaultFormatting(DefaultFormatting defaultFormatting)
The default formatting used for values in the column.TopicColumn.Builder
disableIndexing(Boolean disableIndexing)
A Boolean value that indicates whether the column shows in the autocomplete functionality.TopicColumn.Builder
isIncludedInTopic(Boolean isIncludedInTopic)
A Boolean value that indicates whether the column is included in the query results.TopicColumn.Builder
neverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.TopicColumn.Builder
nonAdditive(Boolean nonAdditive)
The non additive value for the column.TopicColumn.Builder
notAllowedAggregations(Collection<AuthorSpecifiedAggregation> notAllowedAggregations)
The list of aggregation types that are not allowed for the column.TopicColumn.Builder
notAllowedAggregations(AuthorSpecifiedAggregation... notAllowedAggregations)
The list of aggregation types that are not allowed for the column.TopicColumn.Builder
notAllowedAggregationsWithStrings(String... notAllowedAggregations)
The list of aggregation types that are not allowed for the column.TopicColumn.Builder
notAllowedAggregationsWithStrings(Collection<String> notAllowedAggregations)
The list of aggregation types that are not allowed for the column.default TopicColumn.Builder
semanticType(Consumer<SemanticType.Builder> semanticType)
The semantic type of data contained in the column.TopicColumn.Builder
semanticType(SemanticType semanticType)
The semantic type of data contained in the column.TopicColumn.Builder
timeGranularity(String timeGranularity)
The level of time precision that is used to aggregateDateTime
values.TopicColumn.Builder
timeGranularity(TopicTimeGranularity timeGranularity)
The level of time precision that is used to aggregateDateTime
values.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
columnName
TopicColumn.Builder columnName(String columnName)
The name of the column.
- Parameters:
columnName
- The name of the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnFriendlyName
TopicColumn.Builder columnFriendlyName(String columnFriendlyName)
A user-friendly name for the column.
- Parameters:
columnFriendlyName
- A user-friendly name for the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnDescription
TopicColumn.Builder columnDescription(String columnDescription)
A description of the column and its contents.
- Parameters:
columnDescription
- A description of the column and its contents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnSynonyms
TopicColumn.Builder columnSynonyms(Collection<String> columnSynonyms)
The other names or aliases for the column.
- Parameters:
columnSynonyms
- The other names or aliases for the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnSynonyms
TopicColumn.Builder columnSynonyms(String... columnSynonyms)
The other names or aliases for the column.
- Parameters:
columnSynonyms
- The other names or aliases for the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnDataRole
TopicColumn.Builder columnDataRole(String columnDataRole)
The role of the column in the data. Valid values are
DIMENSION
andMEASURE
.- Parameters:
columnDataRole
- The role of the column in the data. Valid values areDIMENSION
andMEASURE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ColumnDataRole
,ColumnDataRole
-
columnDataRole
TopicColumn.Builder columnDataRole(ColumnDataRole columnDataRole)
The role of the column in the data. Valid values are
DIMENSION
andMEASURE
.- Parameters:
columnDataRole
- The role of the column in the data. Valid values areDIMENSION
andMEASURE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ColumnDataRole
,ColumnDataRole
-
aggregation
TopicColumn.Builder aggregation(String aggregation)
The type of aggregation that is performed on the column data when it's queried.
- Parameters:
aggregation
- The type of aggregation that is performed on the column data when it's queried.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DefaultAggregation
,DefaultAggregation
-
aggregation
TopicColumn.Builder aggregation(DefaultAggregation aggregation)
The type of aggregation that is performed on the column data when it's queried.
- Parameters:
aggregation
- The type of aggregation that is performed on the column data when it's queried.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DefaultAggregation
,DefaultAggregation
-
isIncludedInTopic
TopicColumn.Builder isIncludedInTopic(Boolean isIncludedInTopic)
A Boolean value that indicates whether the column is included in the query results.
- Parameters:
isIncludedInTopic
- A Boolean value that indicates whether the column is included in the query results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disableIndexing
TopicColumn.Builder disableIndexing(Boolean disableIndexing)
A Boolean value that indicates whether the column shows in the autocomplete functionality.
- Parameters:
disableIndexing
- A Boolean value that indicates whether the column shows in the autocomplete functionality.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
comparativeOrder
TopicColumn.Builder comparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the column when it's used in a comparative context.
- Parameters:
comparativeOrder
- The order in which data is displayed for the column when it's used in a comparative context.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
comparativeOrder
default TopicColumn.Builder comparativeOrder(Consumer<ComparativeOrder.Builder> comparativeOrder)
The order in which data is displayed for the column when it's used in a comparative context.
This is a convenience method that creates an instance of theComparativeOrder.Builder
avoiding the need to create one manually viaComparativeOrder.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocomparativeOrder(ComparativeOrder)
.- Parameters:
comparativeOrder
- a consumer that will call methods onComparativeOrder.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
comparativeOrder(ComparativeOrder)
-
semanticType
TopicColumn.Builder semanticType(SemanticType semanticType)
The semantic type of data contained in the column.
- Parameters:
semanticType
- The semantic type of data contained in the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
semanticType
default TopicColumn.Builder semanticType(Consumer<SemanticType.Builder> semanticType)
The semantic type of data contained in the column.
This is a convenience method that creates an instance of theSemanticType.Builder
avoiding the need to create one manually viaSemanticType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosemanticType(SemanticType)
.- Parameters:
semanticType
- a consumer that will call methods onSemanticType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
semanticType(SemanticType)
-
timeGranularity
TopicColumn.Builder timeGranularity(String timeGranularity)
The level of time precision that is used to aggregate
DateTime
values.- Parameters:
timeGranularity
- The level of time precision that is used to aggregateDateTime
values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TopicTimeGranularity
,TopicTimeGranularity
-
timeGranularity
TopicColumn.Builder timeGranularity(TopicTimeGranularity timeGranularity)
The level of time precision that is used to aggregate
DateTime
values.- Parameters:
timeGranularity
- The level of time precision that is used to aggregateDateTime
values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TopicTimeGranularity
,TopicTimeGranularity
-
allowedAggregationsWithStrings
TopicColumn.Builder allowedAggregationsWithStrings(Collection<String> 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
, andPERCENTILE
.- Parameters:
allowedAggregations
- The list of aggregation types that are allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedAggregationsWithStrings
TopicColumn.Builder allowedAggregationsWithStrings(String... 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
, andPERCENTILE
.- Parameters:
allowedAggregations
- The list of aggregation types that are allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedAggregations
TopicColumn.Builder allowedAggregations(Collection<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
, andPERCENTILE
.- Parameters:
allowedAggregations
- The list of aggregation types that are allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedAggregations
TopicColumn.Builder allowedAggregations(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
, andPERCENTILE
.- Parameters:
allowedAggregations
- The list of aggregation types that are allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAllowedAggregationsWithStrings
TopicColumn.Builder notAllowedAggregationsWithStrings(Collection<String> 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
, andPERCENTILE
.- Parameters:
notAllowedAggregations
- The list of aggregation types that are not allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAllowedAggregationsWithStrings
TopicColumn.Builder notAllowedAggregationsWithStrings(String... 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
, andPERCENTILE
.- Parameters:
notAllowedAggregations
- The list of aggregation types that are not allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAllowedAggregations
TopicColumn.Builder notAllowedAggregations(Collection<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
, andPERCENTILE
.- Parameters:
notAllowedAggregations
- The list of aggregation types that are not allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAllowedAggregations
TopicColumn.Builder notAllowedAggregations(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
, andPERCENTILE
.- Parameters:
notAllowedAggregations
- The list of aggregation types that are not allowed for the column. Valid values for this structure areCOUNT
,DISTINCT_COUNT
,MIN
,MAX
,MEDIAN
,SUM
,AVERAGE
,STDEV
,STDEVP
,VAR
,VARP
, andPERCENTILE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultFormatting
TopicColumn.Builder defaultFormatting(DefaultFormatting defaultFormatting)
The default formatting used for values in the column.
- Parameters:
defaultFormatting
- The default formatting used for values in the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultFormatting
default TopicColumn.Builder defaultFormatting(Consumer<DefaultFormatting.Builder> defaultFormatting)
The default formatting used for values in the column.
This is a convenience method that creates an instance of theDefaultFormatting.Builder
avoiding the need to create one manually viaDefaultFormatting.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultFormatting(DefaultFormatting)
.- Parameters:
defaultFormatting
- a consumer that will call methods onDefaultFormatting.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
defaultFormatting(DefaultFormatting)
-
neverAggregateInFilter
TopicColumn.Builder neverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
- Parameters:
neverAggregateInFilter
- A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cellValueSynonyms
TopicColumn.Builder cellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the column cell value.
- Parameters:
cellValueSynonyms
- The other names or aliases for the column cell value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cellValueSynonyms
TopicColumn.Builder cellValueSynonyms(CellValueSynonym... cellValueSynonyms)
The other names or aliases for the column cell value.
- Parameters:
cellValueSynonyms
- The other names or aliases for the column cell value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cellValueSynonyms
TopicColumn.Builder cellValueSynonyms(Consumer<CellValueSynonym.Builder>... cellValueSynonyms)
The other names or aliases for the column cell value.
This is a convenience method that creates an instance of theCellValueSynonym.Builder
avoiding the need to create one manually viaCellValueSynonym.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#cellValueSynonyms(List
.) - Parameters:
cellValueSynonyms
- a consumer that will call methods onCellValueSynonym.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#cellValueSynonyms(java.util.Collection
)
-
nonAdditive
TopicColumn.Builder nonAdditive(Boolean nonAdditive)
The non additive value for the column.
- Parameters:
nonAdditive
- The non additive value for the column.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-