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

Class TopicIRMetric

    • Method Detail

      • metricId

        public final Identifier metricId()

        The metric ID for the TopicIRMetric.

        Returns:
        The metric ID for the TopicIRMetric.

      • function

        public final AggFunction function()

        The function for the TopicIRMetric.

        Returns:
        The function for the TopicIRMetric.

      • hasOperands

        public final boolean hasOperands()
        For responses, this returns true if the service returned a value for the Operands 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.

      • operands

        public final List<Identifier> operands()

        The operands for the TopicIRMetric.

        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 hasOperands() method.

        Returns:
        The operands for the TopicIRMetric.

      • comparisonMethod

        public final TopicIRComparisonMethod comparisonMethod()

        The comparison method for the TopicIRMetric.

        Returns:
        The comparison method for the TopicIRMetric.

      • expression

        public final String expression()

        The expression for the TopicIRMetric.

        Returns:
        The expression for the TopicIRMetric.

      • hasCalculatedFieldReferences

        public final boolean hasCalculatedFieldReferences()
        For responses, this returns true if the service returned a value for the CalculatedFieldReferences 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.

      • calculatedFieldReferences

        public final List<Identifier> calculatedFieldReferences()

        The calculated field references for the TopicIRMetric.

        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 hasCalculatedFieldReferences() method.

        Returns:
        The calculated field references for the TopicIRMetric.

      • displayFormatAsString

        public final String displayFormatAsString()

        The display format for the TopicIRMetric.

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

        Returns:
        The display format for the TopicIRMetric.
        See Also:
        DisplayFormat

      • displayFormatOptions

        public final DisplayFormatOptions displayFormatOptions()
        Returns the value of the DisplayFormatOptions property for this object.
        Returns:
        The value of the DisplayFormatOptions property for this object.

      • namedEntity

        public final NamedEntityRef namedEntity()

        The named entity for the TopicIRMetric.

        Returns:
        The named entity for the TopicIRMetric.

      • hashCode

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

      • equals

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

      • 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)