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

Class TopicVisual

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TopicVisual

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TopicVisual.Builder,TopicVisual>

@Generated("software.amazon.awssdk:codegen")
public final class TopicVisual
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TopicVisual.Builder,TopicVisual>

The definition for a TopicVisual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopicVisual.Builder

Method Summary

Modifier and Type	Method	Description
static TopicVisual.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupportingVisuals()	For responses, this returns true if the service returned a value for the SupportingVisuals property.
TopicIR	ir()	The ir for the TopicVisual.
VisualRole	role()	The role for the TopicVisual.
String	roleAsString()	The role for the TopicVisual.
List<SdkField<?>>	sdkFields()
static Class<? extends TopicVisual.Builder>	serializableBuilderClass()
List<TopicVisual>	supportingVisuals()	The supporting visuals for the TopicVisual.
TopicVisual.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	visualId()	The visual ID for the TopicVisual.

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

visualId

public final String visualId()

The visual ID for the TopicVisual.

Returns:

The visual ID for the TopicVisual.

role

public final VisualRole role()

The role for the TopicVisual.

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

Returns:

The role for the TopicVisual.

See Also:

VisualRole

roleAsString

public final String roleAsString()

The role for the TopicVisual.

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

Returns:

The role for the TopicVisual.

See Also:

VisualRole

ir

public final TopicIR ir()

The ir for the TopicVisual.

Returns:

The ir for the TopicVisual.

hasSupportingVisuals

public final boolean hasSupportingVisuals()

For responses, this returns true if the service returned a value for the SupportingVisuals 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.

supportingVisuals

public final List<TopicVisual> supportingVisuals()

The supporting visuals for the TopicVisual.

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

Returns:

The supporting visuals for the TopicVisual.

toBuilder

public TopicVisual.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicVisual.Builder,TopicVisual>

builder

public static TopicVisual.Builder builder()

serializableBuilderClass

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