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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TopicNamedEntity.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TopicNamedEntity.Builder`	`builder()`
`List<NamedEntityDefinition>`	`definition()`	The definition of a named entity.
`String`	`entityDescription()`	The description of the named entity.
`String`	`entityName()`	The name of the named entity.
`List<String>`	`entitySynonyms()`	The other names or aliases for the named entity.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDefinition()`	For responses, this returns true if the service returned a value for the Definition property.
`boolean`	`hasEntitySynonyms()`	For responses, this returns true if the service returned a value for the EntitySynonyms property.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`SemanticEntityType`	`semanticEntityType()`	The type of named entity that a topic represents.
`static Class<? extends TopicNamedEntity.Builder>`	`serializableBuilderClass()`
`TopicNamedEntity.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
  - toBuilder
```
public TopicNamedEntity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicNamedEntity.Builder,TopicNamedEntity>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TopicNamedEntity

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

entityName

entityDescription

hasEntitySynonyms

entitySynonyms

semanticEntityType

hasDefinition

definition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField