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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamedEntityDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static NamedEntityDefinition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldName()	The name of the entity.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NamedEntityDefinitionMetric	metric()	The definition of a metric.
String	propertyName()	The property name to be used for the named entity.
PropertyRole	propertyRole()	The property role.
String	propertyRoleAsString()	The property role.
PropertyUsage	propertyUsage()	The property usage.
String	propertyUsageAsString()	The property usage.
List<SdkField<?>>	sdkFields()
static Class<? extends NamedEntityDefinition.Builder>	serializableBuilderClass()
NamedEntityDefinition.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

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:

PropertyRole

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:

PropertyRole

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:

PropertyUsage

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:

PropertyUsage

metric

public final NamedEntityDefinitionMetric metric()

The definition of a metric.

Returns:

The definition of a metric.

toBuilder

public NamedEntityDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NamedEntityDefinition.Builder,NamedEntityDefinition>

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)

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