WorkRequestSummary

class oci.os_management.models.WorkRequestSummary(**kwargs)

Bases: object

A work request summary

Attributes

OPERATION_TYPE_INSTALL A constant which can be used with the operation_type property of a WorkRequestSummary.
OPERATION_TYPE_REMOVE A constant which can be used with the operation_type property of a WorkRequestSummary.
OPERATION_TYPE_UPDATE A constant which can be used with the operation_type property of a WorkRequestSummary.
OPERATION_TYPE_UPDATEALL A constant which can be used with the operation_type property of a WorkRequestSummary.
STATUS_ACCEPTED A constant which can be used with the status property of a WorkRequestSummary.
STATUS_CANCELED A constant which can be used with the status property of a WorkRequestSummary.
STATUS_CANCELLING A constant which can be used with the status property of a WorkRequestSummary.
STATUS_FAILED A constant which can be used with the status property of a WorkRequestSummary.
STATUS_IN_PROGRESS A constant which can be used with the status property of a WorkRequestSummary.
STATUS_SUCCEEDED A constant which can be used with the status property of a WorkRequestSummary.
compartment_id [Required] Gets the compartment_id of this WorkRequestSummary.
description Gets the description of this WorkRequestSummary.
id [Required] Gets the id of this WorkRequestSummary.
message Gets the message of this WorkRequestSummary.
operation_type [Required] Gets the operation_type of this WorkRequestSummary.
percent_complete Gets the percent_complete of this WorkRequestSummary.
status [Required] Gets the status of this WorkRequestSummary.
time_accepted [Required] Gets the time_accepted of this WorkRequestSummary.

Methods

__init__(**kwargs) Initializes a new WorkRequestSummary object with values from keyword arguments.
OPERATION_TYPE_INSTALL = 'INSTALL'

A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “INSTALL”

OPERATION_TYPE_REMOVE = 'REMOVE'

A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “REMOVE”

OPERATION_TYPE_UPDATE = 'UPDATE'

A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE”

OPERATION_TYPE_UPDATEALL = 'UPDATEALL'

A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATEALL”

STATUS_ACCEPTED = 'ACCEPTED'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “ACCEPTED”

STATUS_CANCELED = 'CANCELED'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELED”

STATUS_CANCELLING = 'CANCELLING'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELLING”

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “IN_PROGRESS”

STATUS_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

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

Parameters:
  • operation_type (str) – The value to assign to the operation_type property of this WorkRequestSummary. Allowed values for this property are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • status (str) – The value to assign to the status property of this WorkRequestSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELLING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • id (str) – The value to assign to the id property of this WorkRequestSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this WorkRequestSummary.
  • description (str) – The value to assign to the description property of this WorkRequestSummary.
  • message (str) – The value to assign to the message property of this WorkRequestSummary.
  • percent_complete (float) – The value to assign to the percent_complete property of this WorkRequestSummary.
  • time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequestSummary.
compartment_id

[Required] Gets the compartment_id of this WorkRequestSummary. The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

Returns:The compartment_id of this WorkRequestSummary.
Return type:str
description

Gets the description of this WorkRequestSummary. Description of the type of work.

Returns:The description of this WorkRequestSummary.
Return type:str
id

[Required] Gets the id of this WorkRequestSummary. The id of the work request.

Returns:The id of this WorkRequestSummary.
Return type:str
message

Gets the message of this WorkRequestSummary. A progress or error message, if there is any.

Returns:The message of this WorkRequestSummary.
Return type:str
operation_type

[Required] Gets the operation_type of this WorkRequestSummary. the type of operation this Work Request performs

Allowed values for this property are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The operation_type of this WorkRequestSummary.
Return type:str
percent_complete

Gets the percent_complete of this WorkRequestSummary. Percentage of the request completed.

Returns:The percent_complete of this WorkRequestSummary.
Return type:float
status

[Required] Gets the status of this WorkRequestSummary. status of current work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELLING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The status of this WorkRequestSummary.
Return type:str
time_accepted

[Required] Gets the time_accepted of this WorkRequestSummary. The date and time the request was created, as described in RFC 3339, section 14.29.

Returns:The time_accepted of this WorkRequestSummary.
Return type:datetime