Package software.amazon.awssdk.services.quicksight.model

Interface TopicCalculatedField.Builder

    • Method Detail

      • calculatedFieldName

        TopicCalculatedField.Builder calculatedFieldName​(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.

      • calculatedFieldDescription

        TopicCalculatedField.Builder calculatedFieldDescription​(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.

      • expression

        TopicCalculatedField.Builder expression​(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.

      • calculatedFieldSynonyms

        TopicCalculatedField.Builder calculatedFieldSynonyms​(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.

      • calculatedFieldSynonyms

        TopicCalculatedField.Builder calculatedFieldSynonyms​(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.

      • isIncludedInTopic

        TopicCalculatedField.Builder isIncludedInTopic​(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.

      • disableIndexing

        TopicCalculatedField.Builder disableIndexing​(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.

      • columnDataRole

        TopicCalculatedField.Builder columnDataRole​(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, ColumnDataRole

      • columnDataRole

        TopicCalculatedField.Builder columnDataRole​(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, ColumnDataRole

      • timeGranularity

        TopicCalculatedField.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 aggregate DateTime values.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TopicTimeGranularity, TopicTimeGranularity

      • defaultFormatting

        TopicCalculatedField.Builder defaultFormatting​(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.

      • aggregation

        TopicCalculatedField.Builder aggregation​(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, DefaultAggregation

      • aggregation

        TopicCalculatedField.Builder aggregation​(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, DefaultAggregation

      • comparativeOrder

        TopicCalculatedField.Builder comparativeOrder​(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.

      • semanticType

        TopicCalculatedField.Builder semanticType​(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.

      • allowedAggregationsWithStrings

        TopicCalculatedField.Builder allowedAggregationsWithStrings​(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.

      • allowedAggregationsWithStrings

        TopicCalculatedField.Builder allowedAggregationsWithStrings​(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.

      • allowedAggregations

        TopicCalculatedField.Builder allowedAggregations​(Collection<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.

      • allowedAggregations

        TopicCalculatedField.Builder allowedAggregations​(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.

      • notAllowedAggregationsWithStrings

        TopicCalculatedField.Builder notAllowedAggregationsWithStrings​(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.

      • notAllowedAggregationsWithStrings

        TopicCalculatedField.Builder notAllowedAggregationsWithStrings​(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.

      • notAllowedAggregations

        TopicCalculatedField.Builder notAllowedAggregations​(Collection<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.

      • notAllowedAggregations

        TopicCalculatedField.Builder notAllowedAggregations​(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.

      • neverAggregateInFilter

        TopicCalculatedField.Builder neverAggregateInFilter​(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.

      • cellValueSynonyms

        TopicCalculatedField.Builder cellValueSynonyms​(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.

      • cellValueSynonyms

        TopicCalculatedField.Builder cellValueSynonyms​(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.

      • nonAdditive

        TopicCalculatedField.Builder nonAdditive​(Boolean nonAdditive)

        The non additive for the table style target.

        Parameters:
        nonAdditive - The non additive for the table style target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.