TopicCalculatedField (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.TopicCalculatedField

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@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.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicCalculatedField()

Constructors
Constructor and Description
`TopicCalculatedField()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`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`	`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`	`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TopicCalculatedField
```
public TopicCalculatedField()
```
- Method Detail
  - setCalculatedFieldName
```
public void setCalculatedFieldName(String calculatedFieldName)
```
    The calculated field name.
    
    Parameters:
    
    calculatedFieldName - The calculated field name.
  - getCalculatedFieldName
```
public String getCalculatedFieldName()
```
    The calculated field name.
    
    Returns:
    
    The calculated field name.
  - withCalculatedFieldName
```
public TopicCalculatedField withCalculatedFieldName(String calculatedFieldName)
```
    The calculated field name.
    
    Parameters:
    
    calculatedFieldName - The calculated field name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCalculatedFieldDescription
```
public void setCalculatedFieldDescription(String calculatedFieldDescription)
```
    The calculated field description.
    
    Parameters:
    
    calculatedFieldDescription - The calculated field description.
  - getCalculatedFieldDescription
```
public String getCalculatedFieldDescription()
```
    The calculated field description.
    
    Returns:
    
    The calculated field description.
  - withCalculatedFieldDescription
```
public TopicCalculatedField withCalculatedFieldDescription(String calculatedFieldDescription)
```
    The calculated field description.
    
    Parameters:
    
    calculatedFieldDescription - The calculated field description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpression
```
public void setExpression(String expression)
```
    The calculated field expression.
    
    Parameters:
    
    expression - The calculated field expression.
  - getExpression
```
public String getExpression()
```
    The calculated field expression.
    
    Returns:
    
    The calculated field expression.
  - withExpression
```
public TopicCalculatedField withExpression(String expression)
```
    The calculated field expression.
    
    Parameters:
    
    expression - The calculated field expression.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCalculatedFieldSynonyms
```
public List<String> getCalculatedFieldSynonyms()
```
    The other names or aliases for the calculated field.
    
    Returns:
    
    The other names or aliases for the calculated field.
  - setCalculatedFieldSynonyms
```
public void setCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
```
    The other names or aliases for the calculated field.
    
    Parameters:
    
    calculatedFieldSynonyms - The other names or aliases for the calculated field.
  - withCalculatedFieldSynonyms
```
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.
    
    Parameters:
    
    calculatedFieldSynonyms - The other names or aliases for the calculated field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCalculatedFieldSynonyms
```
public TopicCalculatedField withCalculatedFieldSynonyms(Collection<String> calculatedFieldSynonyms)
```
    The other names or aliases for the calculated field.
    
    Parameters:
    
    calculatedFieldSynonyms - The other names or aliases for the calculated field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsIncludedInTopic
```
public void setIsIncludedInTopic(Boolean isIncludedInTopic)
```
    A boolean value that indicates if a calculated field is included in the topic.
    
    Parameters:
    
    isIncludedInTopic - A boolean value that indicates if a calculated field is included in the topic.
  - getIsIncludedInTopic
```
public Boolean getIsIncludedInTopic()
```
    A boolean value that indicates if a calculated field is included in the topic.
    
    Returns:
    
    A boolean value that indicates if a calculated field is included in the topic.
  - withIsIncludedInTopic
```
public TopicCalculatedField withIsIncludedInTopic(Boolean isIncludedInTopic)
```
    A boolean value that indicates if a calculated field is included in the topic.
    
    Parameters:
    
    isIncludedInTopic - A boolean value that indicates if a calculated field is included in the topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludedInTopic
```
public Boolean isIncludedInTopic()
```
    A boolean value that indicates if a calculated field is included in the topic.
    
    Returns:
    
    A boolean value that indicates if a calculated field is included in the topic.
  - setDisableIndexing
```
public void setDisableIndexing(Boolean disableIndexing)
```
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
    
    Parameters:
    
    disableIndexing - A Boolean value that indicates if a calculated field is visible in the autocomplete.
  - getDisableIndexing
```
public Boolean getDisableIndexing()
```
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
    
    Returns:
    
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
  - withDisableIndexing
```
public TopicCalculatedField withDisableIndexing(Boolean disableIndexing)
```
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
    
    Parameters:
    
    disableIndexing - A Boolean value that indicates if a calculated field is visible in the autocomplete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisableIndexing
```
public Boolean isDisableIndexing()
```
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
    
    Returns:
    
    A Boolean value that indicates if a calculated field is visible in the autocomplete.
  - setColumnDataRole
```
public void setColumnDataRole(String columnDataRole)
```
    The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Parameters:
    
    columnDataRole - The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    See Also:
    
    ColumnDataRole
  - getColumnDataRole
```
public String getColumnDataRole()
```
    The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Returns:
    
    The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    See Also:
    
    ColumnDataRole
  - withColumnDataRole
```
public TopicCalculatedField withColumnDataRole(String columnDataRole)
```
    The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Parameters:
    
    columnDataRole - The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ColumnDataRole
  - withColumnDataRole
```
public TopicCalculatedField withColumnDataRole(ColumnDataRole columnDataRole)
```
    The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Parameters:
    
    columnDataRole - The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ColumnDataRole
  - setTimeGranularity
```
public void setTimeGranularity(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 aggregate DateTime values.
    
    See Also:
    
    TopicTimeGranularity
  - getTimeGranularity
```
public String getTimeGranularity()
```
    The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    The level of time precision that is used to aggregate DateTime values.
    
    See Also:
    
    TopicTimeGranularity
  - withTimeGranularity
```
public TopicCalculatedField withTimeGranularity(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 aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TopicTimeGranularity
  - withTimeGranularity
```
public TopicCalculatedField withTimeGranularity(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 aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TopicTimeGranularity
  - setDefaultFormatting
```
public void setDefaultFormatting(DefaultFormatting defaultFormatting)
```
    The default formatting definition.
    
    Parameters:
    
    defaultFormatting - The default formatting definition.
  - getDefaultFormatting
```
public DefaultFormatting getDefaultFormatting()
```
    The default formatting definition.
    
    Returns:
    
    The default formatting definition.
  - withDefaultFormatting
```
public TopicCalculatedField withDefaultFormatting(DefaultFormatting defaultFormatting)
```
    The default formatting definition.
    
    Parameters:
    
    defaultFormatting - The default formatting definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAggregation
```
public void setAggregation(String aggregation)
```
    The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Parameters:
    
    aggregation - The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    See Also:
    
    DefaultAggregation
  - getAggregation
```
public String getAggregation()
```
    The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Returns:
    
    The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    See Also:
    
    DefaultAggregation
  - withAggregation
```
public TopicCalculatedField withAggregation(String aggregation)
```
    The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Parameters:
    
    aggregation - The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultAggregation
  - withAggregation
```
public TopicCalculatedField withAggregation(DefaultAggregation aggregation)
```
    The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Parameters:
    
    aggregation - The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultAggregation
  - setComparativeOrder
```
public void setComparativeOrder(ComparativeOrder comparativeOrder)
```
    The order in which data is displayed for the calculated field when it's used in a comparative context.
    
    Parameters:
    
    comparativeOrder - The order in which data is displayed for the calculated field when it's used in a comparative context.
  - getComparativeOrder
```
public ComparativeOrder getComparativeOrder()
```
    The order in which data is displayed for the calculated field when it's used in a comparative context.
    
    Returns:
    
    The order in which data is displayed for the calculated field when it's used in a comparative context.
  - withComparativeOrder
```
public TopicCalculatedField withComparativeOrder(ComparativeOrder comparativeOrder)
```
    The order in which data is displayed for the calculated field when it's used in a comparative context.
    
    Parameters:
    
    comparativeOrder - The order in which data is displayed for the calculated field when it's used in a comparative context.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSemanticType
```
public void setSemanticType(SemanticType semanticType)
```
    The semantic type.
    
    Parameters:
    
    semanticType - The semantic type.
  - getSemanticType
```
public SemanticType getSemanticType()
```
    The semantic type.
    
    Returns:
    
    The semantic type.
  - withSemanticType
```
public TopicCalculatedField withSemanticType(SemanticType semanticType)
```
    The semantic type.
    
    Parameters:
    
    semanticType - The semantic type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowedAggregations
```
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.
    
    Returns:
    
    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.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - setAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - getNotAllowedAggregations
```
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.
    
    Returns:
    
    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.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - setNotAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withNotAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withNotAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - withNotAllowedAggregations
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorSpecifiedAggregation
  - setNeverAggregateInFilter
```
public void setNeverAggregateInFilter(Boolean neverAggregateInFilter)
```
    A Boolean value that indicates whether to never aggregate calculated field in filters.
    
    Parameters:
    
    neverAggregateInFilter - A Boolean value that indicates whether to never aggregate calculated field in filters.
  - getNeverAggregateInFilter
```
public Boolean getNeverAggregateInFilter()
```
    A Boolean value that indicates whether to never aggregate calculated field in filters.
    
    Returns:
    
    A Boolean value that indicates whether to never aggregate calculated field in filters.
  - withNeverAggregateInFilter
```
public TopicCalculatedField withNeverAggregateInFilter(Boolean neverAggregateInFilter)
```
    A Boolean value that indicates whether to never aggregate calculated field in filters.
    
    Parameters:
    
    neverAggregateInFilter - A Boolean value that indicates whether to never aggregate calculated field in filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNeverAggregateInFilter
```
public Boolean isNeverAggregateInFilter()
```
    A Boolean value that indicates whether to never aggregate calculated field in filters.
    
    Returns:
    
    A Boolean value that indicates whether to never aggregate calculated field in filters.
  - getCellValueSynonyms
```
public List<CellValueSynonym> getCellValueSynonyms()
```
    The other names or aliases for the calculated field cell value.
    
    Returns:
    
    The other names or aliases for the calculated field cell value.
  - setCellValueSynonyms
```
public void setCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
```
    The other names or aliases for the calculated field cell value.
    
    Parameters:
    
    cellValueSynonyms - The other names or aliases for the calculated field cell value.
  - withCellValueSynonyms
```
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.
    
    Parameters:
    
    cellValueSynonyms - The other names or aliases for the calculated field cell value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCellValueSynonyms
```
public TopicCalculatedField withCellValueSynonyms(Collection<CellValueSynonym> cellValueSynonyms)
```
    The other names or aliases for the calculated field cell value.
    
    Parameters:
    
    cellValueSynonyms - The other names or aliases for the calculated field cell value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TopicCalculatedField clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TopicCalculatedField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicCalculatedField

Method Detail

setCalculatedFieldName

getCalculatedFieldName

withCalculatedFieldName

setCalculatedFieldDescription

getCalculatedFieldDescription

withCalculatedFieldDescription

setExpression

getExpression

withExpression

getCalculatedFieldSynonyms

setCalculatedFieldSynonyms

withCalculatedFieldSynonyms

withCalculatedFieldSynonyms

setIsIncludedInTopic

getIsIncludedInTopic

withIsIncludedInTopic

isIncludedInTopic

setDisableIndexing

getDisableIndexing

withDisableIndexing

isDisableIndexing

setColumnDataRole

getColumnDataRole

withColumnDataRole

withColumnDataRole

setTimeGranularity

getTimeGranularity

withTimeGranularity

withTimeGranularity

setDefaultFormatting

getDefaultFormatting

withDefaultFormatting

setAggregation

getAggregation

withAggregation

withAggregation

setComparativeOrder

getComparativeOrder

withComparativeOrder

setSemanticType

getSemanticType

withSemanticType

getAllowedAggregations

setAllowedAggregations

withAllowedAggregations

withAllowedAggregations

withAllowedAggregations

getNotAllowedAggregations

setNotAllowedAggregations

withNotAllowedAggregations

withNotAllowedAggregations

withNotAllowedAggregations

setNeverAggregateInFilter

getNeverAggregateInFilter

withNeverAggregateInFilter

isNeverAggregateInFilter

getCellValueSynonyms

setCellValueSynonyms

withCellValueSynonyms

withCellValueSynonyms

toString

equals

hashCode

clone

marshall