Class TopicCalculatedField

java.lang.Object
software.amazon.awssdk.services.quicksight.model.TopicCalculatedField
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TopicCalculatedField.Builder,TopicCalculatedField>
@Generated("software.amazon.awssdk:codegen") public final class TopicCalculatedField extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TopicCalculatedField.Builder,TopicCalculatedField>

A structure that represents a calculated field.

See Also:

  • Method Details

    • calculatedFieldName

      public final String calculatedFieldName()

      The calculated field name.

      Returns:
      The calculated field name.

    • calculatedFieldDescription

      public final String calculatedFieldDescription()

      The calculated field description.

      Returns:
      The calculated field description.

    • expression

      public final String expression()

      The calculated field expression.

      Returns:
      The calculated field expression.

    • hasCalculatedFieldSynonyms

      public final boolean hasCalculatedFieldSynonyms()
      For responses, this returns true if the service returned a value for the CalculatedFieldSynonyms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • calculatedFieldSynonyms

      public final List<String> calculatedFieldSynonyms()

      The other names or aliases for the calculated field.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCalculatedFieldSynonyms() method.

      Returns:
      The other names or aliases for the calculated field.

    • isIncludedInTopic

      public final 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.

    • disableIndexing

      public final Boolean disableIndexing()

      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.

    • columnDataRole

      public final ColumnDataRole columnDataRole()

      The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

      If the service returns an enum value that is not available in the current SDK version, columnDataRole will return ColumnDataRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnDataRoleAsString().

      Returns:
      The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
      See Also:

    • columnDataRoleAsString

      public final String columnDataRoleAsString()

      The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

      If the service returns an enum value that is not available in the current SDK version, columnDataRole will return ColumnDataRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnDataRoleAsString().

      Returns:
      The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
      See Also:

    • timeGranularity

      public final TopicTimeGranularity timeGranularity()

      The level of time precision that is used to aggregate DateTime values.

      If the service returns an enum value that is not available in the current SDK version, timeGranularity will return TopicTimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeGranularityAsString().

      Returns:
      The level of time precision that is used to aggregate DateTime values.
      See Also:

    • timeGranularityAsString

      public final String timeGranularityAsString()

      The level of time precision that is used to aggregate DateTime values.

      If the service returns an enum value that is not available in the current SDK version, timeGranularity will return TopicTimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeGranularityAsString().

      Returns:
      The level of time precision that is used to aggregate DateTime values.
      See Also:

    • defaultFormatting

      public final DefaultFormatting defaultFormatting()

      The default formatting definition.

      Returns:
      The default formatting definition.

    • aggregation

      public final DefaultAggregation aggregation()

      The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

      If the service returns an enum value that is not available in the current SDK version, aggregation will return DefaultAggregation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().

      Returns:
      The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
      See Also:

    • aggregationAsString

      public final String aggregationAsString()

      The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

      If the service returns an enum value that is not available in the current SDK version, aggregation will return DefaultAggregation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().

      Returns:
      The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
      See Also:

    • comparativeOrder

      public final ComparativeOrder comparativeOrder()

      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.

    • semanticType

      public final SemanticType semanticType()

      The semantic type.

      Returns:
      The semantic type.

    • allowedAggregations

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedAggregations() method.

      Returns:
      The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

    • hasAllowedAggregations

      public final boolean hasAllowedAggregations()
      For responses, this returns true if the service returned a value for the AllowedAggregations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • allowedAggregationsAsStrings

      public final List<String> allowedAggregationsAsStrings()

      The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedAggregations() method.

      Returns:
      The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

    • notAllowedAggregations

      public final List<AuthorSpecifiedAggregation> notAllowedAggregations()

      The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotAllowedAggregations() method.

      Returns:
      The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

    • hasNotAllowedAggregations

      public final boolean hasNotAllowedAggregations()
      For responses, this returns true if the service returned a value for the NotAllowedAggregations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notAllowedAggregationsAsStrings

      public final List<String> notAllowedAggregationsAsStrings()

      The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotAllowedAggregations() method.

      Returns:
      The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

    • neverAggregateInFilter

      public final Boolean neverAggregateInFilter()

      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.

    • hasCellValueSynonyms

      public final boolean hasCellValueSynonyms()
      For responses, this returns true if the service returned a value for the CellValueSynonyms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • cellValueSynonyms

      public final List<CellValueSynonym> cellValueSynonyms()

      The other names or aliases for the calculated field cell value.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCellValueSynonyms() method.

      Returns:
      The other names or aliases for the calculated field cell value.

    • nonAdditive

      public final Boolean nonAdditive()

      The non additive for the table style target.

      Returns:
      The non additive for the table style target.

    • toBuilder

      public TopicCalculatedField.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TopicCalculatedField.Builder,TopicCalculatedField>
      Returns:
      a builder for type T

    • builder

      public static TopicCalculatedField.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TopicCalculatedField.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.