Oracle Cloud Infrastructure Documentation
Try Free Tier

Application Management Control Common Types

DBMS_CLOUD_OCI_APPMGMT_CONTROL_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_APPMGMT_CONTROL_ERROR_T Type

Error Information.

Syntax

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

Description of Monitored Instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_monitored_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  management_agent_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  monitoring_state varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_monitored_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_monitored_instance_t (
    instance_id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    management_agent_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    monitoring_state varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_id

(required) The OCID of monitored instance.

compartment_id

(required) Compartment Identifier OCID

display_name

(optional) A user-friendly name of the monitored instance. It is binded to Compute Instance. DisplayName is fetched from Core Service API.

management_agent_id

(optional) Management Agent Identifier OCID. Used to invoke manage operations on Management Agent Cloud Service.

time_created

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

time_updated

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

monitoring_state

(optional) Monitoring status. Can be either enabled or disabled.

Allowed values are: 'ENABLED', 'DISABLED'

lifecycle_state

(optional) The current state of the monitored instance.

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

lifecycle_details

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

DBMS_CLOUD_OCI_APPMGMT_CONTROL_MONITORED_INSTANCE_SUMMARY_T Type

Summary of the monitored instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_monitored_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  management_agent_id varchar2(32767),
  lifecycle_state varchar2(32767),
  monitoring_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_monitored_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_monitored_instance_summary_t (
    instance_id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    management_agent_id varchar2,
    lifecycle_state varchar2,
    monitoring_state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

instance_id

(required) The OCID of monitored instance.

compartment_id

(required) Compartment Identifier OCID

display_name

(optional) A user-friendly name of the monitored instance. It is binded to Compute Instance. DisplayName is fetched from Core Service API.

management_agent_id

(optional) Management Agent Identifier OCID.

lifecycle_state

(optional) The current state of the monitored instance.

monitoring_state

(optional) Monitoring status. Can be either enabled or disabled.

DBMS_CLOUD_OCI_APPMGMT_CONTROL_MONITORED_INSTANCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_appmgmt_control_monitored_instance_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_monitored_instance_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_appmgmt_control_monitored_instance_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APPMGMT_CONTROL_MONITORED_INSTANCE_COLLECTION_T Type

Results of a monitored instance search. Contains MonitoredInstanceSummary items.

Syntax

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

Fields

Field Description

items

(required) List of monitored instances.

DBMS_CLOUD_OCI_APPMGMT_CONTROL_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_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_appmgmt_control_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_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 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

DBMS_CLOUD_OCI_APPMGMT_CONTROL_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_appmgmt_control_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_appmgmt_control_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APPMGMT_CONTROL_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_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_appmgmt_control_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_appmgmt_control_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_appmgmt_control_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: 'ACTIVATE_RESOURCE_MONITORING_PLUGIN', 'PUBLISH_TOP_PROCESSES_METRICS'

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

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_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_appmgmt_control_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_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_APPMGMT_CONTROL_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_appmgmt_control_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_appmgmt_control_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APPMGMT_CONTROL_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_appmgmt_control_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_appmgmt_control_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_error_collection_t (
    items dbms_cloud_oci_appmgmt_control_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_APPMGMT_CONTROL_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_appmgmt_control_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_appmgmt_control_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_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_APPMGMT_CONTROL_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_appmgmt_control_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_appmgmt_control_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APPMGMT_CONTROL_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_appmgmt_control_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_appmgmt_control_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_log_entry_collection_t (
    items dbms_cloud_oci_appmgmt_control_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_APPMGMT_CONTROL_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_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_appmgmt_control_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_appmgmt_control_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_appmgmt_control_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: 'ACTIVATE_RESOURCE_MONITORING_PLUGIN', 'PUBLISH_TOP_PROCESSES_METRICS'

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

Nested table type of dbms_cloud_oci_appmgmt_control_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_appmgmt_control_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_appmgmt_control_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APPMGMT_CONTROL_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_appmgmt_control_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_appmgmt_control_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_appmgmt_control_work_request_summary_collection_t (
    items dbms_cloud_oci_appmgmt_control_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?