Oracle Cloud Infrastructure Documentation

Application Performance Monitoring Control Plane Common Types

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_APM_DOMAIN_T Type

Details of an APM domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_apm_domain_t FORCE AUTHID CURRENT_USER IS OBJECT (
  data_upload_endpoint varchar2(32767),
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  is_free_tier number,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_apm_domain_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_apm_domain_t (
    data_upload_endpoint varchar2,
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    is_free_tier number,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

data_upload_endpoint

(optional) The endpoint where the APM agents upload their observations and metrics.

id

(required) Unique identifier that is immutable on creation.

display_name

(required) Display name of the APM domain, which can be updated.

description

(optional) Description of the APM domain.

compartment_id

(required) The OCID of the compartment corresponding to the APM domain.

lifecycle_state

(optional) The current lifecycle state of the APM domain.

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

is_free_tier

(optional) Indicates if this is an Always Free resource.

time_created

(optional) The time the APM domain was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The time the APM domain was updated, expressed in RFC 3339 timestamp format.

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

Summary of an APM domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_apm_domain_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  is_free_tier number,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_apm_domain_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_apm_domain_summary_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    is_free_tier number,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_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) Display name of the APM domain, which can be updated.

description

(optional) Description of the APM domain.

compartment_id

(required) The OCID of the compartment corresponding to the APM domain.

lifecycle_state

(optional) The current lifecycle state of the APM domain.

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

is_free_tier

(optional) Indicates if this is an Always Free resource.

time_created

(optional) The time the APM domain was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The time the APM domain was updated, expressed in RFC 3339 timestamp format.

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

Details for an APM domain.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_base_domain_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  is_free_tier number,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_base_domain_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_base_domain_details_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    is_free_tier number,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_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) Display name of the APM domain, which can be updated.

description

(optional) Description of the APM domain.

compartment_id

(required) The OCID of the compartment corresponding to the APM domain.

lifecycle_state

(optional) The current lifecycle state of the APM domain.

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

is_free_tier

(optional) Indicates if this is an Always Free resource.

time_created

(optional) The time the APM domain was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The time the APM domain was updated, expressed in RFC 3339 timestamp format.

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

The information about a Data Key.

Syntax

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

Fields

Field Description

name

(required) Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.

l_type

(required) Type of the Data Key.

Allowed values are: 'PRIVATE', 'PUBLIC'

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_CHANGE_APM_DOMAIN_COMPARTMENT_DETAILS_T Type

The information needed for the change compartment operation.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the destination compartment for the APM domain.

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_CREATE_APM_DOMAIN_DETAILS_T Type

The information about the new APM domain.

Syntax

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

Fields

Field Description

display_name

(required) Display name of the APM domain.

description

(optional) Description of the APM domain.

compartment_id

(required) The OCID of the compartment corresponding to the APM domain.

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\"}}`

is_free_tier

(optional) Indicates whether this is an \"Always Free\" resource. The default value is false.

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_DATA_KEY_T Type

The information about a Data Key, including the Data Key's value.

Syntax

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

Fields

Field Description

value

(optional) Value of the Data Key.

name

(required) Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.

l_type

(required) Type of the Data Key.

Allowed values are: 'PRIVATE', 'PUBLIC'

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_DATA_KEY_SUMMARY_T Type

Summary of Data Key.

Syntax

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

Fields

Field Description

value

(optional) Value of the Data Key.

name

(required) Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.

l_type

(required) Type of the Data Key.

Allowed values are: 'PRIVATE', 'PUBLIC'

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_ERROR_T Type

The details of an error that occurred.

Syntax

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

Details of the Data Key to be generated.

Syntax

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

Fields

Field Description

name

(required) Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.

l_type

(required) Type of the Data Key.

Allowed values are: 'PRIVATE', 'PUBLIC'

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_REMOVE_DATA_KEY_DETAILS_T Type

Details of the Data Key to be removed.

Syntax

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

Fields

Field Description

name

(required) Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_UPDATE_APM_DOMAIN_DETAILS_T Type

The information that can be updated by update APM domain operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_update_apm_domain_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_apm_control_plane_update_apm_domain_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_update_apm_domain_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) Display name of the APM domain.

description

(optional) Description of the APM domain.

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

The details of the resource that the work request affects.

Syntax

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

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

Nested table type of dbms_cloud_oci_apm_control_plane_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_control_plane_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_WORK_REQUEST_T Type

A description of work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_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_apm_control_plane_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_apm_control_plane_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_apm_control_plane_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) The type of the work request.

Allowed values are: 'CREATE_APM_DOMAIN', 'UPDATE_APM_DOMAIN', 'DELETE_APM_DOMAIN', 'GENERATE_DATA_KEYS', 'REMOVE_DATA_KEYS'

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.

resources

(required) The resources affected by the 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, section 14.29.

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_control_plane_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_apm_control_plane_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_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 occurred. Error codes are listed at API Errors

message

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

l_timestamp

(required) The time the error occurred, expressed in RFC 3339 timestamp format.

DBMS_CLOUD_OCI_APM_CONTROL_PLANE_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_apm_control_plane_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_apm_control_plane_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_control_plane_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 error occurred, expressed in RFC 3339 timestamp format.