Oracle Cloud Infrastructure Documentation
Try Free Tier

OCE Common Types

DBMS_CLOUD_OCI_OCE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_OCE_CHANGE_OCE_INSTANCE_COMPARTMENT_DETAILS_T Type

The information about compartment details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_change_oce_instance_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_change_oce_instance_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_change_oce_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 OceInstance should be moved.

DBMS_CLOUD_OCI_OCE_IDENTITY_STRIPE_DETAILS_T Type

Details of the identity stripe used for OceInstance

Syntax

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

Fields

Field Description

service_name

(required) Name of the Identity Cloud Service instance in My Services to be used. Example: `secondstripe`

tenancy

(required) Value of the Identity Cloud Service tenancy. Example: `idcs-8416ebdd0d674f84803f4193cce026e9`

DBMS_CLOUD_OCI_OCE_CREATE_OCE_INSTANCE_DETAILS_T Type

The information about new OceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_create_oce_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  tenancy_id varchar2(32767),
  idcs_access_token varchar2(32767),
  identity_stripe dbms_cloud_oci_oce_identity_stripe_details_t,
  tenancy_name varchar2(32767),
  instance_usage_type varchar2(32767),
  add_on_features dbms_cloud_oci_oce_varchar2_tbl,
  object_storage_namespace varchar2(32767),
  admin_email varchar2(32767),
  upgrade_schedule varchar2(32767),
  waf_primary_domain varchar2(32767),
  instance_access_type varchar2(32767),
  instance_license_type varchar2(32767),
  dr_region varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_create_oce_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_create_oce_instance_details_t (
    description varchar2,
    compartment_id varchar2,
    name varchar2,
    tenancy_id varchar2,
    idcs_access_token varchar2,
    identity_stripe dbms_cloud_oci_oce_identity_stripe_details_t,
    tenancy_name varchar2,
    instance_usage_type varchar2,
    add_on_features dbms_cloud_oci_oce_varchar2_tbl,
    object_storage_namespace varchar2,
    admin_email varchar2,
    upgrade_schedule varchar2,
    waf_primary_domain varchar2,
    instance_access_type varchar2,
    instance_license_type varchar2,
    dr_region varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) OceInstance description

compartment_id

(required) Compartment Identifier

name

(required) OceInstance Name

tenancy_id

(required) Tenancy Identifier

idcs_access_token

(required) Identity Cloud Service access token identifying a stripe and service administrator user

identity_stripe

(optional)

tenancy_name

(required) Tenancy Name

instance_usage_type

(optional) Instance type based on its usage

Allowed values are: 'PRIMARY', 'NONPRIMARY'

add_on_features

(optional) a list of add-on features for the ocm instance

object_storage_namespace

(required) Object Storage Namespace of Tenancy

admin_email

(required) Admin Email for Notification

upgrade_schedule

(optional) Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

waf_primary_domain

(optional) Web Application Firewall(WAF) primary domain

instance_access_type

(optional) Flag indicating whether the instance access is private or public

Allowed values are: 'PUBLIC', 'PRIVATE'

instance_license_type

(optional) Flag indicating whether the instance license is new cloud or bring your own license

Allowed values are: 'NEW', 'BYOL', 'PREMIUM', 'STARTER'

dr_region

(optional) disaster recovery paired ragion name

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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_OCE_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_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_OCE_OCE_INSTANCE_T Type

Details of OceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_oce_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  guid varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  tenancy_id varchar2(32767),
  idcs_tenancy varchar2(32767),
  tenancy_name varchar2(32767),
  upgrade_schedule varchar2(32767),
  identity_stripe dbms_cloud_oci_oce_identity_stripe_details_t,
  instance_usage_type varchar2(32767),
  add_on_features dbms_cloud_oci_oce_varchar2_tbl,
  object_storage_namespace varchar2(32767),
  admin_email varchar2(32767),
  waf_primary_domain varchar2(32767),
  instance_access_type varchar2(32767),
  instance_license_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  dr_region varchar2(32767),
  state_message varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  service json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_oce_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_oce_instance_t (
    id varchar2,
    guid varchar2,
    description varchar2,
    compartment_id varchar2,
    name varchar2,
    tenancy_id varchar2,
    idcs_tenancy varchar2,
    tenancy_name varchar2,
    upgrade_schedule varchar2,
    identity_stripe dbms_cloud_oci_oce_identity_stripe_details_t,
    instance_usage_type varchar2,
    add_on_features dbms_cloud_oci_oce_varchar2_tbl,
    object_storage_namespace varchar2,
    admin_email varchar2,
    waf_primary_domain varchar2,
    instance_access_type varchar2,
    instance_license_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    dr_region varchar2,
    state_message varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    service json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

guid

(required) Unique GUID identifier that is immutable on creation

description

(optional) OceInstance description, can be updated

compartment_id

(required) Compartment Identifier

name

(required) OceInstance Name

tenancy_id

(required) Tenancy Identifier

idcs_tenancy

(required) IDCS Tenancy Identifier

tenancy_name

(required) Tenancy Name

upgrade_schedule

(optional) Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

Allowed values are: 'UPGRADE_IMMEDIATELY', 'DELAYED_UPGRADE'

identity_stripe

(optional)

instance_usage_type

(optional) Instance type based on its usage

Allowed values are: 'PRIMARY', 'NONPRIMARY'

add_on_features

(optional) a list of add-on features for the ocm instance

object_storage_namespace

(required) Object Storage Namespace of tenancy

admin_email

(required) Admin Email for Notification

waf_primary_domain

(optional) Web Application Firewall(WAF) primary domain

instance_access_type

(optional) Flag indicating whether the instance access is private or public

Allowed values are: 'PUBLIC', 'PRIVATE'

instance_license_type

(optional) Flag indicating whether the instance license is new cloud or bring your own license

Allowed values are: 'NEW', 'BYOL', 'PREMIUM', 'STARTER'

time_created

(optional) The time the the OceInstance was created. An RFC3339 formatted datetime string

time_updated

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

lifecycle_state

(optional) The current state of the instance lifecycle.

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

lifecycle_details

(optional) Details of the current state of the instance lifecycle

Allowed values are: 'STANDBY', 'FAILOVER', 'DOWN', 'PRIMARY'

dr_region

(optional) disaster recovery paired ragion name

state_message

(optional) An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. 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\"}}`

service

(optional) SERVICE data. Example: `{\"service\": {\"IDCS\": \"value\"}}`

DBMS_CLOUD_OCI_OCE_OCE_INSTANCE_SUMMARY_T Type

Summary of the OceInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_oce_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  guid varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  tenancy_id varchar2(32767),
  idcs_tenancy varchar2(32767),
  tenancy_name varchar2(32767),
  instance_usage_type varchar2(32767),
  add_on_features dbms_cloud_oci_oce_varchar2_tbl,
  object_storage_namespace varchar2(32767),
  admin_email varchar2(32767),
  upgrade_schedule varchar2(32767),
  waf_primary_domain varchar2(32767),
  instance_access_type varchar2(32767),
  instance_license_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  dr_region varchar2(32767),
  state_message varchar2(32767),
  service json_element_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_oce_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_oce_instance_summary_t (
    id varchar2,
    guid varchar2,
    description varchar2,
    compartment_id varchar2,
    name varchar2,
    tenancy_id varchar2,
    idcs_tenancy varchar2,
    tenancy_name varchar2,
    instance_usage_type varchar2,
    add_on_features dbms_cloud_oci_oce_varchar2_tbl,
    object_storage_namespace varchar2,
    admin_email varchar2,
    upgrade_schedule varchar2,
    waf_primary_domain varchar2,
    instance_access_type varchar2,
    instance_license_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    dr_region varchar2,
    state_message varchar2,
    service json_element_t,
    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

guid

(required) Unique GUID identifier that is immutable on creation

description

(optional) OceInstance description, can be updated

compartment_id

(required) Compartment Identifier

name

(required) OceInstance Name

tenancy_id

(required) Tenancy Identifier

idcs_tenancy

(required) IDCS Tenancy Identifier

tenancy_name

(required) Tenancy Name

instance_usage_type

(optional) Instance type based on its usage

Allowed values are: 'PRIMARY', 'NONPRIMARY'

add_on_features

(optional) a list of add-on features for the ocm instance

object_storage_namespace

(required) Object Storage Namespace of tenancy

admin_email

(required) Admin Email for Notification

upgrade_schedule

(optional) Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

waf_primary_domain

(optional) Web Application Firewall(WAF) primary domain

instance_access_type

(optional) Flag indicating whether the instance access is private or public

Allowed values are: 'PUBLIC', 'PRIVATE'

instance_license_type

(optional) Flag indicating whether the instance license is new cloud or bring your own license

Allowed values are: 'NEW', 'BYOL', 'PREMIUM', 'STARTER'

time_created

(optional) The time the the OceInstance was created. An RFC3339 formatted datetime string

time_updated

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

lifecycle_state

(optional) The current state of the instance lifecycle.

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

lifecycle_details

(optional) Details of the current state of the instance lifecycle

Allowed values are: 'STANDBY', 'FAILOVER', 'DOWN', 'PRIMARY'

dr_region

(optional) disaster recovery paired ragion name

state_message

(optional) An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

service

(optional) SERVICE data. Example: `{\"service\": {\"IDCS\": \"value\"}}`

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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. 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_OCE_UPDATE_OCE_INSTANCE_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_update_oce_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  waf_primary_domain varchar2(32767),
  instance_license_type varchar2(32767),
  instance_usage_type varchar2(32767),
  add_on_features dbms_cloud_oci_oce_varchar2_tbl,
  lifecycle_details varchar2(32767),
  dr_region varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_update_oce_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_update_oce_instance_details_t (
    description varchar2,
    waf_primary_domain varchar2,
    instance_license_type varchar2,
    instance_usage_type varchar2,
    add_on_features dbms_cloud_oci_oce_varchar2_tbl,
    lifecycle_details varchar2,
    dr_region varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) OceInstance description

waf_primary_domain

(optional) Web Application Firewall(WAF) primary domain

instance_license_type

(optional) Flag indicating whether the instance license is new cloud or bring your own license

Allowed values are: 'NEW', 'BYOL', 'PREMIUM', 'STARTER'

instance_usage_type

(optional) Instance type based on its usage

Allowed values are: 'PRIMARY', 'NONPRIMARY'

add_on_features

(optional) a list of add-on features for the ocm instance

lifecycle_details

(optional) Details of the current state of the instance lifecycle

Allowed values are: 'STANDBY', 'FAILOVER', 'DOWN', 'PRIMARY'

dr_region

(optional) disaster recovery paired ragion name

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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_OCE_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_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),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request is 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', '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

DBMS_CLOUD_OCI_OCE_WORKFLOW_STEP_T Type

Workflow step of workflow monitor.

Syntax

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

Fields

Field Description

step_name

(optional) workflow step name

status

(optional) workflow step status

DBMS_CLOUD_OCI_OCE_WORKFLOW_STEP_TBL Type

Nested table type of dbms_cloud_oci_oce_workflow_step_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_workflow_step_tbl FORCE IS TABLE OF (dbms_cloud_oci_oce_workflow_step_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OCE_WORKFLOW_MONITOR_T Type

The workflow monitor for this work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_workflow_monitor_t FORCE AUTHID CURRENT_USER IS OBJECT (
  workflow_name varchar2(32767),
  resource_name varchar2(32767),
  workflow_steps dbms_cloud_oci_oce_workflow_step_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_workflow_monitor_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_workflow_monitor_t (
    workflow_name varchar2,
    resource_name varchar2,
    workflow_steps dbms_cloud_oci_oce_workflow_step_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

workflow_name

(optional) workflow name for this work request

resource_name

(optional) resource name for this work request

workflow_steps

(optional) Workflow step of workflow monitor.

DBMS_CLOUD_OCI_OCE_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_oce_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_oce_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OCE_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_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_oce_work_request_resource_tbl,
  workflow_monitor dbms_cloud_oci_oce_workflow_monitor_t,
  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_oce_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_oce_work_request_resource_tbl,
    workflow_monitor dbms_cloud_oci_oce_workflow_monitor_t,
    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_OCE_INSTANCE', 'UPDATE_OCE_INSTANCE', 'DELETE_OCE_INSTANCE'

status

(required) status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', '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.

workflow_monitor

(optional)

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_OCE_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oce_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_oce_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_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.us-phoenix-1.oraclecloud.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_OCE_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_oce_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_oce_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oce_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

Was this article helpful?