Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RunbookSummary

Summary of the Runbook.

Properties

compartmentId

compartmentId: string

OCID of the compartment to which the resource belongs to.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

Optional estimatedTime

estimatedTime: undefined | string

Estimated time to successfully complete the runbook execution

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the resource.

isDefault

isDefault: boolean

Is the runbook default?

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

lifecycleState

lifecycleState: string

The current state of the Runbook.

operation

operation: string

The lifecycle operation performed by the task.

osType

osType: OsType

The OS type for the runbook.

platform

platform: string

The platform of the runbook.

Optional resourceRegion

resourceRegion: undefined | string

Associated region

runbookRelevance

runbookRelevance: string

Type of runbook structure.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

type

type: string

The type of the runbook.

Functions

getDeserializedJsonObj

getJsonObj