Class Runbook.Builder

  • Enclosing class:
    Runbook

    public static class Runbook.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • id

        public Runbook.Builder id​(String id)
        The OCID of the resource.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • displayName

        public Runbook.Builder displayName​(String displayName)
        A user-friendly name.

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

        Example: My new resource

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • description

        public Runbook.Builder description​(String description)
        A user-friendly description.

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

        Parameters:
        description - the value to set
        Returns:
        this builder
      • type

        public Runbook.Builder type​(Runbook.Type type)
        The type of the runbook.
        Parameters:
        type - the value to set
        Returns:
        this builder
      • runbookRelevance

        public Runbook.Builder runbookRelevance​(Runbook.RunbookRelevance runbookRelevance)
        Relevance of the runbook.
        Parameters:
        runbookRelevance - the value to set
        Returns:
        this builder
      • operation

        public Runbook.Builder operation​(String operation)
        The lifecycle operation performed by the runbook.
        Parameters:
        operation - the value to set
        Returns:
        this builder
      • osType

        public Runbook.Builder osType​(OsType osType)
        The OS type for the runbook.
        Parameters:
        osType - the value to set
        Returns:
        this builder
      • platform

        public Runbook.Builder platform​(String platform)
        The platform of the runbook.
        Parameters:
        platform - the value to set
        Returns:
        this builder
      • isDefault

        public Runbook.Builder isDefault​(Boolean isDefault)
        Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
        Parameters:
        isDefault - the value to set
        Returns:
        this builder
      • estimatedTime

        public Runbook.Builder estimatedTime​(String estimatedTime)
        Estimated time to successfully complete the runbook execution.
        Parameters:
        estimatedTime - the value to set
        Returns:
        this builder
      • lifecycleState

        public Runbook.Builder lifecycleState​(Runbook.LifecycleState lifecycleState)
        The current state of the Runbook.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public Runbook.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state in more detail.

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

        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder
      • timeCreated

        public Runbook.Builder timeCreated​(Date timeCreated)
        The time this resource was created.

        An RFC3339 formatted datetime string.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • timeUpdated

        public Runbook.Builder timeUpdated​(Date timeUpdated)
        The time this resource was last updated.

        An RFC3339 formatted datetime string.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder
      • compartmentId

        public Runbook.Builder compartmentId​(String compartmentId)
        OCID of the compartment to which the resource belongs to.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • resourceRegion

        public Runbook.Builder resourceRegion​(String resourceRegion)
        Associated region
        Parameters:
        resourceRegion - the value to set
        Returns:
        this builder
      • freeformTags

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

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

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

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

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • systemTags

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

        Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder