software.amazon.awssdk.services.quicksight.model

Class Template

java.lang.Object

software.amazon.awssdk.services.quicksight.model.Template

All Implemented Interfaces:

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

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

A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Template.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the template.
static Template.Builder	builder()
Instant	createdTime() Time when this was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime() Time when this was last updated.
String	name() The display name of the template.
List<SdkField<?>>	sdkFields()
static Class<? extends Template.Builder>	serializableBuilderClass()
String	templateId() The ID for the template.
Template.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TemplateVersion	version() A structure describing the versions of the template.

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

arn

public String arn()

The Amazon Resource Name (ARN) of the template.

Returns:

The Amazon Resource Name (ARN) of the template.

name

public String name()

The display name of the template.

Returns:

The display name of the template.

version

public TemplateVersion version()

A structure describing the versions of the template.

Returns:

A structure describing the versions of the template.

templateId

public String templateId()

The ID for the template. This is unique per AWS Region for each AWS account.

Returns:

The ID for the template. This is unique per AWS Region for each AWS account.

lastUpdatedTime

public Instant lastUpdatedTime()

Time when this was last updated.

Returns:

Time when this was last updated.

createdTime

public Instant createdTime()

Time when this was created.

Returns:

Time when this was created.

toBuilder

public Template.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Template.Builder,Template>

builder

public static Template.Builder builder()

serializableBuilderClass

public static Class<? extends Template.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo