@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TopicCalculatedField extends Object implements Serializable, Cloneable, StructuredPojo
A structure that represents a calculated field.
Constructor and Description |
---|
TopicCalculatedField() |
Modifier and Type | Method and Description |
---|---|
TopicCalculatedField |
clone() |
boolean |
equals(Object obj) |
String |
getAggregation()
The default aggregation.
|
List<String> |
getAllowedAggregations()
The list of aggregation types that are allowed for the calculated field.
|
String |
getCalculatedFieldDescription()
The calculated field description.
|
String |
getCalculatedFieldName()
The calculated field name.
|
List<String> |
getCalculatedFieldSynonyms()
The other names or aliases for the calculated field.
|
List<CellValueSynonym> |
getCellValueSynonyms()
The other names or aliases for the calculated field cell value.
|
String |
getColumnDataRole()
The column data role for a calculated field.
|
ComparativeOrder |
getComparativeOrder()
The order in which data is displayed for the calculated field when it's used in a comparative context.
|
DefaultFormatting |
getDefaultFormatting()
The default formatting definition.
|
Boolean |
getDisableIndexing()
A Boolean value that indicates if a calculated field is visible in the autocomplete.
|
String |
getExpression()
The calculated field expression.
|
Boolean |
getIsIncludedInTopic()
A boolean value that indicates if a calculated field is included in the topic.
|
Boolean |
getNeverAggregateInFilter()
A Boolean value that indicates whether to never aggregate calculated field in filters.
|
Boolean |
getNonAdditive()
The non additive for the table style target.
|
List<String> |
getNotAllowedAggregations()
The list of aggregation types that are not allowed for the calculated field.
|
SemanticType |
getSemanticType()
The semantic type.
|
String |
getTimeGranularity()
The level of time precision that is used to aggregate
DateTime values. |
int |
hashCode() |
Boolean |
isDisableIndexing()
A Boolean value that indicates if a calculated field is visible in the autocomplete.
|
Boolean |
isIncludedInTopic()
A boolean value that indicates if a calculated field is included in the topic.
|
Boolean |
isNeverAggregateInFilter()
A Boolean value that indicates whether to never aggregate calculated field in filters.
|
Boolean |
isNonAdditive()
The non additive for the table style target.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAggregation(String aggregation)
The default aggregation.
|
void |
setAllowedAggregations(Collection<String> allowedAggregations)
The list of aggregation types that are allowed for the calculated field.
|
void |
setCalculatedFieldDescription(String calculatedFieldDescription)
The calculated field description.
|
void |
setCalculatedFieldName(String calculatedFieldName)
The calculated field name.
|
void |
setCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
The other names or aliases for the calculated field.
|
void |
setCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the calculated field cell value.
|
void |
setColumnDataRole(String columnDataRole)
The column data role for a calculated field.
|
void |
setComparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the calculated field when it's used in a comparative context.
|
void |
setDefaultFormatting(DefaultFormatting defaultFormatting)
The default formatting definition.
|
void |
setDisableIndexing(Boolean disableIndexing)
A Boolean value that indicates if a calculated field is visible in the autocomplete.
|
void |
setExpression(String expression)
The calculated field expression.
|
void |
setIsIncludedInTopic(Boolean isIncludedInTopic)
A boolean value that indicates if a calculated field is included in the topic.
|
void |
setNeverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to never aggregate calculated field in filters.
|
void |
setNonAdditive(Boolean nonAdditive)
The non additive for the table style target.
|
void |
setNotAllowedAggregations(Collection<String> notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field.
|
void |
setSemanticType(SemanticType semanticType)
The semantic type.
|
void |
setTimeGranularity(String timeGranularity)
The level of time precision that is used to aggregate
DateTime values. |
String |
toString()
Returns a string representation of this object.
|
TopicCalculatedField |
withAggregation(DefaultAggregation aggregation)
The default aggregation.
|
TopicCalculatedField |
withAggregation(String aggregation)
The default aggregation.
|
TopicCalculatedField |
withAllowedAggregations(AuthorSpecifiedAggregation... allowedAggregations)
The list of aggregation types that are allowed for the calculated field.
|
TopicCalculatedField |
withAllowedAggregations(Collection<String> allowedAggregations)
The list of aggregation types that are allowed for the calculated field.
|
TopicCalculatedField |
withAllowedAggregations(String... allowedAggregations)
The list of aggregation types that are allowed for the calculated field.
|
TopicCalculatedField |
withCalculatedFieldDescription(String calculatedFieldDescription)
The calculated field description.
|
TopicCalculatedField |
withCalculatedFieldName(String calculatedFieldName)
The calculated field name.
|
TopicCalculatedField |
withCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
The other names or aliases for the calculated field.
|
TopicCalculatedField |
withCalculatedFieldSynonyms(String... calculatedFieldSynonyms)
The other names or aliases for the calculated field.
|
TopicCalculatedField |
withCellValueSynonyms(CellValueSynonym... cellValueSynonyms)
The other names or aliases for the calculated field cell value.
|
TopicCalculatedField |
withCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the calculated field cell value.
|
TopicCalculatedField |
withColumnDataRole(ColumnDataRole columnDataRole)
The column data role for a calculated field.
|
TopicCalculatedField |
withColumnDataRole(String columnDataRole)
The column data role for a calculated field.
|
TopicCalculatedField |
withComparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the calculated field when it's used in a comparative context.
|
TopicCalculatedField |
withDefaultFormatting(DefaultFormatting defaultFormatting)
The default formatting definition.
|
TopicCalculatedField |
withDisableIndexing(Boolean disableIndexing)
A Boolean value that indicates if a calculated field is visible in the autocomplete.
|
TopicCalculatedField |
withExpression(String expression)
The calculated field expression.
|
TopicCalculatedField |
withIsIncludedInTopic(Boolean isIncludedInTopic)
A boolean value that indicates if a calculated field is included in the topic.
|
TopicCalculatedField |
withNeverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to never aggregate calculated field in filters.
|
TopicCalculatedField |
withNonAdditive(Boolean nonAdditive)
The non additive for the table style target.
|
TopicCalculatedField |
withNotAllowedAggregations(AuthorSpecifiedAggregation... notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field.
|
TopicCalculatedField |
withNotAllowedAggregations(Collection<String> notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field.
|
TopicCalculatedField |
withNotAllowedAggregations(String... notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field.
|
TopicCalculatedField |
withSemanticType(SemanticType semanticType)
The semantic type.
|
TopicCalculatedField |
withTimeGranularity(String timeGranularity)
The level of time precision that is used to aggregate
DateTime values. |
TopicCalculatedField |
withTimeGranularity(TopicTimeGranularity timeGranularity)
The level of time precision that is used to aggregate
DateTime values. |
public void setCalculatedFieldName(String calculatedFieldName)
The calculated field name.
calculatedFieldName
- The calculated field name.public String getCalculatedFieldName()
The calculated field name.
public TopicCalculatedField withCalculatedFieldName(String calculatedFieldName)
The calculated field name.
calculatedFieldName
- The calculated field name.public void setCalculatedFieldDescription(String calculatedFieldDescription)
The calculated field description.
calculatedFieldDescription
- The calculated field description.public String getCalculatedFieldDescription()
The calculated field description.
public TopicCalculatedField withCalculatedFieldDescription(String calculatedFieldDescription)
The calculated field description.
calculatedFieldDescription
- The calculated field description.public void setExpression(String expression)
The calculated field expression.
expression
- The calculated field expression.public String getExpression()
The calculated field expression.
public TopicCalculatedField withExpression(String expression)
The calculated field expression.
expression
- The calculated field expression.public List<String> getCalculatedFieldSynonyms()
The other names or aliases for the calculated field.
public void setCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
The other names or aliases for the calculated field.
calculatedFieldSynonyms
- The other names or aliases for the calculated field.public TopicCalculatedField withCalculatedFieldSynonyms(String... calculatedFieldSynonyms)
The other names or aliases for the calculated field.
NOTE: This method appends the values to the existing list (if any). Use
setCalculatedFieldSynonyms(java.util.Collection)
or
withCalculatedFieldSynonyms(java.util.Collection)
if you want to override the existing values.
calculatedFieldSynonyms
- The other names or aliases for the calculated field.public TopicCalculatedField withCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
The other names or aliases for the calculated field.
calculatedFieldSynonyms
- The other names or aliases for the calculated field.public void setIsIncludedInTopic(Boolean isIncludedInTopic)
A boolean value that indicates if a calculated field is included in the topic.
isIncludedInTopic
- A boolean value that indicates if a calculated field is included in the topic.public Boolean getIsIncludedInTopic()
A boolean value that indicates if a calculated field is included in the topic.
public TopicCalculatedField withIsIncludedInTopic(Boolean isIncludedInTopic)
A boolean value that indicates if a calculated field is included in the topic.
isIncludedInTopic
- A boolean value that indicates if a calculated field is included in the topic.public Boolean isIncludedInTopic()
A boolean value that indicates if a calculated field is included in the topic.
public void setDisableIndexing(Boolean disableIndexing)
A Boolean value that indicates if a calculated field is visible in the autocomplete.
disableIndexing
- A Boolean value that indicates if a calculated field is visible in the autocomplete.public Boolean getDisableIndexing()
A Boolean value that indicates if a calculated field is visible in the autocomplete.
public TopicCalculatedField withDisableIndexing(Boolean disableIndexing)
A Boolean value that indicates if a calculated field is visible in the autocomplete.
disableIndexing
- A Boolean value that indicates if a calculated field is visible in the autocomplete.public Boolean isDisableIndexing()
A Boolean value that indicates if a calculated field is visible in the autocomplete.
public void setColumnDataRole(String columnDataRole)
The column data role for a calculated field. Valid values for this structure are DIMENSION
and
MEASURE
.
columnDataRole
- The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.ColumnDataRole
public String getColumnDataRole()
The column data role for a calculated field. Valid values for this structure are DIMENSION
and
MEASURE
.
DIMENSION
and MEASURE
.ColumnDataRole
public TopicCalculatedField withColumnDataRole(String columnDataRole)
The column data role for a calculated field. Valid values for this structure are DIMENSION
and
MEASURE
.
columnDataRole
- The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.ColumnDataRole
public TopicCalculatedField withColumnDataRole(ColumnDataRole columnDataRole)
The column data role for a calculated field. Valid values for this structure are DIMENSION
and
MEASURE
.
columnDataRole
- The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.ColumnDataRole
public void setTimeGranularity(String timeGranularity)
The level of time precision that is used to aggregate DateTime
values.
timeGranularity
- The level of time precision that is used to aggregate DateTime
values.TopicTimeGranularity
public String getTimeGranularity()
The level of time precision that is used to aggregate DateTime
values.
DateTime
values.TopicTimeGranularity
public TopicCalculatedField withTimeGranularity(String timeGranularity)
The level of time precision that is used to aggregate DateTime
values.
timeGranularity
- The level of time precision that is used to aggregate DateTime
values.TopicTimeGranularity
public TopicCalculatedField withTimeGranularity(TopicTimeGranularity timeGranularity)
The level of time precision that is used to aggregate DateTime
values.
timeGranularity
- The level of time precision that is used to aggregate DateTime
values.TopicTimeGranularity
public void setDefaultFormatting(DefaultFormatting defaultFormatting)
The default formatting definition.
defaultFormatting
- The default formatting definition.public DefaultFormatting getDefaultFormatting()
The default formatting definition.
public TopicCalculatedField withDefaultFormatting(DefaultFormatting defaultFormatting)
The default formatting definition.
defaultFormatting
- The default formatting definition.public void setAggregation(String aggregation)
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
aggregation
- The default aggregation. Valid values for this structure are SUM
, MAX
,
MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.DefaultAggregation
public String getAggregation()
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
SUM
, MAX
,
MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.DefaultAggregation
public TopicCalculatedField withAggregation(String aggregation)
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
aggregation
- The default aggregation. Valid values for this structure are SUM
, MAX
,
MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.DefaultAggregation
public TopicCalculatedField withAggregation(DefaultAggregation aggregation)
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
aggregation
- The default aggregation. Valid values for this structure are SUM
, MAX
,
MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.DefaultAggregation
public void setComparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the calculated field when it's used in a comparative context.
comparativeOrder
- The order in which data is displayed for the calculated field when it's used in a comparative context.public ComparativeOrder getComparativeOrder()
The order in which data is displayed for the calculated field when it's used in a comparative context.
public TopicCalculatedField withComparativeOrder(ComparativeOrder comparativeOrder)
The order in which data is displayed for the calculated field when it's used in a comparative context.
comparativeOrder
- The order in which data is displayed for the calculated field when it's used in a comparative context.public void setSemanticType(SemanticType semanticType)
The semantic type.
semanticType
- The semantic type.public SemanticType getSemanticType()
The semantic type.
public TopicCalculatedField withSemanticType(SemanticType semanticType)
The semantic type.
semanticType
- The semantic type.public List<String> getAllowedAggregations()
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public void setAllowedAggregations(Collection<String> allowedAggregations)
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
allowedAggregations
- The list of aggregation types that are allowed for the calculated field. Valid values for this structure
are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withAllowedAggregations(String... allowedAggregations)
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedAggregations(java.util.Collection)
or withAllowedAggregations(java.util.Collection)
if you want to override the existing values.
allowedAggregations
- The list of aggregation types that are allowed for the calculated field. Valid values for this structure
are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withAllowedAggregations(Collection<String> allowedAggregations)
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
allowedAggregations
- The list of aggregation types that are allowed for the calculated field. Valid values for this structure
are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withAllowedAggregations(AuthorSpecifiedAggregation... allowedAggregations)
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
allowedAggregations
- The list of aggregation types that are allowed for the calculated field. Valid values for this structure
are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public List<String> getNotAllowedAggregations()
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public void setNotAllowedAggregations(Collection<String> notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
notAllowedAggregations
- The list of aggregation types that are not allowed for the calculated field. Valid values for this
structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withNotAllowedAggregations(String... notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
NOTE: This method appends the values to the existing list (if any). Use
setNotAllowedAggregations(java.util.Collection)
or
withNotAllowedAggregations(java.util.Collection)
if you want to override the existing values.
notAllowedAggregations
- The list of aggregation types that are not allowed for the calculated field. Valid values for this
structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withNotAllowedAggregations(Collection<String> notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
notAllowedAggregations
- The list of aggregation types that are not allowed for the calculated field. Valid values for this
structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public TopicCalculatedField withNotAllowedAggregations(AuthorSpecifiedAggregation... notAllowedAggregations)
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are
COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
,
SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
,
VARP
, and PERCENTILE
.
notAllowedAggregations
- The list of aggregation types that are not allowed for the calculated field. Valid values for this
structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
,
MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
,
VAR
, VARP
, and PERCENTILE
.AuthorSpecifiedAggregation
public void setNeverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to never aggregate calculated field in filters.
neverAggregateInFilter
- A Boolean value that indicates whether to never aggregate calculated field in filters.public Boolean getNeverAggregateInFilter()
A Boolean value that indicates whether to never aggregate calculated field in filters.
public TopicCalculatedField withNeverAggregateInFilter(Boolean neverAggregateInFilter)
A Boolean value that indicates whether to never aggregate calculated field in filters.
neverAggregateInFilter
- A Boolean value that indicates whether to never aggregate calculated field in filters.public Boolean isNeverAggregateInFilter()
A Boolean value that indicates whether to never aggregate calculated field in filters.
public List<CellValueSynonym> getCellValueSynonyms()
The other names or aliases for the calculated field cell value.
public void setCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the calculated field cell value.
cellValueSynonyms
- The other names or aliases for the calculated field cell value.public TopicCalculatedField withCellValueSynonyms(CellValueSynonym... cellValueSynonyms)
The other names or aliases for the calculated field cell value.
NOTE: This method appends the values to the existing list (if any). Use
setCellValueSynonyms(java.util.Collection)
or withCellValueSynonyms(java.util.Collection)
if
you want to override the existing values.
cellValueSynonyms
- The other names or aliases for the calculated field cell value.public TopicCalculatedField withCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
The other names or aliases for the calculated field cell value.
cellValueSynonyms
- The other names or aliases for the calculated field cell value.public void setNonAdditive(Boolean nonAdditive)
The non additive for the table style target.
nonAdditive
- The non additive for the table style target.public Boolean getNonAdditive()
The non additive for the table style target.
public TopicCalculatedField withNonAdditive(Boolean nonAdditive)
The non additive for the table style target.
nonAdditive
- The non additive for the table style target.public Boolean isNonAdditive()
The non additive for the table style target.
public String toString()
toString
in class Object
Object.toString()
public TopicCalculatedField clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.