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

Class TopicDetails

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TopicDetails

All Implemented Interfaces:

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

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

A structure that describes the details of a topic, such as its name, description, and associated data sets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopicDetails.Builder

Method Summary

Modifier and Type	Method	Description
static TopicDetails.Builder	builder()
TopicConfigOptions	configOptions()	Configuration options for a Topic.
List<DatasetMetadata>	dataSets()	The data sets that the topic is associated with.
String	description()	The description of the topic.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataSets()	For responses, this returns true if the service returned a value for the DataSets property.
int	hashCode()
String	name()	The name of the topic.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TopicDetails.Builder>	serializableBuilderClass()
TopicDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TopicUserExperienceVersion	userExperienceVersion()	The user experience version of a topic.
String	userExperienceVersionAsString()	The user experience version of a topic.

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

name

public final String name()

The name of the topic.

Returns:

The name of the topic.

description

public final String description()

The description of the topic.

Returns:

The description of the topic.

userExperienceVersion

public final TopicUserExperienceVersion userExperienceVersion()

The user experience version of a topic.

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

Returns:

The user experience version of a topic.

See Also:

TopicUserExperienceVersion

userExperienceVersionAsString

public final String userExperienceVersionAsString()

The user experience version of a topic.

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

Returns:

The user experience version of a topic.

See Also:

TopicUserExperienceVersion

hasDataSets

public final boolean hasDataSets()

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

dataSets

public final List<DatasetMetadata> dataSets()

The data sets that the topic is associated with.

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

Returns:

The data sets that the topic is associated with.

configOptions

public final TopicConfigOptions configOptions()

Configuration options for a Topic.

Returns:

Configuration options for a Topic.

toBuilder

public TopicDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicDetails.Builder,TopicDetails>

builder

public static TopicDetails.Builder builder()

serializableBuilderClass

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