RunbookSummary¶

class oci.fleet_apps_management.models.RunbookSummary(**kwargs)¶

Bases: object

Summary of the Runbook.

Attributes

`OS_TYPE_GENERIC`	A constant which can be used with the os_type property of a RunbookSummary.
`OS_TYPE_LINUX`	A constant which can be used with the os_type property of a RunbookSummary.
`OS_TYPE_WINDOWS`	A constant which can be used with the os_type property of a RunbookSummary.
`compartment_id`	[Required] Gets the compartment_id of this RunbookSummary.
`defined_tags`	Gets the defined_tags of this RunbookSummary.
`description`	Gets the description of this RunbookSummary.
`display_name`	[Required] Gets the display_name of this RunbookSummary.
`estimated_time`	Gets the estimated_time of this RunbookSummary.
`freeform_tags`	Gets the freeform_tags of this RunbookSummary.
`id`	[Required] Gets the id of this RunbookSummary.
`is_default`	[Required] Gets the is_default of this RunbookSummary.
`lifecycle_details`	Gets the lifecycle_details of this RunbookSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RunbookSummary.
`operation`	[Required] Gets the operation of this RunbookSummary.
`os_type`	[Required] Gets the os_type of this RunbookSummary.
`platform`	[Required] Gets the platform of this RunbookSummary.
`resource_region`	Gets the resource_region of this RunbookSummary.
`runbook_relevance`	[Required] Gets the runbook_relevance of this RunbookSummary.
`system_tags`	Gets the system_tags of this RunbookSummary.
`time_created`	[Required] Gets the time_created of this RunbookSummary.
`time_updated`	[Required] Gets the time_updated of this RunbookSummary.
`type`	[Required] Gets the type of this RunbookSummary.

Methods

__init__(**kwargs) Initializes a new RunbookSummary object with values from keyword arguments.

OS_TYPE_GENERIC = 'GENERIC'¶: A constant which can be used with the os_type property of a RunbookSummary. This constant has a value of “GENERIC”

OS_TYPE_LINUX = 'LINUX'¶: A constant which can be used with the os_type property of a RunbookSummary. This constant has a value of “LINUX”

OS_TYPE_WINDOWS = 'WINDOWS'¶: A constant which can be used with the os_type property of a RunbookSummary. This constant has a value of “WINDOWS”

__init__(**kwargs)¶

Initializes a new RunbookSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this RunbookSummary.
display_name (str) – The value to assign to the display_name property of this RunbookSummary.
description (str) – The value to assign to the description property of this RunbookSummary.
type (str) – The value to assign to the type property of this RunbookSummary.
runbook_relevance (str) – The value to assign to the runbook_relevance property of this RunbookSummary.
operation (str) – The value to assign to the operation property of this RunbookSummary.
os_type (str) – The value to assign to the os_type property of this RunbookSummary. Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
platform (str) – The value to assign to the platform property of this RunbookSummary.
is_default (bool) – The value to assign to the is_default property of this RunbookSummary.
estimated_time (str) – The value to assign to the estimated_time property of this RunbookSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RunbookSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this RunbookSummary.
time_created (datetime) – The value to assign to the time_created property of this RunbookSummary.
time_updated (datetime) – The value to assign to the time_updated property of this RunbookSummary.
compartment_id (str) – The value to assign to the compartment_id property of this RunbookSummary.
resource_region (str) – The value to assign to the resource_region property of this RunbookSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RunbookSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RunbookSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RunbookSummary.

compartment_id¶

[Required] Gets the compartment_id of this RunbookSummary. OCID of the compartment to which the resource belongs to.

Returns:	The compartment_id of this RunbookSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this RunbookSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this RunbookSummary.
Return type:	dict(str, dict(str, object))

description¶

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

Returns:	The description of this RunbookSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this RunbookSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns:	The display_name of this RunbookSummary.
Return type:	str

estimated_time¶

Gets the estimated_time of this RunbookSummary. Estimated time to successfully complete the runbook execution.

Returns:	The estimated_time of this RunbookSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this RunbookSummary. 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 freeform_tags of this RunbookSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this RunbookSummary. The OCID of the resource.

Returns:	The id of this RunbookSummary.
Return type:	str

is_default¶

[Required] Gets the is_default of this RunbookSummary. Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.

Returns:	The is_default of this RunbookSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this RunbookSummary. 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 lifecycle_details of this RunbookSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this RunbookSummary. The current state of the Runbook.

Returns:	The lifecycle_state of this RunbookSummary.
Return type:	str

operation¶

[Required] Gets the operation of this RunbookSummary. The lifecycle operation performed by the runbook.

Returns:	The operation of this RunbookSummary.
Return type:	str

os_type¶

[Required] Gets the os_type of this RunbookSummary. The OS type for the runbook.

Allowed values for this property are: “WINDOWS”, “LINUX”, “GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The os_type of this RunbookSummary.
Return type:	str

platform¶

[Required] Gets the platform of this RunbookSummary. The platform of the runbook.

Returns:	The platform of this RunbookSummary.
Return type:	str

resource_region¶

Gets the resource_region of this RunbookSummary. Associated region

Returns:	The resource_region of this RunbookSummary.
Return type:	str

runbook_relevance¶

[Required] Gets the runbook_relevance of this RunbookSummary. Type of runbook structure.

Returns:	The runbook_relevance of this RunbookSummary.
Return type:	str

system_tags¶

Gets the system_tags of this RunbookSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this RunbookSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this RunbookSummary. The time this resource was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this RunbookSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this RunbookSummary. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this RunbookSummary.
Return type:	datetime

type¶

[Required] Gets the type of this RunbookSummary. The type of the runbook.

Returns:	The type of this RunbookSummary.
Return type:	str