Class TopicNamedEntity

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

A structure that represents a named entity.

See Also:

  • Method Details

    • entityName

      public final String entityName()

      The name of the named entity.

      Returns:
      The name of the named entity.

    • entityDescription

      public final String entityDescription()

      The description of the named entity.

      Returns:
      The description of the named entity.

    • hasEntitySynonyms

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

    • entitySynonyms

      public final List<String> entitySynonyms()

      The other names or aliases for the named entity.

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

      Returns:
      The other names or aliases for the named entity.

    • semanticEntityType

      public final SemanticEntityType semanticEntityType()

      The type of named entity that a topic represents.

      Returns:
      The type of named entity that a topic represents.

    • hasDefinition

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

    • definition

      public final List<NamedEntityDefinition> definition()

      The definition of a named entity.

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

      Returns:
      The definition of a named entity.

    • hasSort

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

    • sort

      public final List<NamedEntitySort> sort()

      The sort configuration of the named entity.

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

      Returns:
      The sort configuration of the named entity.

    • rankOrder

      public final Integer rankOrder()

      The rank order of the named entity.

      Returns:
      The rank order of the named entity.

    • presentationOrder

      public final Integer presentationOrder()

      The presentation order of the named entity.

      Returns:
      The presentation order of the named entity.

    • toBuilder

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

    • builder

      public static TopicNamedEntity.Builder builder()

    • serializableBuilderClass

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