software.amazon.awssdk.services.quicksight.model

Class TemplateVersion

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TemplateVersion

All Implemented Interfaces:

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

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

A version of a template.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TemplateVersion.Builder

Method Summary

Modifier and Type	Method and Description
static TemplateVersion.Builder	builder()
Instant	createdTime() The time that this template version was created.
List<DataSetConfiguration>	dataSetConfigurations() Schema of the dataset identified by the placeholder.
String	description() The description of the template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<TemplateError>	errors() Errors associated with this template version.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataSetConfigurations() For responses, this returns true if the service returned a value for the DataSetConfigurations property.
boolean	hasErrors() For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
boolean	hasSheets() For responses, this returns true if the service returned a value for the Sheets property.
List<SdkField<?>>	sdkFields()
static Class<? extends TemplateVersion.Builder>	serializableBuilderClass()
List<Sheet>	sheets() A list of the associated sheets with the unique identifier and name of each sheet.
String	sourceEntityArn() The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
ResourceStatus	status() The status that is associated with the template.
String	statusAsString() The status that is associated with the template.
String	themeArn() The ARN of the theme associated with this version of the template.
TemplateVersion.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	versionNumber() The version number of the template version.

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

createdTime

public final Instant createdTime()

The time that this template version was created.

Returns:

The time that this template version was created.

hasErrors

public final boolean hasErrors()

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

errors

public final List<TemplateError> errors()

Errors associated with this template version.

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

Returns:

Errors associated with this template version.

versionNumber

public final Long versionNumber()

The version number of the template version.

Returns:

The version number of the template version.

status

public final ResourceStatus status()

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

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

Returns:

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

See Also:

ResourceStatus

statusAsString

public final String statusAsString()

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

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

Returns:

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

See Also:

ResourceStatus

hasDataSetConfigurations

public final boolean hasDataSetConfigurations()

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

dataSetConfigurations

public final List<DataSetConfiguration> dataSetConfigurations()

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

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

Returns:

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

description

public final String description()

The description of the template.

Returns:

The description of the template.

sourceEntityArn

public final String sourceEntityArn()

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

Returns:

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

themeArn

public final String themeArn()

The ARN of the theme associated with this version of the template.

Returns:

The ARN of the theme associated with this version of the template.

hasSheets

public final boolean hasSheets()

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

sheets

public final List<Sheet> sheets()

A list of the associated sheets with the unique identifier and name of each sheet.

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

Returns:

A list of the associated sheets with the unique identifier and name of each sheet.

toBuilder

public TemplateVersion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TemplateVersion.Builder,TemplateVersion>

builder

public static TemplateVersion.Builder builder()

serializableBuilderClass

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