Class NamedEntityDefinition

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

A structure that represents a named entity.

See Also:

  • Method Details

    • fieldName

      public final String fieldName()

      The name of the entity.

      Returns:
      The name of the entity.

    • propertyName

      public final String propertyName()

      The property name to be used for the named entity.

      Returns:
      The property name to be used for the named entity.

    • propertyRole

      public final PropertyRole propertyRole()

      The property role. Valid values for this structure are PRIMARY and ID.

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

      Returns:
      The property role. Valid values for this structure are PRIMARY and ID.
      See Also:

    • propertyRoleAsString

      public final String propertyRoleAsString()

      The property role. Valid values for this structure are PRIMARY and ID.

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

      Returns:
      The property role. Valid values for this structure are PRIMARY and ID.
      See Also:

    • propertyUsage

      public final PropertyUsage propertyUsage()

      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

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

      Returns:
      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
      See Also:

    • propertyUsageAsString

      public final String propertyUsageAsString()

      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

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

      Returns:
      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
      See Also:

    • metric

      public final NamedEntityDefinitionMetric metric()

      The definition of a metric.

      Returns:
      The definition of a metric.

    • rankOrder

      public final Integer rankOrder()

      The rank order of the named entity definition.

      Returns:
      The rank order of the named entity definition.

    • presentationOrder

      public final Integer presentationOrder()

      The presentation order of the named entity definition.

      Returns:
      The presentation order of the named entity definition.

    • isHidden

      public final Boolean isHidden()

      A Boolean value that indicates whether the named entity definition is hidden.

      Returns:
      A Boolean value that indicates whether the named entity definition is hidden.

    • toBuilder

      public NamedEntityDefinition.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<NamedEntityDefinition.Builder,NamedEntityDefinition>
      Returns:
      a builder for type T

    • builder

      public static NamedEntityDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NamedEntityDefinition.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.