WorkRequest

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

Bases: object

An asynchronous work request. See Work Requests.

Attributes:

OPERATION_TYPE_COLLECT_JFR	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_CREATE_DRS_FILE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_CREATE_FLEET	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_CREATE_JAVA_INSTALLATION	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_DRS_FILE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_FLEET	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_JAVA_INSTALLATION	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_JMS_REPORT	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DISABLE_DRS	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_ENABLE_DRS	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_EXPORT_DATA_CSV	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_MOVE_FLEET	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_REQUEST_CRYPTO_EVENT_ANALYSIS	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_REQUEST_JAVA_MIGRATION_ANALYSIS	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_REQUEST_PERFORMANCE_TUNING_ANALYSIS	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_SCAN_JAVA_SERVER_USAGE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_SCAN_LIBRARY_DYNAMIC_USAGE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_SCAN_LIBRARY_USAGE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_DRS_FILE	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_FLEET	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_FLEET_AGENT_CONFIGURATION	A constant which can be used with the operation_type property of a WorkRequest.
STATUS_ACCEPTED	A constant which can be used with the status property of a WorkRequest.
STATUS_CANCELED	A constant which can be used with the status property of a WorkRequest.
STATUS_CANCELING	A constant which can be used with the status property of a WorkRequest.
STATUS_FAILED	A constant which can be used with the status property of a WorkRequest.
STATUS_IN_PROGRESS	A constant which can be used with the status property of a WorkRequest.
STATUS_SUCCEEDED	A constant which can be used with the status property of a WorkRequest.
compartment_id	[Required] Gets the compartment_id of this WorkRequest.
completed_task_count	Gets the completed_task_count of this WorkRequest.
created_by	Gets the created_by of this WorkRequest.
id	[Required] Gets the id of this WorkRequest.
operation_type	[Required] Gets the operation_type of this WorkRequest.
percent_complete	[Required] Gets the percent_complete of this WorkRequest.
resources	[Required] Gets the resources of this WorkRequest.
status	[Required] Gets the status of this WorkRequest.
time_accepted	[Required] Gets the time_accepted of this WorkRequest.
time_finished	Gets the time_finished of this WorkRequest.
time_last_updated	Gets the time_last_updated of this WorkRequest.
time_started	Gets the time_started of this WorkRequest.
total_task_count	Gets the total_task_count of this WorkRequest.

Methods:

__init__(**kwargs)

Initializes a new WorkRequest object with values from keyword arguments.

OPERATION_TYPE_COLLECT_JFR = 'COLLECT_JFR'

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

OPERATION_TYPE_CREATE_DRS_FILE = 'CREATE_DRS_FILE'

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

OPERATION_TYPE_CREATE_FLEET = 'CREATE_FLEET'

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

OPERATION_TYPE_CREATE_JAVA_INSTALLATION = 'CREATE_JAVA_INSTALLATION'

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

OPERATION_TYPE_DELETE_DRS_FILE = 'DELETE_DRS_FILE'

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

OPERATION_TYPE_DELETE_FLEET = 'DELETE_FLEET'

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

OPERATION_TYPE_DELETE_JAVA_INSTALLATION = 'DELETE_JAVA_INSTALLATION'

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

OPERATION_TYPE_DELETE_JMS_REPORT = 'DELETE_JMS_REPORT'

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

OPERATION_TYPE_DISABLE_DRS = 'DISABLE_DRS'

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

OPERATION_TYPE_ENABLE_DRS = 'ENABLE_DRS'

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

OPERATION_TYPE_EXPORT_DATA_CSV = 'EXPORT_DATA_CSV'

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

OPERATION_TYPE_MOVE_FLEET = 'MOVE_FLEET'

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

OPERATION_TYPE_REQUEST_CRYPTO_EVENT_ANALYSIS = 'REQUEST_CRYPTO_EVENT_ANALYSIS'

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

OPERATION_TYPE_REQUEST_JAVA_MIGRATION_ANALYSIS = 'REQUEST_JAVA_MIGRATION_ANALYSIS'

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

OPERATION_TYPE_REQUEST_PERFORMANCE_TUNING_ANALYSIS = 'REQUEST_PERFORMANCE_TUNING_ANALYSIS'

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

OPERATION_TYPE_SCAN_JAVA_SERVER_USAGE = 'SCAN_JAVA_SERVER_USAGE'

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

OPERATION_TYPE_SCAN_LIBRARY_DYNAMIC_USAGE = 'SCAN_LIBRARY_DYNAMIC_USAGE'

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

OPERATION_TYPE_SCAN_LIBRARY_USAGE = 'SCAN_LIBRARY_USAGE'

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

OPERATION_TYPE_UPDATE_DRS_FILE = 'UPDATE_DRS_FILE'

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

OPERATION_TYPE_UPDATE_FLEET = 'UPDATE_FLEET'

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

OPERATION_TYPE_UPDATE_FLEET_AGENT_CONFIGURATION = 'UPDATE_FLEET_AGENT_CONFIGURATION'

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

STATUS_ACCEPTED = 'ACCEPTED'

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

STATUS_CANCELED = 'CANCELED'

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

STATUS_CANCELING = 'CANCELING'

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

STATUS_FAILED = 'FAILED'

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

STATUS_IN_PROGRESS = 'IN_PROGRESS'

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

STATUS_SUCCEEDED = 'SUCCEEDED'

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

__init__(**kwargs)

Initializes a new WorkRequest 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 WorkRequest. Allowed values for this property are: “CREATE_FLEET”, “DELETE_FLEET”, “MOVE_FLEET”, “UPDATE_FLEET”, “UPDATE_FLEET_AGENT_CONFIGURATION”, “DELETE_JAVA_INSTALLATION”, “CREATE_JAVA_INSTALLATION”, “COLLECT_JFR”, “REQUEST_CRYPTO_EVENT_ANALYSIS”, “REQUEST_PERFORMANCE_TUNING_ANALYSIS”, “REQUEST_JAVA_MIGRATION_ANALYSIS”, “DELETE_JMS_REPORT”, “SCAN_JAVA_SERVER_USAGE”, “SCAN_LIBRARY_USAGE”, “SCAN_LIBRARY_DYNAMIC_USAGE”, “EXPORT_DATA_CSV”, “CREATE_DRS_FILE”, “UPDATE_DRS_FILE”, “DELETE_DRS_FILE”, “ENABLE_DRS”, “DISABLE_DRS”, ‘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 WorkRequest. Allowed values for this property are: “ACCEPTED”, “CANCELED”, “CANCELING”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, ‘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 WorkRequest.

• compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.

• resources (list[oci.jms.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.

• percent_complete (float) – The value to assign to the percent_complete property of this WorkRequest.

• time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequest.

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

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

• created_by (oci.jms.models.Principal) – The value to assign to the created_by property of this WorkRequest.

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

• total_task_count (int) – The value to assign to the total_task_count property of this WorkRequest.

• completed_task_count (int) – The value to assign to the completed_task_count property of this WorkRequest.

property compartment_id

[Required] Gets the compartment_id of this WorkRequest. 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 aren’t in the same compartment, it’s up to the service team to pick the primary resource whose compartment should be used.

Returns

The compartment_id of this WorkRequest.

Return type

str

property completed_task_count

Gets the completed_task_count of this WorkRequest. The number of tasks had been executed to a terminal state.

Returns

The completed_task_count of this WorkRequest.

Return type

int

property created_by

Gets the created_by of this WorkRequest.

Returns

The created_by of this WorkRequest.

Return type

oci.jms.models.Principal

property id

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

Returns

The id of this WorkRequest.

Return type

str

property operation_type

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

Allowed values for this property are: “CREATE_FLEET”, “DELETE_FLEET”, “MOVE_FLEET”, “UPDATE_FLEET”, “UPDATE_FLEET_AGENT_CONFIGURATION”, “DELETE_JAVA_INSTALLATION”, “CREATE_JAVA_INSTALLATION”, “COLLECT_JFR”, “REQUEST_CRYPTO_EVENT_ANALYSIS”, “REQUEST_PERFORMANCE_TUNING_ANALYSIS”, “REQUEST_JAVA_MIGRATION_ANALYSIS”, “DELETE_JMS_REPORT”, “SCAN_JAVA_SERVER_USAGE”, “SCAN_LIBRARY_USAGE”, “SCAN_LIBRARY_DYNAMIC_USAGE”, “EXPORT_DATA_CSV”, “CREATE_DRS_FILE”, “UPDATE_DRS_FILE”, “DELETE_DRS_FILE”, “ENABLE_DRS”, “DISABLE_DRS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The operation_type of this WorkRequest.

Return type

str

property percent_complete

[Required] Gets the percent_complete of this WorkRequest. The percentage complete of the operation tracked by this work request.

Returns

The percent_complete of this WorkRequest.

Return type

float

property resources

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

Returns

The resources of this WorkRequest.

Return type

list[oci.jms.models.WorkRequestResource]

property status

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

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

Returns

The status of this WorkRequest.

Return type

str

property time_accepted

[Required] Gets the time_accepted of this WorkRequest. The date and time the request was created (formatted according to RFC3339).

Returns

The time_accepted of this WorkRequest.

Return type

datetime

property time_finished

Gets the time_finished of this WorkRequest. The date and time the work request reached a terminal state, either _FAILED_ or _SUCCEEDED_ (formatted according to RFC3339).

Returns

The time_finished of this WorkRequest.

Return type

datetime

property time_last_updated

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

Returns

The time_last_updated of this WorkRequest.

Return type

datetime

property time_started

Gets the time_started of this WorkRequest. The date and time the work request transitioned from _ACCEPTED_ to _IN_PROGRESS_ (formatted according to RFC3339).

Returns

The time_started of this WorkRequest.

Return type

datetime

property total_task_count

Gets the total_task_count of this WorkRequest. The total number of tasks to be executed for this work request.

Returns

The total_task_count of this WorkRequest.

Return type

int