WorkRequestResource¶

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

Bases: object

A resource created or operated on by a work request.

Attributes

`ACTION_TYPE_CREATED`	A constant which can be used with the action_type property of a WorkRequestResource.
`ACTION_TYPE_DELETED`	A constant which can be used with the action_type property of a WorkRequestResource.
`ACTION_TYPE_FAILED`	A constant which can be used with the action_type property of a WorkRequestResource.
`ACTION_TYPE_IN_PROGRESS`	A constant which can be used with the action_type property of a WorkRequestResource.
`ACTION_TYPE_RELATED`	A constant which can be used with the action_type property of a WorkRequestResource.
`ACTION_TYPE_UPDATED`	A constant which can be used with the action_type property of a WorkRequestResource.
`action_type`	[Required] Gets the action_type of this WorkRequestResource.
`entity_type`	[Required] Gets the entity_type of this WorkRequestResource.
`entity_uri`	Gets the entity_uri of this WorkRequestResource.
`identifier`	[Required] Gets the identifier of this WorkRequestResource.
`metadata`	Gets the metadata of this WorkRequestResource.

Methods

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

ACTION_TYPE_CREATED = 'CREATED'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “CREATED”

ACTION_TYPE_DELETED = 'DELETED'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “DELETED”

ACTION_TYPE_FAILED = 'FAILED'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “FAILED”

ACTION_TYPE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “IN_PROGRESS”

ACTION_TYPE_RELATED = 'RELATED'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “RELATED”

ACTION_TYPE_UPDATED = 'UPDATED'¶: A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “UPDATED”

__init__(**kwargs)¶

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

Parameters:

entity_type (str) – The value to assign to the entity_type property of this WorkRequestResource.
action_type (str) – The value to assign to the action_type property of this WorkRequestResource. Allowed values for this property are: “CREATED”, “UPDATED”, “DELETED”, “IN_PROGRESS”, “RELATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
identifier (str) – The value to assign to the identifier property of this WorkRequestResource.
entity_uri (str) – The value to assign to the entity_uri property of this WorkRequestResource.
metadata (dict(str, str)) – The value to assign to the metadata property of this WorkRequestResource.

action_type¶

[Required] Gets the action_type of this WorkRequestResource. The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively.

Allowed values for this property are: “CREATED”, “UPDATED”, “DELETED”, “IN_PROGRESS”, “RELATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The action_type of this WorkRequestResource.
Return type:	str

entity_type¶

[Required] Gets the entity_type of this WorkRequestResource. The resource type that the work request affects.

Returns:	The entity_type of this WorkRequestResource.
Return type:	str

entity_uri¶

Gets the entity_uri of this WorkRequestResource. The URI path that you can use for a GET request to access the resource metadata.

Returns:	The entity_uri of this WorkRequestResource.
Return type:	str

identifier¶

[Required] Gets the identifier of this WorkRequestResource. An OCID or other unique identifier for the resource.

Returns:	The identifier of this WorkRequestResource.
Return type:	str

metadata¶

Gets the metadata of this WorkRequestResource. Additional information that helps to explain the resource.

Returns:	The metadata of this WorkRequestResource.
Return type:	dict(str, str)