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

Class 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:
    Serialized Form

    • Method Detail

      • 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)