WorkRequestSummary¶

class oci.generative_ai_agent.models.WorkRequestSummary(**kwargs)¶

Bases: object

Summary information about an asynchronous work request.

Attributes

`OPERATION_TYPE_CREATE_AGENT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_AGENT_ENDPOINT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_DATA_INGESTION_JOB`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_DATA_SOURCE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_KNOWLEDGE_BASE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_TOOL`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_AGENT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_AGENT_ENDPOINT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_DATA_INGESTION_JOB`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_DATA_SOURCE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_KNOWLEDGE_BASE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_TOOL`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_MOVE_AGENT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_MOVE_AGENT_ENDPOINT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_MOVE_KNOWLEDGE_BASE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_AGENT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_AGENT_ENDPOINT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_DATA_SOURCE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_KNOWLEDGE_BASE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_TOOL`	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.
`time_updated`	Gets the time_updated of this WorkRequestSummary.

Methods

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

OPERATION_TYPE_CREATE_AGENT = 'CREATE_AGENT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_AGENT”

OPERATION_TYPE_CREATE_AGENT_ENDPOINT = 'CREATE_AGENT_ENDPOINT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_AGENT_ENDPOINT”

OPERATION_TYPE_CREATE_DATA_INGESTION_JOB = 'CREATE_DATA_INGESTION_JOB'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_DATA_INGESTION_JOB”

OPERATION_TYPE_CREATE_DATA_SOURCE = 'CREATE_DATA_SOURCE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_DATA_SOURCE”

OPERATION_TYPE_CREATE_KNOWLEDGE_BASE = 'CREATE_KNOWLEDGE_BASE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_KNOWLEDGE_BASE”

OPERATION_TYPE_CREATE_TOOL = 'CREATE_TOOL'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_TOOL”

OPERATION_TYPE_DELETE_AGENT = 'DELETE_AGENT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_AGENT”

OPERATION_TYPE_DELETE_AGENT_ENDPOINT = 'DELETE_AGENT_ENDPOINT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_AGENT_ENDPOINT”

OPERATION_TYPE_DELETE_DATA_INGESTION_JOB = 'DELETE_DATA_INGESTION_JOB'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_DATA_INGESTION_JOB”

OPERATION_TYPE_DELETE_DATA_SOURCE = 'DELETE_DATA_SOURCE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_DATA_SOURCE”

OPERATION_TYPE_DELETE_KNOWLEDGE_BASE = 'DELETE_KNOWLEDGE_BASE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_KNOWLEDGE_BASE”

OPERATION_TYPE_DELETE_TOOL = 'DELETE_TOOL'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_TOOL”

OPERATION_TYPE_MOVE_AGENT = 'MOVE_AGENT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “MOVE_AGENT”

OPERATION_TYPE_MOVE_AGENT_ENDPOINT = 'MOVE_AGENT_ENDPOINT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “MOVE_AGENT_ENDPOINT”

OPERATION_TYPE_MOVE_KNOWLEDGE_BASE = 'MOVE_KNOWLEDGE_BASE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “MOVE_KNOWLEDGE_BASE”

OPERATION_TYPE_UPDATE_AGENT = 'UPDATE_AGENT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_AGENT”

OPERATION_TYPE_UPDATE_AGENT_ENDPOINT = 'UPDATE_AGENT_ENDPOINT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_AGENT_ENDPOINT”

OPERATION_TYPE_UPDATE_DATA_SOURCE = 'UPDATE_DATA_SOURCE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_DATA_SOURCE”

OPERATION_TYPE_UPDATE_KNOWLEDGE_BASE = 'UPDATE_KNOWLEDGE_BASE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_KNOWLEDGE_BASE”

OPERATION_TYPE_UPDATE_TOOL = 'UPDATE_TOOL'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_TOOL”

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_AGENT”, “UPDATE_AGENT”, “DELETE_AGENT”, “MOVE_AGENT”, “CREATE_AGENT_ENDPOINT”, “UPDATE_AGENT_ENDPOINT”, “DELETE_AGENT_ENDPOINT”, “MOVE_AGENT_ENDPOINT”, “CREATE_DATA_SOURCE”, “UPDATE_DATA_SOURCE”, “DELETE_DATA_SOURCE”, “CREATE_KNOWLEDGE_BASE”, “UPDATE_KNOWLEDGE_BASE”, “DELETE_KNOWLEDGE_BASE”, “MOVE_KNOWLEDGE_BASE”, “CREATE_DATA_INGESTION_JOB”, “DELETE_DATA_INGESTION_JOB”, “CREATE_TOOL”, “UPDATE_TOOL”, “DELETE_TOOL”, ‘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.generative_ai_agent.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.
time_updated (datetime) – The value to assign to the time_updated property of this WorkRequestSummary.

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

id¶

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

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

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_AGENT”, “UPDATE_AGENT”, “DELETE_AGENT”, “MOVE_AGENT”, “CREATE_AGENT_ENDPOINT”, “UPDATE_AGENT_ENDPOINT”, “DELETE_AGENT_ENDPOINT”, “MOVE_AGENT_ENDPOINT”, “CREATE_DATA_SOURCE”, “UPDATE_DATA_SOURCE”, “DELETE_DATA_SOURCE”, “CREATE_KNOWLEDGE_BASE”, “UPDATE_KNOWLEDGE_BASE”, “DELETE_KNOWLEDGE_BASE”, “MOVE_KNOWLEDGE_BASE”, “CREATE_DATA_INGESTION_JOB”, “DELETE_DATA_INGESTION_JOB”, “CREATE_TOOL”, “UPDATE_TOOL”, “DELETE_TOOL”, ‘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¶

[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

resources¶

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

Returns:	The resources of this WorkRequestSummary.
Return type:	list[oci.generative_ai_agent.models.WorkRequestResource]

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

time_accepted¶

[Required] Gets the time_accepted of this WorkRequestSummary. The date and time the work request was created, in the format defined by RFC 3339.

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

time_finished¶

Gets the time_finished of this WorkRequestSummary. The date and time the work request was finished, in the format defined by RFC 3339.

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

time_started¶

Gets the time_started of this WorkRequestSummary. The date and time the work request was started, in the format defined by RFC 3339.

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

time_updated¶

Gets the time_updated of this WorkRequestSummary. The date and time the work request was updated, in the format defined by RFC 3339.

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