WorkRequestSummary

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

Bases: object

An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation’s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

Attributes:

OPERATION_TYPE_CREATE_CONNECT_HARNESS

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_CREATE_STREAM

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_CREATE_STREAM_POOL

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_DELETE_CONNECT_HARNESS

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_DELETE_STREAM

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_DELETE_STREAM_POOL

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_UPDATE_CONNECT_HARNESS

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_UPDATE_STREAM

A constant which can be used with the operation_type property of a WorkRequestSummary.

OPERATION_TYPE_UPDATE_STREAM_POOL

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_CANCELING

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_NEEDS_ATTENTION

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.

STATUS_WAITING

A constant which can be used with the status property of a WorkRequestSummary.

compartment_id

[Required] Gets the compartment_id of this WorkRequestSummary.

id

[Required] Gets the id of this WorkRequestSummary.

operation_type

[Required] Gets the operation_type of this WorkRequestSummary.

percent_complete

[Required] Gets the percent_complete of this WorkRequestSummary.

resources

[Required] Gets the resources of this WorkRequestSummary.

status

[Required] Gets the status of this WorkRequestSummary.

time_accepted

[Required] Gets the time_accepted of this WorkRequestSummary.

time_finished

Gets the time_finished of this WorkRequestSummary.

time_started

Gets the time_started of this WorkRequestSummary.

Methods:

__init__(**kwargs)

Initializes a new WorkRequestSummary object with values from keyword arguments.

OPERATION_TYPE_CREATE_CONNECT_HARNESS = 'CREATE_CONNECT_HARNESS'

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

OPERATION_TYPE_CREATE_STREAM = 'CREATE_STREAM'

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

OPERATION_TYPE_CREATE_STREAM_POOL = 'CREATE_STREAM_POOL'

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

OPERATION_TYPE_DELETE_CONNECT_HARNESS = 'DELETE_CONNECT_HARNESS'

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

OPERATION_TYPE_DELETE_STREAM = 'DELETE_STREAM'

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

OPERATION_TYPE_DELETE_STREAM_POOL = 'DELETE_STREAM_POOL'

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

OPERATION_TYPE_UPDATE_CONNECT_HARNESS = 'UPDATE_CONNECT_HARNESS'

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

OPERATION_TYPE_UPDATE_STREAM = 'UPDATE_STREAM'

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

OPERATION_TYPE_UPDATE_STREAM_POOL = 'UPDATE_STREAM_POOL'

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

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_CANCELING = 'CANCELING'

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

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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

STATUS_SUCCEEDED = 'SUCCEEDED'

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

STATUS_WAITING = 'WAITING'

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

__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: “CREATE_STREAM”, “UPDATE_STREAM”, “DELETE_STREAM”, “CREATE_STREAM_POOL”, “UPDATE_STREAM_POOL”, “DELETE_STREAM_POOL”, “CREATE_CONNECT_HARNESS”, “UPDATE_CONNECT_HARNESS”, “DELETE_CONNECT_HARNESS”, ‘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”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “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.

  • resources (list[oci.streaming.models.WorkRequestResource]) – The value to assign to the resources 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.

  • time_started (datetime) – The value to assign to the time_started property of this WorkRequestSummary.

  • time_finished (datetime) – The value to assign to the time_finished property of this WorkRequestSummary.

property compartment_id

[Required] Gets the compartment_id of this WorkRequestSummary. The OCID of the compartment that contains the work request.

Returns

The compartment_id of this WorkRequestSummary.

Return type

str

property id

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

Returns

The id of this WorkRequestSummary.

Return type

str

property operation_type

[Required] Gets the operation_type of this WorkRequestSummary. The asynchronous operation tracked by this work request.

Allowed values for this property are: “CREATE_STREAM”, “UPDATE_STREAM”, “DELETE_STREAM”, “CREATE_STREAM_POOL”, “UPDATE_STREAM_POOL”, “DELETE_STREAM_POOL”, “CREATE_CONNECT_HARNESS”, “UPDATE_CONNECT_HARNESS”, “DELETE_CONNECT_HARNESS”, ‘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

property percent_complete

[Required] Gets the percent_complete of this WorkRequestSummary. Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed.

Returns

The percent_complete of this WorkRequestSummary.

Return type

float

property resources

[Required] Gets the resources of this WorkRequestSummary. The resources that are affected by the work request.

Returns

The resources of this WorkRequestSummary.

Return type

list[oci.streaming.models.WorkRequestResource]

property status

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

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “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

property 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

property time_finished

Gets the time_finished of this WorkRequestSummary. The date and time the object was finished, as described in RFC 3339.

Returns

The time_finished of this WorkRequestSummary.

Return type

datetime

property time_started

Gets the time_started of this WorkRequestSummary. The date and time the request was started, as described in RFC 3339, section 14.29.

Returns

The time_started of this WorkRequestSummary.

Return type

datetime