Oracle Cloud Infrastructure Documentation
Try Free Tier

OPA Common Types

DBMS_CLOUD_OCI_OPA_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_ATTACHMENT_DETAILS_T Type

Description of an attachment for an instance

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_role varchar2(32767),
  is_implicit number,
  target_id varchar2(32767),
  target_instance_url varchar2(32767),
  target_service_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_attachment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_attachment_details_t (
    target_role varchar2,
    is_implicit number,
    target_id varchar2,
    target_instance_url varchar2,
    target_service_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_role

(required) The role of the target attachment. * `PARENT` - The target instance is the parent of this attachment. * `CHILD` - The target instance is the child of this attachment.

Allowed values are: 'PARENT', 'CHILD'

is_implicit

(required) * If role == `PARENT`, the attached instance was created by this service instance * If role == `CHILD`, this instance was created from attached instance on behalf of a user

target_id

(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.

target_instance_url

(required) The dataplane instance URL of the attached instance

target_service_type

(required) The type of the target instance, such as \"FUSION\".

DBMS_CLOUD_OCI_OPA_CHANGE_OPA_INSTANCE_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_change_opa_instance_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_change_opa_instance_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_change_opa_instance_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_OPA_CREATE_OPA_INSTANCE_DETAILS_T Type

The information about new OpaInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_create_opa_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  consumption_model varchar2(32767),
  shape_name varchar2(32767),
  metering_type varchar2(32767),
  idcs_at varchar2(32767),
  is_breakglass_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_create_opa_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_create_opa_instance_details_t (
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    consumption_model varchar2,
    shape_name varchar2,
    metering_type varchar2,
    idcs_at varchar2,
    is_breakglass_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) OpaInstance Identifier. User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.

description

(optional) Description of the Oracle Process Automation instance.

compartment_id

(required) Compartment Identifier

consumption_model

(optional) Parameter specifying which entitlement to use for billing purposes

shape_name

(required) Shape of the instance.

metering_type

(optional) MeteringType Identifier

idcs_at

(optional) IDCS Authentication token. This is required for all realms with IDCS. This property is optional, as it is not required for non-IDCS realms.

is_breakglass_enabled

(optional) indicates if breakGlass is enabled for the opa instance.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_OPA_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_OPA_ATTACHMENT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_opa_attachment_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_attachment_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_attachment_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_OPA_INSTANCE_T Type

Description of OpaInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_opa_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  instance_url varchar2(32767),
  consumption_model varchar2(32767),
  shape_name varchar2(32767),
  metering_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  identity_app_guid varchar2(32767),
  identity_app_display_name varchar2(32767),
  identity_domain_url varchar2(32767),
  identity_app_opc_service_instance_guid varchar2(32767),
  is_breakglass_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  attachments dbms_cloud_oci_opa_attachment_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    instance_url varchar2,
    consumption_model varchar2,
    shape_name varchar2,
    metering_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    identity_app_guid varchar2,
    identity_app_display_name varchar2,
    identity_domain_url varchar2,
    identity_app_opc_service_instance_guid varchar2,
    is_breakglass_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    attachments dbms_cloud_oci_opa_attachment_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

display_name

(required) OpaInstance Identifier, can be renamed

description

(optional) Description of the Process Automation instance.

compartment_id

(required) Compartment Identifier

instance_url

(optional) OPA Instance URL

consumption_model

(optional) The entitlement used for billing purposes

Allowed values are: 'UCM', 'GOV', 'SAAS'

shape_name

(required) Shape of the instance.

Allowed values are: 'DEVELOPMENT', 'PRODUCTION'

metering_type

(optional) MeteringType Identifier

Allowed values are: 'EXECUTION_PACK', 'USERS', 'EMPLOYEE', 'NAMED_USER'

time_created

(required) The time when OpaInstance was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the OpaInstance was updated. An RFC3339 formatted datetime string

lifecycle_state

(required) The current state of the OpaInstance.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

identity_app_guid

(optional) This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain.

identity_app_display_name

(optional) This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

identity_domain_url

(optional) This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

identity_app_opc_service_instance_guid

(optional) This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

is_breakglass_enabled

(optional) indicates if breakGlass is enabled for the opa instance.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

attachments

(optional) A list of associated attachments to other services

DBMS_CLOUD_OCI_OPA_OPA_INSTANCE_SUMMARY_T Type

Summary of the OpaInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_opa_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  instance_url varchar2(32767),
  consumption_model varchar2(32767),
  shape_name varchar2(32767),
  metering_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  is_breakglass_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_summary_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    instance_url varchar2,
    consumption_model varchar2,
    shape_name varchar2,
    metering_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    is_breakglass_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

display_name

(required) OpaInstance Identifier, can be renamed

description

(optional) Description of the Process Automation instance.

compartment_id

(required) Compartment Identifier

instance_url

(optional) OPA Instance URL

consumption_model

(optional) Parameter specifying which entitlement to use for billing purposes

shape_name

(required) Shape of the instance.

metering_type

(optional) MeteringType Identifier

time_created

(required) The time the the OpaInstance was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the OpaInstance was updated. An RFC3339 formatted datetime string

lifecycle_state

(required) The current state of the OpaInstance.

is_breakglass_enabled

(optional) indicates if breakGlass is enabled for the opa instance.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_OPA_OPA_INSTANCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_opa_opa_instance_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_opa_instance_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_opa_instance_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_OPA_INSTANCE_COLLECTION_T Type

Results of a opaInstance search. Contains boh OpaInstanceSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_opa_instance_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_opa_opa_instance_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_opa_instance_collection_t (
    items dbms_cloud_oci_opa_opa_instance_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of opaInstances.

DBMS_CLOUD_OCI_OPA_UPDATE_OPA_INSTANCE_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_update_opa_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_update_opa_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_update_opa_instance_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) OpaInstance Identifier

description

(optional) Description of the Oracle Process Automation instance.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  metadata json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2,
    metadata json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED', 'FAILED'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata

metadata

(optional) Additional information that helps to explain the resource.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_opa_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_opa_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_opa_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_OPA_INSTANCE', 'UPDATE_OPA_INSTANCE', 'DELETE_OPA_INSTANCE', 'MOVE_OPA_INSTANCE', 'CREATE_OPA_INSTANCE_ATTACHMENT', 'DELETE_OPA_INSTANCE_ATTACHMENT'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) 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 are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_opa_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_ERROR_COLLECTION_T Type

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_opa_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_error_collection_t (
    items dbms_cloud_oci_opa_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_opa_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_opa_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_log_entry_collection_t (
    items dbms_cloud_oci_opa_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_opa_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_opa_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_OPA_INSTANCE', 'UPDATE_OPA_INSTANCE', 'DELETE_OPA_INSTANCE', 'MOVE_OPA_INSTANCE', 'CREATE_OPA_INSTANCE_ATTACHMENT', 'DELETE_OPA_INSTANCE_ATTACHMENT'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) 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 are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_opa_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_opa_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPA_WORK_REQUEST_SUMMARY_COLLECTION_T Type

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opa_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_opa_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opa_work_request_summary_collection_t (
    items dbms_cloud_oci_opa_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?