WorkItemSummary

class oci.jms.models.WorkItemSummary(**kwargs)

Bases: object

Work item to complete a work request.

Attributes:

STATUS_ACCEPTED	A constant which can be used with the status property of a WorkItemSummary.
STATUS_CANCELED	A constant which can be used with the status property of a WorkItemSummary.
STATUS_CANCELING	A constant which can be used with the status property of a WorkItemSummary.
STATUS_IN_PROGRESS	A constant which can be used with the status property of a WorkItemSummary.
STATUS_NEEDS_ATTENTION	A constant which can be used with the status property of a WorkItemSummary.
STATUS_RETRYING	A constant which can be used with the status property of a WorkItemSummary.
STATUS_SKIPPED	A constant which can be used with the status property of a WorkItemSummary.
STATUS_SUCCEEDED	A constant which can be used with the status property of a WorkItemSummary.
details	[Required] Gets the details of this WorkItemSummary.
id	[Required] Gets the id of this WorkItemSummary.
installation_site	[Required] Gets the installation_site of this WorkItemSummary.
retry_count	[Required] Gets the retry_count of this WorkItemSummary.
status	[Required] Gets the status of this WorkItemSummary.
time_last_updated	Gets the time_last_updated of this WorkItemSummary.
work_request_id	[Required] Gets the work_request_id of this WorkItemSummary.

Methods:

__init__(**kwargs)

Initializes a new WorkItemSummary object with values from keyword arguments.

STATUS_ACCEPTED = 'ACCEPTED'

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

STATUS_CANCELED = 'CANCELED'

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

STATUS_CANCELING = 'CANCELING'

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

STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the status property of a WorkItemSummary. 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 WorkItemSummary. This constant has a value of “NEEDS_ATTENTION”

STATUS_RETRYING = 'RETRYING'

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

STATUS_SKIPPED = 'SKIPPED'

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

STATUS_SUCCEEDED = 'SUCCEEDED'

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

__init__(**kwargs)

Initializes a new WorkItemSummary 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 WorkItemSummary.

• work_request_id (str) – The value to assign to the work_request_id property of this WorkItemSummary.

• installation_site (oci.jms.models.InstallationSite) – The value to assign to the installation_site property of this WorkItemSummary.

• details (oci.jms.models.WorkItemDetails) – The value to assign to the details property of this WorkItemSummary.

• status (str) – The value to assign to the status property of this WorkItemSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “NEEDS_ATTENTION”, “RETRYING”, “SKIPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• retry_count (int) – The value to assign to the retry_count property of this WorkItemSummary.

• time_last_updated (datetime) – The value to assign to the time_last_updated property of this WorkItemSummary.

property details

[Required] Gets the details of this WorkItemSummary.

Returns

The details of this WorkItemSummary.

Return type

oci.jms.models.WorkItemDetails

property id

[Required] Gets the id of this WorkItemSummary. The unique ID of ths work item.

Returns

The id of this WorkItemSummary.

Return type

str

property installation_site

[Required] Gets the installation_site of this WorkItemSummary.

Returns

The installation_site of this WorkItemSummary.

Return type

oci.jms.models.InstallationSite

property retry_count

[Required] Gets the retry_count of this WorkItemSummary. Number of times this work item is retried.

Returns

The retry_count of this WorkItemSummary.

Return type

int

property status

[Required] Gets the status of this WorkItemSummary. The status of the work item.

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

Returns

The status of this WorkItemSummary.

Return type

str

property time_last_updated

Gets the time_last_updated of this WorkItemSummary. The date and time the work item was last updated. (formatted according to RFC3339).

Returns

The time_last_updated of this WorkItemSummary.

Return type

datetime

property work_request_id

[Required] Gets the work_request_id of this WorkItemSummary. The OCID of the work request created this work item.

Returns

The work_request_id of this WorkItemSummary.

Return type

str