Package com.oracle.bmc.resourcemanager.model

Class Template

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180917")
public final class Template
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The properties that define a template.

    A template is a pre-built Terraform configuration that provisions a set of resources used in a common scenario.
    Note: Objects should always be created or deserialized using the Template.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Template.Builder, which maintain a set of all explicitly set fields called Template.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        Unique identifier (OCID) for the template.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing this template.
        Returns:
        the value

      • getCategoryId

        public String getCategoryId()
        Unique identifier for the category where the template is located.

        Possible values are 0 (Quick Starts), 1 (Service), 2 (Architecture), and 3 (Private).

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Brief description of the template.
        Returns:
        the value

      • getLongDescription

        public String getLongDescription()
        Detailed description of the template.

        This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information.

        Returns:
        the value

      • getIsFreeTier

        public Boolean getIsFreeTier()
        whether the template will work for free tier tenancy.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time at which the template was created.

        Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public Template.LifecycleState getLifecycleState()
        The current lifecycle state of the template.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags associated with the resource.

        Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        The system tags associated with this resource, if any.

        The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel