Class Runbook

Runbook definition. Runbooks allow you to capture procedural tasks for handling a workflow. Only active versions of runbook will be available for executions.

Inheritance

object

Runbook

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FleetappsmanagementService.Models

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class Runbook

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	OCID of the compartment to which the resource belongs to.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

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

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

Remarks

Required

EstimatedTime

Declaration

[JsonProperty(PropertyName = "estimatedTime")]
public string EstimatedTime { get; set; }

Property Value

Type	Description
string	Estimated time to successfully complete the runbook execution.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HasDraftVersion

Declaration

[JsonProperty(PropertyName = "hasDraftVersion")]
public bool? HasDraftVersion { get; set; }

Property Value

Type	Description
bool?	Does this runbook has draft versions?

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the resource.

Remarks

Required

IsDefault

Declaration

[Required(ErrorMessage = "IsDefault is required.")]
[JsonProperty(PropertyName = "isDefault")]
public bool? IsDefault { get; set; }

Property Value

Type	Description
bool?	Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.

Remarks

Required

IsSudoAccessNeeded

Declaration

[JsonProperty(PropertyName = "isSudoAccessNeeded")]
public bool? IsSudoAccessNeeded { get; set; }

Property Value

Type	Description
bool?	Does this runbook need SUDO access to execute?

LatestVersion

Declaration

[JsonProperty(PropertyName = "latestVersion")]
public string LatestVersion { get; set; }

Property Value

Type	Description
string	Latest runbook version

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
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

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Runbook.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Runbook.LifecycleStateEnum?	The current state of the runbook.

Remarks

Required

Operation

Declaration

[Required(ErrorMessage = "Operation is required.")]
[JsonProperty(PropertyName = "operation")]
public string Operation { get; set; }

Property Value

Type	Description
string	The lifecycle operation performed by the runbook.

Remarks

Required

OsType

Declaration

[JsonProperty(PropertyName = "osType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OsType? OsType { get; set; }

Property Value

Type	Description
OsType?	The OS type for the runbook.

Platform

Declaration

[JsonProperty(PropertyName = "platform")]
public string Platform { get; set; }

Property Value

Type	Description
string	The platform of the runbook.

ResourceRegion

Declaration

[JsonProperty(PropertyName = "resourceRegion")]
public string ResourceRegion { get; set; }

Property Value

Type	Description
string	Associated region

RunbookVersion

Declaration

[JsonProperty(PropertyName = "runbookVersion")]
public Version RunbookVersion { get; set; }

Property Value

Type	Description
Version

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was last updated. An RFC3339 formatted datetime string.

Remarks

Required

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Runbook.TypeEnum? Type { get; set; }

Property Value

Type	Description
Runbook.TypeEnum?	The type of the runbook.

Remarks

Required