Package com.oracle.bmc.fleetappsmanagement.model

Class Runbook

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public final class Runbook
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Runbook definition.

    Runbooks allow you to capture procedural tasks for handling a workflow.
    Note: Objects should always be created or deserialized using the Runbook.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 Runbook.Builder, which maintain a set of all explicitly set fields called Runbook.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()
        The OCID of the resource.
        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.

        Example: My new resource

        Returns:
        the value

      • getDescription

        public String getDescription()
        A user-friendly description.

        To provide some insight about the resource. Avoid entering confidential information.

        Returns:
        the value

      • getType

        public Runbook.Type getType()
        The type of the runbook.
        Returns:
        the value

      • getRunbookRelevance

        public Runbook.RunbookRelevance getRunbookRelevance()
        Relevance of the runbook.
        Returns:
        the value

      • getOperation

        public String getOperation()
        The lifecycle operation performed by the runbook.
        Returns:
        the value

      • getOsType

        public OsType getOsType()
        The OS type for the runbook.
        Returns:
        the value

      • getPlatform

        public String getPlatform()
        The platform of the runbook.
        Returns:
        the value

      • getIsDefault

        public Boolean getIsDefault()
        Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
        Returns:
        the value

      • getEstimatedTime

        public String getEstimatedTime()
        Estimated time to successfully complete the runbook execution.
        Returns:
        the value

      • getLifecycleState

        public Runbook.LifecycleState getLifecycleState()
        The current state of the Runbook.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

        For example, can be used to provide actionable information for a resource in Failed state.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time this resource was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time this resource was last updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        OCID of the compartment to which the resource belongs to.
        Returns:
        the value

      • getResourceRegion

        public String getResourceRegion()
        Associated region
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        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. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “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