Class Template

java.lang.Object
software.amazon.awssdk.services.quicksight.model.Template
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Template.Builder,Template>
@Generated("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 Amazon 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 an 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 Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the template.

      Returns:
      The Amazon Resource Name (ARN) of the template.

    • name

      public final String name()

      The display name of the template.

      Returns:
      The display name of the template.

    • version

      public final TemplateVersion version()

      A structure describing the versions of the template.

      Returns:
      A structure describing the versions of the template.

    • templateId

      public final String templateId()

      The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

      Returns:
      The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      Time when this was last updated.

      Returns:
      Time when this was last updated.

    • createdTime

      public final Instant createdTime()

      Time when this was created.

      Returns:
      Time when this was created.

    • toBuilder

      public Template.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Template.Builder,Template>
      Returns:
      a builder for type T

    • builder

      public static Template.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Template.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.