Stack Monitoring Common Types

DBMS_CLOUD_OCI_STACK_MONITORING_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_STACK_MONITORING_ANOMALY_DATA_POINT_T Type

anomaly evaluation result fo the data point

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_anomaly_data_point_t FORCE AUTHID CURRENT_USER IS OBJECT (
  anomaly number,
  low number,
  high number,
  l_timestamp timestamp with time zone,
  value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_anomaly_data_point_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_anomaly_data_point_t (
    anomaly number,
    low number,
    high number,
    l_timestamp timestamp with time zone,
    value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

anomaly

(required) if the value is anomaly or not 0 indicates not an anomaly -1 indicates value is below the threshold +1 indicates value is above the threshold

low

(optional) lower threshold for the metric value

high

(optional) upper threshold for the metric value

l_timestamp

(required) timestamp of when the metric was collected

value

(required) value for the metric data point

DBMS_CLOUD_OCI_STACK_MONITORING_ANOMALY_DATA_POINT_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_anomaly_data_point_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_anomaly_data_point_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_anomaly_data_point_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_ANOMALY_METRIC_DATA_T Type

Anomaly Metric Details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_anomaly_metric_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dimensions json_element_t,
  data_points dbms_cloud_oci_stack_monitoring_anomaly_data_point_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_anomaly_metric_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_anomaly_metric_data_t (
    dimensions json_element_t,
    data_points dbms_cloud_oci_stack_monitoring_anomaly_data_point_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dimensions

(optional) list of dimensions for the metric

data_points

(required) list of anomaly data points for the metric

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATE_MONITORED_RESOURCES_DETAILS_T Type

The information required to create new monitored resource association.

Syntax

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

Fields

Field Description

compartment_id

(required) Compartment Identifier OCID.

association_type

(required) Association type to be created between source and destination resources.

source_resource_id

(required) Source Monitored Resource Identifier OCID.

destination_resource_id

(required) Destination Monitored Resource Identifier OCID.

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATED_MONITORED_RESOURCE_T Type

The information about monitored resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_associated_monitored_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  management_agent_id varchar2(32767),
  lifecycle_state varchar2(32767),
  license varchar2(32767),
  association json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_associated_monitored_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_associated_monitored_resource_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    l_type varchar2,
    compartment_id varchar2,
    host_name varchar2,
    external_id varchar2,
    management_agent_id varchar2,
    lifecycle_state varchar2,
    license varchar2,
    association json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Monitored resource identifier OCID.

name

(optional) Monitored Resource Name.

display_name

(optional) Monitored resource display name.

l_type

(optional) Monitored Resource Type.

compartment_id

(optional) Compartment Identifier OCID.

host_name

(optional) Monitored Resource Host Name.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

management_agent_id

(optional) Management Agent Identifier OCID.

lifecycle_state

(optional) The current state of the monitored resource.

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

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

association

(optional) Association details of the resource.

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATED_MONITORED_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_associated_monitored_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_associated_monitored_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_associated_monitored_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATED_RESOURCES_SUMMARY_T Type

The information about monitored resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_associated_resources_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  management_agent_id varchar2(32767),
  lifecycle_state varchar2(32767),
  license varchar2(32767),
  associated_resources dbms_cloud_oci_stack_monitoring_associated_monitored_resource_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_associated_resources_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_associated_resources_summary_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    l_type varchar2,
    compartment_id varchar2,
    host_name varchar2,
    external_id varchar2,
    management_agent_id varchar2,
    lifecycle_state varchar2,
    license varchar2,
    associated_resources dbms_cloud_oci_stack_monitoring_associated_monitored_resource_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Monitored resource identifier OCID.

name

(optional) Monitored Resource Name.

display_name

(optional) Monitored resource display name.

l_type

(optional) Monitored Resource Type.

compartment_id

(optional) Compartment Identifier OCID.

host_name

(optional) Monitored Resource Host Name.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

management_agent_id

(optional) Management Agent Identifier OCID.

lifecycle_state

(optional) The current state of the monitored resource.

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

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

associated_resources

(optional) List of associated monitored resources.

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATED_RESOURCES_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_associated_resources_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_associated_resources_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_associated_resources_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATED_RESOURCES_COLLECTION_T Type

Results of a resources search. Contains AssociatedResourcesSummary items.

Syntax

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

Fields

Field Description

items

(required) List of associated monitored resources.

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATION_DETAILS_T Type

The information about monitored resource association.

Syntax

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

Fields

Field Description

source_resource_id

(required) Source Monitored Resource Identifier OCID.

association_type

(required) Association Type.

DBMS_CLOUD_OCI_STACK_MONITORING_ASSOCIATION_RESOURCE_DETAILS_T Type

Association Resource Details.

Syntax

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

Fields

Field Description

name

(optional) Monitored Resource Name.

l_type

(optional) Monitored Resource Type.

compartment_id

(optional) Compartment Identifier OCID.

DBMS_CLOUD_OCI_STACK_MONITORING_CONFIG_T Type

A configuration item that, for example defines whether resources of a specific type should be discovered automatically. In this case, the 'configType' is set to 'AUTO_PROMOTE' and additional fields like 'resourceType' and 'isEnabled' determine if such resources are to be discovered automatically (also referred to as 'Automatic Promotion').

Syntax

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

Fields

Field Description

id

(required) The Unique Oracle ID (OCID) that is immutable on creation.

compartment_id

(required) The OCID of the compartment containing the configuration.

display_name

(optional) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

time_created

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

time_updated

(optional) The time the Config was updated.

lifecycle_state

(required) The current state of the configuration.

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

config_type

(required) The type of configuration.

Allowed values are: 'AUTO_PROMOTE', 'LICENSE_AUTO_ASSIGN', 'LICENSE_ENTERPRISE_EXTENSIBILITY'

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

A configuration of the AUTO_PROMOTE type, consists of a resource type and a boolean value that determines if this resource needs to be automatically promoted/discovered. For example, when a Management Agent registration event occurs and if isEnabled is TRUE for a HOST resource type, a HOST resource will be automatically discovered using that Management Agent.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_auto_promote_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_t (
  resource_type varchar2(32767),
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_auto_promote_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_auto_promote_config_details_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    resource_type varchar2,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_auto_promote_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_t type.

Fields

Field Description

resource_type

(required) The type of resource to configure for automatic promotion.

Allowed values are: 'HOST'

is_enabled

(required) True if automatic promotion is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_CONFIG_SUMMARY_T Type

Summary of the configuration.

Syntax

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

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

compartment_id

(required) Compartment Identifier.

display_name

(optional) Config Identifier, can be renamed.

time_created

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

time_updated

(optional) The time the configuration was updated.

lifecycle_state

(required) The current state of the configuration.

config_type

(required) The type of configuration.

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

Summary of an AUTO_PROMOTE config.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_auto_promote_config_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_summary_t (
  resource_type varchar2(32767),
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_auto_promote_config_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_auto_promote_config_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    resource_type varchar2,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_auto_promote_config_summary_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_summary_t type.

Fields

Field Description

resource_type

(required) The type of resource to configure for automatic promotion.

Allowed values are: 'HOST'

is_enabled

(required) True if automatic promotion is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_BASELINEABLE_METRIC_T Type

Summary for the baseline-able metric

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_baselineable_metric_t FORCE AUTHID CURRENT_USER IS OBJECT (
  created_by varchar2(32767),
  last_updated_by varchar2(32767),
  time_created timestamp with time zone,
  time_last_updated timestamp with time zone,
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  tenancy_id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  l_column varchar2(32767),
  namespace varchar2(32767),
  resource_group varchar2(32767),
  is_out_of_box number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_baselineable_metric_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_baselineable_metric_t (
    created_by varchar2,
    last_updated_by varchar2,
    time_created timestamp with time zone,
    time_last_updated timestamp with time zone,
    id varchar2,
    lifecycle_state varchar2,
    tenancy_id varchar2,
    compartment_id varchar2,
    name varchar2,
    l_column varchar2,
    namespace varchar2,
    resource_group varchar2,
    is_out_of_box 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

created_by

(optional) Created user id

last_updated_by

(optional) last Updated user id

time_created

(optional) creation date

time_last_updated

(optional) last updated time

id

(required) OCID of the metric

lifecycle_state

(optional) The current lifecycle state of the metric extension

Allowed values are: 'ACTIVE', 'DELETED'

tenancy_id

(optional) OCID of the tenancy

compartment_id

(optional) OCID of the compartment

name

(required) name of the metric

l_column

(required) metric column name

namespace

(required) namespace of the metric

resource_group

(required) Resource group of the metric

is_out_of_box

(required) Is the metric created out of box, default false

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

Summary for the baseline-able metric

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  tenancy_id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  l_column varchar2(32767),
  namespace varchar2(32767),
  resource_group varchar2(32767),
  is_out_of_box number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_t (
    id varchar2,
    lifecycle_state varchar2,
    tenancy_id varchar2,
    compartment_id varchar2,
    name varchar2,
    l_column varchar2,
    namespace varchar2,
    resource_group varchar2,
    is_out_of_box 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) OCID of the metric

lifecycle_state

(optional) The current lifecycle state of the metric extension

Allowed values are: 'ACTIVE', 'DELETED'

tenancy_id

(optional) OCID of the tenancy

compartment_id

(optional) OCID of the compartment

name

(required) name of the metric

l_column

(required) metric column name

namespace

(required) namespace of the metric

resource_group

(required) Resource group of the metric

is_out_of_box

(required) Is the metric created out of box, default false

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

Nested table type of dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_baselineable_metric_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_BASELINEABLE_METRIC_SUMMARY_COLLECTION_T Type

List summary of Baseline-able metrics

Syntax

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

Fields

Field Description

items

(required) list of baseline-able metric summary

DBMS_CLOUD_OCI_STACK_MONITORING_CHANGE_CONFIG_COMPARTMENT_DETAILS_T Type

Details for which compartment to move the resource to.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_change_config_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_config_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_config_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_STACK_MONITORING_CHANGE_METRIC_EXTENSION_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_change_metric_extension_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_metric_extension_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_metric_extension_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_STACK_MONITORING_CHANGE_MONITORED_RESOURCE_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_change_monitored_resource_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_monitored_resource_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_monitored_resource_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_STACK_MONITORING_CHANGE_MONITORED_RESOURCE_TASK_COMPARTMENT_DETAILS_T Type

The information required for change of compartment for stack monitoring resource task.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_change_monitored_resource_task_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_monitored_resource_task_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_change_monitored_resource_task_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_STACK_MONITORING_CONFIG_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_config_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_config_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_config_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_CONFIG_COLLECTION_T Type

Contains a list of configurations.

Syntax

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

Fields

Field Description

items

(required) List of configurations.

DBMS_CLOUD_OCI_STACK_MONITORING_CONNECTION_DETAILS_T Type

Connection details for the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_connection_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  protocol varchar2(32767),
  port number,
  connector_id varchar2(32767),
  service_name varchar2(32767),
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  ssl_secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_connection_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_connection_details_t (
    protocol varchar2,
    port number,
    connector_id varchar2,
    service_name varchar2,
    db_unique_name varchar2,
    db_id varchar2,
    ssl_secret_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

protocol

(required) Protocol used in DB connection string when connecting to external database service.

Allowed values are: 'TCP', 'TCPS'

port

(required) Listener Port number used for connection requests.

connector_id

(optional) Database connector Identifier OCID.

service_name

(required) Service name used for connection requests.

db_unique_name

(optional) UniqueName used for database connection requests.

db_id

(optional) dbId of the database.

ssl_secret_id

(optional) SSL Secret Identifier for TCPS connector in OCI VaultOCID.

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_CONFIG_DETAILS_T Type

Create a configuration.

Syntax

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

Fields

Field Description

display_name

(optional) The display name of the configuration.

compartment_id

(required) Compartment in which the configuration is created.

config_type

(required) The type of configuration.

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

The details of an AUTO_PROMOTE configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_auto_promote_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_create_config_details_t (
  resource_type varchar2(32767),
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_auto_promote_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_auto_promote_config_details_t (
    display_name varchar2,
    compartment_id varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    resource_type varchar2,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_create_auto_promote_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_create_config_details_t type.

Fields

Field Description

resource_type

(required) The type of resource to configure for automatic promotion.

Allowed values are: 'HOST'

is_enabled

(required) True if automatic promotion is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_BASELINEABLE_METRIC_DETAILS_T Type

Summary for the baseline-able metric

Syntax

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

Fields

Field Description

compartment_id

(required) OCID of the compartment

name

(required) name of the metric

l_column

(required) metric column name

namespace

(required) namespace of the metric

resource_group

(required) Resource group of the metric

DBMS_CLOUD_OCI_STACK_MONITORING_PROPERTY_DETAILS_T Type

Property Details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_property_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  properties_map json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_property_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_property_details_t (
    properties_map json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

properties_map

(optional) Key/Value pair of Property

DBMS_CLOUD_OCI_STACK_MONITORING_CREDENTIAL_DETAILS_T Type

DiscoveryJob Credential Details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_credential_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_credential_name varchar2(32767),
  credential_type varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_property_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_credential_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_credential_details_t (
    l_credential_name varchar2,
    credential_type varchar2,
    properties dbms_cloud_oci_stack_monitoring_property_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_credential_name

(required) Name of Credential

credential_type

(required) Name of Credential Type

properties

(required)

DBMS_CLOUD_OCI_STACK_MONITORING_CREDENTIAL_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_credential_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_credential_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_credential_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_CREDENTIAL_COLLECTION_T Type

List of DiscoveryJOb Credential Details.

Syntax

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

Fields

Field Description

items

(required) List of DiscoveryJob credentials.

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_DETAILS_T Type

The request of DiscoveryJob Resource details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  agent_id varchar2(32767),
  resource_type varchar2(32767),
  resource_name varchar2(32767),
  license varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_property_details_t,
  credentials dbms_cloud_oci_stack_monitoring_credential_collection_t,
  tags dbms_cloud_oci_stack_monitoring_property_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_details_t (
    agent_id varchar2,
    resource_type varchar2,
    resource_name varchar2,
    license varchar2,
    properties dbms_cloud_oci_stack_monitoring_property_details_t,
    credentials dbms_cloud_oci_stack_monitoring_credential_collection_t,
    tags dbms_cloud_oci_stack_monitoring_property_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

agent_id

(required) The OCID of Management Agent

resource_type

(required) Resource Type.

Allowed values are: 'WEBLOGIC_DOMAIN', 'EBS_INSTANCE', 'SQL_SERVER', 'APACHE_TOMCAT', 'ORACLE_DATABASE', 'OCI_ORACLE_DB', 'OCI_ORACLE_CDB', 'OCI_ORACLE_PDB', 'HOST', 'ORACLE_PSFT', 'ORACLE_MFT', 'APACHE_HTTP_SERVER', 'ORACLE_GOLDENGATE'

resource_name

(required) The Name of resource type

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

properties

(required)

credentials

(optional)

tags

(optional)

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_DISCOVERY_JOB_DETAILS_T Type

The request of DiscoveryJob details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_discovery_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  discovery_type varchar2(32767),
  discovery_client varchar2(32767),
  compartment_id varchar2(32767),
  discovery_details dbms_cloud_oci_stack_monitoring_discovery_details_t,
  should_propagate_tags_to_discovered_resources number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_discovery_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_discovery_job_details_t (
    discovery_type varchar2,
    discovery_client varchar2,
    compartment_id varchar2,
    discovery_details dbms_cloud_oci_stack_monitoring_discovery_details_t,
    should_propagate_tags_to_discovered_resources number,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

discovery_type

(optional) Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

Allowed values are: 'ADD', 'ADD_WITH_RETRY', 'REFRESH'

discovery_client

(optional) Client who submits discovery job.

compartment_id

(required) The OCID of Compartment

discovery_details

(required)

should_propagate_tags_to_discovered_resources

(optional) If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

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

The details of a LICENSE_AUTO_ASSIGN configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_license_auto_assign_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_create_config_details_t (
  license varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_license_auto_assign_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_license_auto_assign_config_details_t (
    display_name varchar2,
    compartment_id varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    license varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_create_license_auto_assign_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_create_config_details_t type.

Fields

Field Description

license

(required) License edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_LICENSE_ENTERPRISE_EXTENSIBILITY_CONFIG_DETAILS_T Type

The details of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_license_enterprise_extensibility_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_create_config_details_t (
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_license_enterprise_extensibility_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_license_enterprise_extensibility_config_details_t (
    display_name varchar2,
    compartment_id varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_create_license_enterprise_extensibility_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_create_config_details_t type.

Fields

Field Description

is_enabled

(required) True if enterprise extensibility is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_T Type

Details of a metric which is part of this metric extension

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  display_name varchar2(32767),
  is_dimension number,
  compute_expression varchar2(32767),
  data_type varchar2(32767),
  is_hidden number,
  metric_category varchar2(32767),
  unit varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_t (
    name varchar2,
    display_name varchar2,
    is_dimension number,
    compute_expression varchar2,
    data_type varchar2,
    is_hidden number,
    metric_category varchar2,
    unit varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Name of the metric.

display_name

(optional) Display name of the metric.

is_dimension

(optional) Current metric need to be included as dimension or not

compute_expression

(optional) Compute Expression to calculate the value of this metric

data_type

(required) Data type of value of this metric

Allowed values are: 'STRING', 'NUMBER'

is_hidden

(optional) Flag to marks whether a metric has to be uploaded or not. When isHidden = false -> Metric is uploaded, isHidden = true -> Metric is NOT uploaded

metric_category

(optional) Metric category

Allowed values are: 'LOAD', 'UTILIZATION', 'CAPACITY', 'AVAILABILITY'

unit

(optional) Unit of metric value

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_QUERY_PROPERTIES_T Type

Collection method and query properties details of metric extension

Syntax

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

Fields

Field Description

collection_method

(required) Type of possible collection methods.

Allowed values are: 'OS_COMMAND', 'SQL', 'JMX'

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_metric_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_metric_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_METRIC_EXTENSION_DETAILS_T Type

The information about new metric extension resource. The combination of metric extension name and resource type should be unique in a compartment.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_metric_extension_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  display_name varchar2(32767),
  resource_type varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  collection_recurrences varchar2(32767),
  metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
  query_properties dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_metric_extension_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_metric_extension_details_t (
    name varchar2,
    display_name varchar2,
    resource_type varchar2,
    compartment_id varchar2,
    description varchar2,
    collection_recurrences varchar2,
    metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
    query_properties dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Metric Extension Resource name.

display_name

(required) Metric Extension display name.

resource_type

(required) Resource type to which Metric Extension applies

compartment_id

(required) Compartment Identifier OCID

description

(optional) Description of the metric extension.

collection_recurrences

(required) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = \"FREQ\";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are \"MINUTELY\",\"HOURLY\",\"DAILY\" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

metric_list

(required) List of metrics which are part of this metric extension

query_properties

(required)

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_PROPERTY_T Type

Property of monitored resource.

Syntax

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

Fields

Field Description

name

(optional) Property Name.

value

(optional) Property Value.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_CREDENTIAL_T Type

Monitored Resource Credential Details.

Syntax

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

Fields

Field Description

source

(optional) The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

name

(optional) The name of the credential, within the context of the source.

l_type

(optional) The type of the credential ( ex. JMXCreds,DBCreds).

description

(optional) The user-specified textual description of the credential.

credential_type

(optional) Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

Allowed values are: 'EXISTING', 'PLAINTEXT', 'ENCRYPTED'

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_ALIAS_SOURCE_CREDENTIAL_T Type

Monitored Resource Alias Reference Source Credential.

Syntax

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

Fields

Field Description

source

(required) The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63.

name

(required) The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name.

service

(required) The name of the service owning the credential. Example: stack-monitoring or dbmgmt

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_ALIAS_CREDENTIAL_T Type

Monitored Resource Alias Credential Details

Syntax

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

Fields

Field Description

source

(required) The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63.

name

(required) The name of the alias, within the context of the source.

credential

(required)

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_PROPERTY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_property_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_property_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_CREDENTIAL_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_credential_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_ALIAS_CREDENTIAL_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_MONITORED_RESOURCE_DETAILS_T Type

The information about new monitored resource to be created. The combination of monitored resource name and type should be unique across tenancy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_monitored_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  management_agent_id varchar2(32767),
  resource_time_zone varchar2(32767),
  license varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
  database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
  credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
  aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t,
  additional_credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_tbl,
  additional_aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_monitored_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_monitored_resource_details_t (
    name varchar2,
    display_name varchar2,
    l_type varchar2,
    compartment_id varchar2,
    host_name varchar2,
    external_id varchar2,
    management_agent_id varchar2,
    resource_time_zone varchar2,
    license varchar2,
    properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
    database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
    credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
    aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t,
    additional_credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_tbl,
    additional_aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Monitored Resource Name.

display_name

(optional) Monitored resource display name.

l_type

(required) Monitored Resource Type.

compartment_id

(required) Compartment Identifier OCID.

host_name

(optional) Host name of the monitored resource.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only OCI compute instance.

management_agent_id

(optional) Management Agent Identifier OCID.

resource_time_zone

(optional) Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

license

(optional) License edition of the monitored resource. If not provided the default license type for the compartment will be used.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

properties

(optional) List of monitored resource properties.

database_connection_details

(optional)

credentials

(optional)

aliases

(optional)

additional_credentials

(optional) List of MonitoredResourceCredentials. This property complements the existing \"credentials\" property by allowing user to specify more than one credential. If both \"credential\" and \"additionalCredentials\" are specified, union of the values is used as list of credentials applicable for this resource. If any duplicate found in the combined list of \"credentials\" and \"additionalCredentials\", an error will be thrown.

additional_aliases

(optional) List of MonitoredResourceAliasCredentials. This property complements the existing \"aliases\" property by allowing user to specify more than one credential alias. If both \"aliases\" and \"additionalAliases\" are specified, union of the values is used as list of aliases applicable for this resource. If any duplicate found in the combined list of \"alias\" and \"additionalAliases\", an error will be thrown.

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

The request details for the performing the task.

Syntax

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

Fields

Field Description

l_type

(required) Task type.

Allowed values are: 'IMPORT_OCI_TELEMETRY_RESOURCES'

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_MONITORED_RESOURCE_TASK_DETAILS_T Type

The request details for the stack monitoring resource task.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_create_monitored_resource_task_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  name varchar2(32767),
  task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_monitored_resource_task_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_create_monitored_resource_task_details_t (
    compartment_id varchar2,
    name varchar2,
    task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment identifier.

name

(optional) Name of the task. If not provided by default the following names will be taken OCI tasks - namespace plus timestamp.

task_details

(required)

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

The metadata details for resource type.

Syntax

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

Fields

Field Description

format

(required) ResourceType metadata format to be used. Currently supports only one format. Possible values - SYSTEM_FORMAT. * SYSTEM_FORMAT - The resource type metadata is defined in machine friendly format.

Allowed values are: 'SYSTEM_FORMAT'

DBMS_CLOUD_OCI_STACK_MONITORING_CREATE_MONITORED_RESOURCE_TYPE_DETAILS_T Type

The information about new monitored resource type. The resource type name should be unique across tenancy. A set of resource types are created by the service by default. These resource types are available for all tenancies. Service provided resource types can not be duplicated or overwritten in any tenancy.

Syntax

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

Fields

Field Description

name

(required) A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

display_name

(optional) Monitored resource type display name.

description

(optional) A friendly description.

compartment_id

(required) The OCID of the tenancy containing the resource type.

metric_namespace

(optional) Metric namespace for resource type.

metadata

(optional)

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

Monitored resource credential property.

Syntax

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

Fields

Field Description

name

(required) The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'.

value

(required) The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'.

DBMS_CLOUD_OCI_STACK_MONITORING_DATA_POINT_T Type

metric data point

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_data_point_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_timestamp timestamp with time zone,
  value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_data_point_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_data_point_t (
    l_timestamp timestamp with time zone,
    value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_timestamp

(required) timestamp of when the metric was collected

value

(required) value for the metric data point

DBMS_CLOUD_OCI_STACK_MONITORING_DISABLE_METRIC_EXTENSION_DETAILS_T Type

The Resource IDs for which metric extension will be disabled

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_disable_metric_extension_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_disable_metric_extension_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_disable_metric_extension_details_t (
    resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

resource_ids

(required) List of Resource IDs [OCIDs]. Currently supports upto 20 resources per request

DBMS_CLOUD_OCI_STACK_MONITORING_DISASSOCIATE_MONITORED_RESOURCES_DETAILS_T Type

The information required to create new monitored resource association.

Syntax

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

Fields

Field Description

compartment_id

(required) Compartment Identifier OCID.

association_type

(optional) Association type between source and destination resources.

source_resource_id

(optional) Source Monitored Resource Identifier OCID.

destination_resource_id

(optional) Destination Monitored Resource Identifier OCID.

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_JOB_T Type

The DiscoveryJob details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_job_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  discovery_type varchar2(32767),
  status varchar2(32767),
  status_message varchar2(32767),
  tenant_id varchar2(32767),
  user_id varchar2(32767),
  discovery_client varchar2(32767),
  discovery_details dbms_cloud_oci_stack_monitoring_discovery_details_t,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_t (
    id varchar2,
    compartment_id varchar2,
    discovery_type varchar2,
    status varchar2,
    status_message varchar2,
    tenant_id varchar2,
    user_id varchar2,
    discovery_client varchar2,
    discovery_details dbms_cloud_oci_stack_monitoring_discovery_details_t,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    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) The OCID of Discovery job

compartment_id

(optional) The OCID of the Compartment

discovery_type

(optional) Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

Allowed values are: 'ADD', 'ADD_WITH_RETRY', 'REFRESH'

status

(optional) Specifies the status of the discovery job

Allowed values are: 'SUCCESS', 'FAILURE', 'INPROGRESS', 'INACTIVE', 'CREATED', 'DELETED'

status_message

(optional) The short summary of the status of the discovery job

tenant_id

(optional) The OCID of Tenant

user_id

(optional) The OCID of user in which the job is submitted

discovery_client

(optional) Client who submits discovery job.

discovery_details

(optional)

time_updated

(optional) The time the discovery Job was updated.

lifecycle_state

(optional) The current state of the DiscoveryJob Resource.

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

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

The Summary of DiscoveryJob details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_job_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  resource_type varchar2(32767),
  resource_name varchar2(32767),
  license varchar2(32767),
  compartment_id varchar2(32767),
  discovery_type varchar2(32767),
  status varchar2(32767),
  status_message varchar2(32767),
  tenant_id varchar2(32767),
  user_id varchar2(32767),
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_summary_t (
    id varchar2,
    resource_type varchar2,
    resource_name varchar2,
    license varchar2,
    compartment_id varchar2,
    discovery_type varchar2,
    status varchar2,
    status_message varchar2,
    tenant_id varchar2,
    user_id varchar2,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    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) The OCID of Discovery job

resource_type

(optional) Resource Type

Allowed values are: 'WEBLOGIC_DOMAIN', 'EBS_INSTANCE', 'SQL_SERVER', 'APACHE_TOMCAT', 'ORACLE_DATABASE', 'OCI_ORACLE_DB', 'OCI_ORACLE_CDB', 'OCI_ORACLE_PDB', 'HOST', 'ORACLE_PSFT', 'ORACLE_MFT', 'APACHE_HTTP_SERVER', 'ORACLE_GOLDENGATE'

resource_name

(optional) The name of resource type

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

compartment_id

(optional) The OCID of the Compartment

discovery_type

(optional) Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

Allowed values are: 'ADD', 'ADD_WITH_RETRY', 'REFRESH'

status

(optional) Specifies the status of the discovery job

Allowed values are: 'SUCCESS', 'FAILURE', 'INPROGRESS', 'INACTIVE', 'CREATED', 'DELETED'

status_message

(optional) The short summary of the status of the discovery job

tenant_id

(optional) The OCID of Tenant

user_id

(optional) The OCID of user in which the job is submitted

time_updated

(optional) The time the discovery Job was updated.

lifecycle_state

(optional) The current state of the DiscoveryJob Resource.

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

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

Nested table type of dbms_cloud_oci_stack_monitoring_discovery_job_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_job_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_discovery_job_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_JOB_COLLECTION_T Type

Result of the discovery Job search

Syntax

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

Fields

Field Description

items

(required) List of Discovery jobs

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_JOB_LOG_SUMMARY_T Type

Log of a specific job

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  log_type varchar2(32767),
  log_message varchar2(32767),
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_t (
    id varchar2,
    log_type varchar2,
    log_message varchar2,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of Discovery job

log_type

(required) Type of log (INFO, WARNING, ERROR or SUCCESS)

Allowed values are: 'INFO', 'WARNING', 'ERROR', 'SUCCESS'

log_message

(required) Log message

time_created

(required) Time the Job log was created

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_JOB_LOG_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_discovery_job_log_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_DISCOVERY_JOB_LOG_COLLECTION_T Type

List of logs of a job

Syntax

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

Fields

Field Description

items

(required) List of logs

DBMS_CLOUD_OCI_STACK_MONITORING_ENABLE_METRIC_EXTENSION_DETAILS_T Type

The Resource IDs for which metric extension will be enabled

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_enable_metric_extension_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_enable_metric_extension_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_enable_metric_extension_details_t (
    resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

resource_ids

(required) List of Resource IDs [OCIDs]. Currently supports upto 20 resources per request

DBMS_CLOUD_OCI_STACK_MONITORING_ENABLED_RESOURCE_DETAILS_T Type

Details of a resource on which Metric Extension is enabled

Syntax

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

Fields

Field Description

resource_id

(required) The OCID of the resource on which Metric Extension is enabled

DBMS_CLOUD_OCI_STACK_MONITORING_CREDENTIAL_PROPERTY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_credential_property_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_credential_property_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_credential_property_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_ENCRYPTED_CREDENTIALS_T Type

Encrypted credentials [indicated by the type property in CredentialStore].

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_encrypted_credentials_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t (
  key_id varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_credential_property_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_encrypted_credentials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_encrypted_credentials_t (
    source varchar2,
    name varchar2,
    l_type varchar2,
    description varchar2,
    credential_type varchar2,
    key_id varchar2,
    properties dbms_cloud_oci_stack_monitoring_credential_property_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_encrypted_credentials_t is a subtype of the dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t type.

Fields

Field Description

key_id

(required) The master key should be created in OCI Vault owned by the client of this API. The user should have permission to access the vault key.

properties

(required) The credential properties list. Credential property values will be encrypted format.

DBMS_CLOUD_OCI_STACK_MONITORING_ERROR_T Type

Error Information.

Syntax

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

Nested table type of dbms_cloud_oci_stack_monitoring_data_point_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_data_point_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_data_point_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_DATA_T Type

Metric Details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dimensions json_element_t,
  training_data_points dbms_cloud_oci_stack_monitoring_data_point_tbl,
  evaluation_data_points dbms_cloud_oci_stack_monitoring_data_point_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_data_t (
    dimensions json_element_t,
    training_data_points dbms_cloud_oci_stack_monitoring_data_point_tbl,
    evaluation_data_points dbms_cloud_oci_stack_monitoring_data_point_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dimensions

(optional) list of dimensions for the metric

training_data_points

(required) list of data points for the metric for training of baseline

evaluation_data_points

(required) list of data points for the metric for evaluation of anomalies

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_DATA_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_metric_data_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_data_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_metric_data_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_EVALUATE_BASELINEABLE_METRIC_DETAILS_T Type

Details for Baseline Metric Data to evaluate

Syntax

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

Fields

Field Description

resource_id

(required) OCID of the resource

items

(required) List of Metric data

DBMS_CLOUD_OCI_STACK_MONITORING_ANOMALY_METRIC_DATA_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_anomaly_metric_data_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_anomaly_metric_data_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_anomaly_metric_data_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_EVALUATE_BASELINEABLE_METRIC_RESULT_T Type

Result for Baseline Metric Data evaluation

Syntax

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

Fields

Field Description

resource_id

(required) OCID of the resource

items

(required) List of Metric data

DBMS_CLOUD_OCI_STACK_MONITORING_IMPORT_OCI_TELEMETRY_RESOURCES_TASK_DETAILS_T Type

Request details for importing resources from Telemetry like resources from OCI Native Services and prometheus.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_import_oci_telemetry_resources_task_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t (
  source varchar2(32767),
  namespace varchar2(32767),
  resource_group varchar2(32767),
  availability_proxy_metrics dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  availability_proxy_metric_collection_interval number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_import_oci_telemetry_resources_task_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_import_oci_telemetry_resources_task_details_t (
    l_type varchar2,
    source varchar2,
    namespace varchar2,
    resource_group varchar2,
    availability_proxy_metrics dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    availability_proxy_metric_collection_interval number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_import_oci_telemetry_resources_task_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t type.

Fields

Field Description

source

(required) Source from where the metrics pushed to telemetry. Possible values: * OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from OCI Native Services. * OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.

Allowed values are: 'OCI_TELEMETRY_NATIVE', 'OCI_TELEMETRY_PROMETHEUS'

namespace

(required) Name space to be used for OCI Native service resources discovery.

resource_group

(optional) The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.

availability_proxy_metrics

(optional) List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionIntervalInSeconds'. If no metrics are specified, availability will not be calculated for the resource.

availability_proxy_metric_collection_interval

(optional) Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.

DBMS_CLOUD_OCI_STACK_MONITORING_JMX_QUERY_PROPERTIES_T Type

Query Properties applicable to JMX type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_jmx_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t (
  managed_bean_query varchar2(32767),
  jmx_attributes varchar2(32767),
  identity_metric varchar2(32767),
  auto_row_prefix varchar2(32767),
  is_metric_service_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_jmx_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_jmx_query_properties_t (
    collection_method varchar2,
    managed_bean_query varchar2,
    jmx_attributes varchar2,
    identity_metric varchar2,
    auto_row_prefix varchar2,
    is_metric_service_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_jmx_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t type.

Fields

Field Description

managed_bean_query

(required) JMX Managed Bean Query or Metric Service Table name

jmx_attributes

(required) List of JMX attributes or Metric Service Table columns separated by semi-colon

identity_metric

(optional) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics

auto_row_prefix

(optional) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned

is_metric_service_enabled

(optional) Indicates if Metric Service is enabled on server domain

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_UPDATE_QUERY_PROPERTIES_T Type

Collection method and query properties details of metric extension during update

Syntax

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

Fields

Field Description

collection_method

(required) Type of possible collection methods.

Allowed values are: 'OS_COMMAND', 'SQL', 'JMX'

DBMS_CLOUD_OCI_STACK_MONITORING_JMX_UPDATE_QUERY_PROPERTIES_T Type

Query Properties applicable to JMX type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_jmx_update_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t (
  managed_bean_query varchar2(32767),
  jmx_attributes varchar2(32767),
  identity_metric varchar2(32767),
  auto_row_prefix varchar2(32767),
  is_metric_service_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_jmx_update_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_jmx_update_query_properties_t (
    collection_method varchar2,
    managed_bean_query varchar2,
    jmx_attributes varchar2,
    identity_metric varchar2,
    auto_row_prefix varchar2,
    is_metric_service_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_jmx_update_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t type.

Fields

Field Description

managed_bean_query

(optional) JMX Managed Bean Query or Metric Service Table name

jmx_attributes

(optional) List of JMX attributes or Metric Service Table columns separated by semi-colon

identity_metric

(optional) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics

auto_row_prefix

(optional) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned

is_metric_service_enabled

(optional) Indicates if Metric Service is enabled on server domain

DBMS_CLOUD_OCI_STACK_MONITORING_LICENSE_AUTO_ASSIGN_CONFIG_DETAILS_T Type

A configuration of the LICENSE_AUTO_ASSIGN type, consists of an enumeration value which indicates which license should be assigned by default to new resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_license_auto_assign_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_t (
  license varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_auto_assign_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_auto_assign_config_details_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    license varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_license_auto_assign_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_t type.

Fields

Field Description

license

(required) License edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

DBMS_CLOUD_OCI_STACK_MONITORING_LICENSE_AUTO_ASSIGN_CONFIG_SUMMARY_T Type

Summary of a LICENSE_AUTO_ASSIGN configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_license_auto_assign_config_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_summary_t (
  license varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_auto_assign_config_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_auto_assign_config_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    license varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_license_auto_assign_config_summary_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_summary_t type.

Fields

Field Description

license

(required) License edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

DBMS_CLOUD_OCI_STACK_MONITORING_LICENSE_ENTERPRISE_EXTENSIBILITY_CONFIG_DETAILS_T Type

A configuration of the LICENSE_ENTERPRISE_EXTENSIBILITY type, consists of a boolean which determines whether enterprise extensibility is enabled.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_t (
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_details_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_t type.

Fields

Field Description

is_enabled

(required) True if enterprise extensibility is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_LICENSE_ENTERPRISE_EXTENSIBILITY_CONFIG_SUMMARY_T Type

Summary of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_config_summary_t (
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_license_enterprise_extensibility_config_summary_t is a subtype of the dbms_cloud_oci_stack_monitoring_config_summary_t type.

Fields

Field Description

is_enabled

(required) True if enterprise extensibility is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_MANAGE_LICENSE_DETAILS_T Type

License information for a given resource.

Syntax

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

Fields

Field Description

license

(required) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

DBMS_CLOUD_OCI_STACK_MONITORING_ENABLED_RESOURCE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_enabled_resource_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_enabled_resource_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_enabled_resource_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_T Type

Detailed information of the Metric Extension resource

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_extension_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  resource_type varchar2(32767),
  compartment_id varchar2(32767),
  tenant_id varchar2(32767),
  collection_method varchar2(32767),
  status varchar2(32767),
  lifecycle_state varchar2(32767),
  created_by varchar2(32767),
  last_updated_by varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  collection_recurrences varchar2(32767),
  metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
  query_properties dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t,
  enabled_on_resources dbms_cloud_oci_stack_monitoring_enabled_resource_details_tbl,
  enabled_on_resources_count number,
  resource_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_extension_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_extension_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    description varchar2,
    resource_type varchar2,
    compartment_id varchar2,
    tenant_id varchar2,
    collection_method varchar2,
    status varchar2,
    lifecycle_state varchar2,
    created_by varchar2,
    last_updated_by varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    collection_recurrences varchar2,
    metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
    query_properties dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t,
    enabled_on_resources dbms_cloud_oci_stack_monitoring_enabled_resource_details_tbl,
    enabled_on_resources_count number,
    resource_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of Metric Extension resource

name

(required) Metric Extension resource name

display_name

(required) Metric Extension resource display name

description

(optional) Description of the metric extension.

resource_type

(required) Resource type to which Metric Extension applies

compartment_id

(required) Compartment Identifier OCID

tenant_id

(required) Tenant Identifier OCID

collection_method

(required) Collection Method Metric Extension applies

status

(required) The current status of the metric extension i.e. whether it is Draft or Published

Allowed values are: 'DRAFT', 'PUBLISHED'

lifecycle_state

(optional) The current lifecycle state of the metric extension

Allowed values are: 'ACTIVE', 'DELETED'

created_by

(optional) Created by user

last_updated_by

(optional) Last updated by user

time_created

(optional) Metric Extension creation time. An RFC3339 formatted datetime string.

time_updated

(optional) Metric Extension update time. An RFC3339 formatted datetime string.

collection_recurrences

(required) Schedule of metric extension should use RFC 5545 format -> recur-rule-part = \"FREQ\";\"INTERVAL\" where FREQ rule part identifies the type of recurrence rule. Valid values are \"MINUTELY\",\"HOURLY\",\"DAILY\" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

metric_list

(required) List of metrics which are part of this metric extension

query_properties

(required)

enabled_on_resources

(optional) List of resource objects on which this metric extension is enabled.

enabled_on_resources_count

(optional) Count of resources on which this metric extension is enabled.

resource_uri

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

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_SUMMARY_T Type

Summary information about metric extension resources

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_extension_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  resource_type varchar2(32767),
  compartment_id varchar2(32767),
  status varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  collection_method varchar2(32767),
  enabled_on_resources_count number,
  resource_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_extension_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_metric_extension_summary_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    description varchar2,
    resource_type varchar2,
    compartment_id varchar2,
    status varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    collection_method varchar2,
    enabled_on_resources_count number,
    resource_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of metric extension.

name

(required) Metric Extension Resource name.

display_name

(optional) Metric Extension resource display name.

description

(optional) Description of the metric extension.

resource_type

(required) Resource type to which Metric Extension applies

compartment_id

(required) Compartment Identifier OCID

status

(required) The current state of the metric extension.

Allowed values are: 'DRAFT', 'PUBLISHED'

lifecycle_state

(optional) The current lifecycle state of the metric extension

Allowed values are: 'ACTIVE', 'DELETED'

time_created

(optional) Metric Extension creation time. An RFC3339 formatted datetime string

time_updated

(optional) Metric Extension updation time. An RFC3339 formatted datetime string

collection_method

(optional) Type of possible collection methods.

Allowed values are: 'OS_COMMAND', 'SQL', 'JMX'

enabled_on_resources_count

(optional) Count of resources on which this metric extension is enabled.

resource_uri

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

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_metric_extension_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_metric_extension_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_metric_extension_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_METRIC_EXTENSION_COLLECTION_T Type

Results of a metric extension search. Contains list of MetricExtension items.

Syntax

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

Fields

Field Description

items

(required) List of metric extensions.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_T Type

The response object for create monitored resource and get monitored resource operations. This contains information about the monitored resource. Credentials and credential aliases attributes will be returned as null due to security reasons.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  tenant_id varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  management_agent_id varchar2(32767),
  resource_time_zone varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  license varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
  database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
  credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
  aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    l_type varchar2,
    compartment_id varchar2,
    tenant_id varchar2,
    host_name varchar2,
    external_id varchar2,
    management_agent_id varchar2,
    resource_time_zone varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    license varchar2,
    properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
    database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
    credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
    aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_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) Monitored resource identifier OCID.

name

(required) Monitored resource name.

display_name

(optional) Monitored resource display name.

l_type

(required) Monitored Resource Type.

compartment_id

(required) Compartment Identifier OCID.

tenant_id

(required) Tenancy Identifier OCID.

host_name

(optional) Monitored resource host name.

external_id

(optional) The external resource identifier OCID. External resource is any OCI resource which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

management_agent_id

(optional) Management Agent Identifier OCID.

resource_time_zone

(optional) Time zone in the form of tz database canonical zone ID.

time_created

(optional) The date and time when the monitored resource was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The date and time when the monitored resource was last updated, expressed in RFC 3339 timestamp format.

lifecycle_state

(optional) Lifecycle state of the monitored resource.

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

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

properties

(optional) List of monitored resource properties.

database_connection_details

(optional)

credentials

(optional)

aliases

(optional)

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

Association details between two monitored resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_association_t FORCE AUTHID CURRENT_USER IS OBJECT (
  association_type varchar2(32767),
  compartment_id varchar2(32767),
  tenant_id varchar2(32767),
  source_resource_id varchar2(32767),
  destination_resource_id varchar2(32767),
  source_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
  destination_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
  time_created timestamp with time zone,
  category varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_association_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_association_t (
    association_type varchar2,
    compartment_id varchar2,
    tenant_id varchar2,
    source_resource_id varchar2,
    destination_resource_id varchar2,
    source_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
    destination_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
    time_created timestamp with time zone,
    category varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

association_type

(required) Association Type.

compartment_id

(required) Compartment Identifier OCID.

tenant_id

(required) Tenancy Identifier OCID.

source_resource_id

(required) Source Monitored Resource Identifier OCID.

destination_resource_id

(required) Destination Monitored Resource Identifier OCID.

source_resource_details

(optional)

destination_resource_details

(optional)

time_created

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

category

(optional) Association category. Possible values are: - System created (SYSTEM), - User created using API (USER_API) - User created using tags (USER_TAG_ASSOC).

Allowed values are: 'SYSTEM', 'USER_API', 'USER_TAG_ASSOC'

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

Summary of the monitored resource association.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  association_type varchar2(32767),
  source_resource_id varchar2(32767),
  destination_resource_id varchar2(32767),
  time_created timestamp with time zone,
  source_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
  destination_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_t (
    association_type varchar2,
    source_resource_id varchar2,
    destination_resource_id varchar2,
    time_created timestamp with time zone,
    source_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_t,
    destination_resource_details dbms_cloud_oci_stack_monitoring_association_resource_details_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

association_type

(required) Association type between source and destination resources.

source_resource_id

(required) Source Monitored Resource Identifier OCID.

destination_resource_id

(required) Destination Monitored Resource Identifier OCID.

time_created

(optional) The association creation time. An RFC3339 formatted datetime string.

source_resource_details

(optional)

destination_resource_details

(optional)

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

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_association_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_ASSOCIATIONS_COLLECTION_T Type

List of MonitoredResourceAssociationSummary elements.

Syntax

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

Fields

Field Description

items

(required) List of Monitored Resource Associations.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_SUMMARY_T Type

The information about monitored resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  management_agent_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
  license varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_summary_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    l_type varchar2,
    compartment_id varchar2,
    host_name varchar2,
    external_id varchar2,
    management_agent_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
    license varchar2,
    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) Monitored resource identifier OCID.

name

(required) Monitored Resource Name.

display_name

(optional) Monitored resource display name.

l_type

(required) Monitored Resource Type.

compartment_id

(optional) Compartment Identifier OCID.

host_name

(optional) Monitored Resource Host Name.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource.

management_agent_id

(optional) Management Agent Identifier OCID.

time_created

(optional) Monitored resource creation time. An RFC3339 formatted datetime string.

time_updated

(optional) Monitored resource update time. An RFC3339 formatted datetime string.

lifecycle_state

(optional) The current state of the monitored resource.

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

properties

(optional) List of monitored resource properties.

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

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

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_COLLECTION_T Type

Results of a resources search. Contains MonitoredResourceSummary items and other data.

Syntax

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

Fields

Field Description

items

(required) List of monitored resources.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_MEMBER_SUMMARY_T Type

Monitored resource member details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  resource_id varchar2(32767),
  resource_name varchar2(32767),
  resource_display_name varchar2(32767),
  resource_type varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  compartment_id varchar2(32767),
  parent_id varchar2(32767),
  lifecycle_state varchar2(32767),
  license varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_t (
    resource_id varchar2,
    resource_name varchar2,
    resource_display_name varchar2,
    resource_type varchar2,
    host_name varchar2,
    external_id varchar2,
    compartment_id varchar2,
    parent_id varchar2,
    lifecycle_state varchar2,
    license varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

resource_id

(optional) Monitored resource identifier OCID.

resource_name

(optional) Monitored Resource Name.

resource_display_name

(optional) Monitored resource display name.

resource_type

(optional) Monitored Resource Type.

host_name

(optional) Monitored Resource Host Name.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

compartment_id

(optional) Compartment Identifier OCID.

parent_id

(optional) Parent monitored resource identifier OCID.

lifecycle_state

(optional) The current state of the Resource.

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

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

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

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_member_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_MEMBERS_COLLECTION_T Type

Results of a member search.

Syntax

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

Fields

Field Description

items

(required) List of member resources.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_TASK_T Type

The request details for importing resources from Telemetry.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_task_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  tenant_id varchar2(32767),
  task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
  work_request_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_task_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_task_t (
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    tenant_id varchar2,
    task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
    work_request_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    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) Task identifier OCID.

name

(required) Name of the task.

compartment_id

(required) The OCID of the compartment identifier.

tenant_id

(optional) The OCID of the tenancy.

task_details

(required)

work_request_ids

(optional) Identifiers OCID for work requests submitted for this task.

time_created

(optional) The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.

lifecycle_state

(optional) The current state of the stack monitoring resource task.

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

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

The summary details for the task.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
  work_request_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_t (
    id varchar2,
    name varchar2,
    task_details dbms_cloud_oci_stack_monitoring_monitored_resource_task_details_t,
    work_request_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    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) Task identifier OCID.

name

(required) Name of the task.

task_details

(required)

work_request_ids

(optional) Identifiers OCID for work requests submitted for this task.

time_created

(optional) The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.

lifecycle_state

(optional) The current state of the stack monitoring resource task.

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

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

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_task_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_TASKS_COLLECTION_T Type

A Collection of stack monitoring resource task summaries.

Syntax

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

Fields

Field Description

items

(required) List of stack monitoring resource task summaries.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_TYPE_T Type

The response object for create monitored resource type and get monitored resource type operations.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_type_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  metric_namespace varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  metadata dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_type_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_type_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    description varchar2,
    metric_namespace varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    metadata dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_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) Monitored resource type identifier OCID.

name

(required) A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

display_name

(optional) Monitored resource type display name.

description

(optional) A friendly description.

metric_namespace

(optional) Metric namespace for resource type.

compartment_id

(required) The OCID of the tenancy containing the resource type.

lifecycle_state

(optional) Lifecycle state of the monitored resource type.

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

time_created

(optional) The date and time when the monitored resource type was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The date and time when the monitored resource was updated, expressed in RFC 3339 timestamp format.

metadata

(optional)

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

The summary of monitored resource type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  metric_namespace varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  metadata dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    description varchar2,
    metric_namespace varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    metadata dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    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) Monitored resource type identifier OCID.

name

(required) A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

display_name

(optional) Monitored resource type display name.

description

(optional) A friendly description.

metric_namespace

(optional) Metric namespace for resource type.

compartment_id

(required) The OCID of the tenancy containing the resource type.

lifecycle_state

(optional) Lifecycle state of the monitored resource type.

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

metadata

(optional)

time_created

(optional) The date and time when the monitored resource type was created, expressed in RFC 3339 timestamp format.

time_updated

(optional) The date and time when the monitored resource 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\"}}`

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

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resource_type_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCE_TYPES_COLLECTION_T Type

A Collection of monitored resource type summaries.

Syntax

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

Fields

Field Description

items

(required) List of monitored resource type summaries.

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCES_COUNT_AGGREGATION_T Type

The count of resources for specified dimension.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dimensions json_element_t,
  l_count number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_t (
    dimensions json_element_t,
    l_count number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dimensions

(required) Qualifiers provided in a metric definition. Available dimensions vary based on groupBy parameter. Each dimension takes the form of a key-value pair. Example: `\"resourceType\": \"oci_autonomous_database\"`

l_count

(required) the value of this metric

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCES_COUNT_AGGREGATION_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_monitored_resources_count_aggregation_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_MONITORED_RESOURCES_COUNT_AGGREGATION_COLLECTION_T Type

The resource count grouped by given criteria.

Syntax

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

Fields

Field Description

items

(required) The counts related to the resource and resource types.

DBMS_CLOUD_OCI_STACK_MONITORING_SCRIPT_FILE_DETAILS_T Type

Script details applicable to any OS Command based Metric Extension which needs to run a script to collect data

Syntax

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

Fields

Field Description

name

(required) Name of the script file

content

(required) Content of the script file as base64 encoded string

DBMS_CLOUD_OCI_STACK_MONITORING_OS_COMMAND_QUERY_PROPERTIES_T Type

Query Properties applicable to OS_COMMAND type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_os_command_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t (
  command varchar2(32767),
  delimiter varchar2(32767),
  script_details dbms_cloud_oci_stack_monitoring_script_file_details_t,
  arguments varchar2(32767),
  starts_with varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_os_command_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_os_command_query_properties_t (
    collection_method varchar2,
    command varchar2,
    delimiter varchar2,
    script_details dbms_cloud_oci_stack_monitoring_script_file_details_t,
    arguments varchar2,
    starts_with varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_os_command_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t type.

Fields

Field Description

command

(required) OS command to execute without arguments

delimiter

(required) Character used to delimit multiple metric values in single line of output

script_details

(optional)

arguments

(optional) Arguments required by either command or script

starts_with

(optional) String prefix used to identify metric output of the OS Command

DBMS_CLOUD_OCI_STACK_MONITORING_OS_COMMAND_UPDATE_QUERY_PROPERTIES_T Type

Query Properties applicable to OS_COMMAND type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_os_command_update_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t (
  command varchar2(32767),
  delimiter varchar2(32767),
  script_details dbms_cloud_oci_stack_monitoring_script_file_details_t,
  arguments varchar2(32767),
  starts_with varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_os_command_update_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_os_command_update_query_properties_t (
    collection_method varchar2,
    command varchar2,
    delimiter varchar2,
    script_details dbms_cloud_oci_stack_monitoring_script_file_details_t,
    arguments varchar2,
    starts_with varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_os_command_update_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t type.

Fields

Field Description

command

(optional) OS command to execute without arguments

delimiter

(optional) Character used to delimit multiple metric values in single line of output

script_details

(optional)

arguments

(optional) Arguments required by either command or script

starts_with

(optional) String prefix used to identify metric output of the OS Command

DBMS_CLOUD_OCI_STACK_MONITORING_PLAIN_TEXT_CREDENTIALS_T Type

Plain text credentials [indicated by the type property in CredentialStore].

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_plain_text_credentials_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t (
  properties dbms_cloud_oci_stack_monitoring_credential_property_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_plain_text_credentials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_plain_text_credentials_t (
    source varchar2,
    name varchar2,
    l_type varchar2,
    description varchar2,
    credential_type varchar2,
    properties dbms_cloud_oci_stack_monitoring_credential_property_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_plain_text_credentials_t is a subtype of the dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t type.

Fields

Field Description

properties

(required) The credential properties list. Credential property values will be either in plain text format or encrypted for encrypted credentials.

DBMS_CLOUD_OCI_STACK_MONITORING_PRE_EXISTING_CREDENTIALS_T Type

Pre existing credentials [indicated by the type property in CredentialStore].

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_pre_existing_credentials_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_pre_existing_credentials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_pre_existing_credentials_t (
    source varchar2,
    name varchar2,
    l_type varchar2,
    description varchar2,
    credential_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_pre_existing_credentials_t is a subtype of the dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t type.

DBMS_CLOUD_OCI_STACK_MONITORING_SEARCH_ASSOCIATED_RESOURCES_DETAILS_T Type

The criteria for searching associated monitored resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_search_associated_resources_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  resource_type varchar2(32767),
  resource_id varchar2(32767),
  limit_level number,
  association_types dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_associated_resources_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_associated_resources_details_t (
    compartment_id varchar2,
    resource_type varchar2,
    resource_id varchar2,
    limit_level number,
    association_types dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) Compartment Identifier OCID.

resource_type

(optional) A filter to return associated resources that match resources of type. Either resourceId or resourceType should be provided.

resource_id

(optional) Monitored resource identifier for which the associated resources should be fetched. Either resourceId or resourceType should be provided.

limit_level

(optional) The field which determines the depth of hierarchy while searching for associated resources. Possible values - 0 for all levels. And positive number to indicate different levels. Default value is 1, which indicates 1st level associations.

association_types

(optional) Association types filter to be searched for finding associated resources.

DBMS_CLOUD_OCI_STACK_MONITORING_SEARCH_MONITORED_RESOURCE_ASSOCIATIONS_DETAILS_T Type

The information required to search monitored resource associations.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_search_monitored_resource_associations_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  source_resource_id varchar2(32767),
  source_resource_name varchar2(32767),
  source_resource_type varchar2(32767),
  destination_resource_id varchar2(32767),
  destination_resource_name varchar2(32767),
  destination_resource_type varchar2(32767),
  association_type varchar2(32767),
  sort_by varchar2(32767),
  sort_order varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_monitored_resource_associations_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_monitored_resource_associations_details_t (
    compartment_id varchar2,
    source_resource_id varchar2,
    source_resource_name varchar2,
    source_resource_type varchar2,
    destination_resource_id varchar2,
    destination_resource_name varchar2,
    destination_resource_type varchar2,
    association_type varchar2,
    sort_by varchar2,
    sort_order varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) Compartment Identifier OCID.

source_resource_id

(optional) Source Monitored Resource Identifier OCID.

source_resource_name

(optional) Source Monitored Resource Name.

source_resource_type

(optional) Source Monitored Resource Type.

destination_resource_id

(optional) Destination Monitored Resource Identifier OCID.

destination_resource_name

(optional) Source Monitored Resource Name.

destination_resource_type

(optional) Source Monitored Resource Type.

association_type

(optional) Association type filter to search associated resources.

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for assocType is descending.

Allowed values are: 'TIME_CREATED', 'ASSOC_TYPE'

sort_order

(optional) The sort order to use, either 'ASC' or 'DESC'.

Allowed values are: 'ASC', 'DESC'

DBMS_CLOUD_OCI_STACK_MONITORING_SEARCH_MONITORED_RESOURCE_MEMBERS_DETAILS_T Type

The search criteria for listing monitored resource member targets.

Syntax

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

Fields

Field Description

destination_resource_id

(optional) Destination Monitored Resource Identifier OCID.

limit_level

(optional) The field which determines the depth of hierarchy while searching for members.

DBMS_CLOUD_OCI_STACK_MONITORING_SEARCH_MONITORED_RESOURCES_DETAILS_T Type

The property search criteria for listing monitored resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_search_monitored_resources_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  name varchar2(32767),
  name_contains varchar2(32767),
  l_type varchar2(32767),
  host_name varchar2(32767),
  external_id varchar2(32767),
  host_name_contains varchar2(32767),
  management_agent_id varchar2(32767),
  lifecycle_state varchar2(32767),
  license varchar2(32767),
  time_created_greater_than_or_equal_to timestamp with time zone,
  time_created_less_than timestamp with time zone,
  time_updated_greater_than_or_equal_to timestamp with time zone,
  time_updated_less_than timestamp with time zone,
  resource_time_zone varchar2(32767),
  sort_order varchar2(32767),
  sort_by varchar2(32767),
  property_equals json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_monitored_resources_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_search_monitored_resources_details_t (
    compartment_id varchar2,
    name varchar2,
    name_contains varchar2,
    l_type varchar2,
    host_name varchar2,
    external_id varchar2,
    host_name_contains varchar2,
    management_agent_id varchar2,
    lifecycle_state varchar2,
    license varchar2,
    time_created_greater_than_or_equal_to timestamp with time zone,
    time_created_less_than timestamp with time zone,
    time_updated_greater_than_or_equal_to timestamp with time zone,
    time_updated_less_than timestamp with time zone,
    resource_time_zone varchar2,
    sort_order varchar2,
    sort_by varchar2,
    property_equals json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) Compartment Identifier OCID.

name

(optional) A filter to return resources that match exact resource name.

name_contains

(optional) A filter to return resources that match resource name pattern given. The match is not case sensitive.

l_type

(optional) A filter to return resources that match resource type.

host_name

(optional) A filter to return resources with host name match.

external_id

(optional) External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

host_name_contains

(optional) A filter to return resources with host name pattern.

management_agent_id

(optional) A filter to return resources with matching management agent id.

lifecycle_state

(optional) A filter to return resources with matching lifecycle state.

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

license

(optional) License edition of the monitored resource.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

time_created_greater_than_or_equal_to

(optional) Search for resources that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding `timeCreatedLessThan` parameter will retrieve resources created from the given `timeCreatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z

time_created_less_than

(optional) Search for resources that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all resources created before the specified end date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z

time_updated_greater_than_or_equal_to

(optional) Search for resources that were updated within a specific date range, using this parameter to specify the earliest update date for the returned list (inclusive). Specifying this parameter without the corresponding `timeUpdatedLessThan` parameter will retrieve resources updated from the given `timeUpdatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z

time_updated_less_than

(optional) Search for resources that were updated within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding `timeUpdatedGreaterThanOrEqualTo` parameter will retrieve all resources updated before the specified end date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z

resource_time_zone

(optional) Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

sort_order

(optional) The sort order to use, either 'ASC' or 'DESC'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending.

Allowed values are: 'TIME_CREATED', 'RESOURCE_NAME'

property_equals

(optional) Criteria based on resource property.

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_DETAILS_T Type

Details of Sql content which needs to execute to collect Metric Extension data

Syntax

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

Fields

Field Description

script_file_name

(optional) If a script needs to be executed, then provide file name of the script

content

(required) Sql statement or script file content as base64 encoded string

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_IN_PARAM_DETAILS_T Type

Position and value for an IN parameter of PL/SQL statement

Syntax

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

Fields

Field Description

in_param_position

(required) Position of IN parameter

in_param_value

(required) Value of IN parameter

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_OUT_PARAM_DETAILS_T Type

Position and SQL Type of PL/SQL OUT parameter

Syntax

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

Fields

Field Description

out_param_position

(required) Position of PL/SQL procedure OUT parameter

out_param_type

(required) SQL Type of PL/SQL procedure OUT parameter

Allowed values are: 'SQL_CURSOR', 'ARRAY'

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_IN_PARAM_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_sql_in_param_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_sql_in_param_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_sql_in_param_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_QUERY_PROPERTIES_T Type

Query Properties applicable to SQL type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_sql_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t (
  sql_type varchar2(32767),
  sql_details dbms_cloud_oci_stack_monitoring_sql_details_t,
  in_param_details dbms_cloud_oci_stack_monitoring_sql_in_param_details_tbl,
  out_param_details dbms_cloud_oci_stack_monitoring_sql_out_param_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_sql_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_sql_query_properties_t (
    collection_method varchar2,
    sql_type varchar2,
    sql_details dbms_cloud_oci_stack_monitoring_sql_details_t,
    in_param_details dbms_cloud_oci_stack_monitoring_sql_in_param_details_tbl,
    out_param_details dbms_cloud_oci_stack_monitoring_sql_out_param_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_sql_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_query_properties_t type.

Fields

Field Description

sql_type

(required) Type of SQL data collection method i.e. either a Statement or SQL Script File

Allowed values are: 'STATEMENT', 'SQL_SCRIPT'

sql_details

(required)

in_param_details

(optional) List of values and position of PL/SQL procedure IN parameters

out_param_details

(optional)

DBMS_CLOUD_OCI_STACK_MONITORING_SQL_UPDATE_QUERY_PROPERTIES_T Type

Query Properties applicable to SQL type of collection method

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_sql_update_query_properties_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t (
  sql_type varchar2(32767),
  sql_details dbms_cloud_oci_stack_monitoring_sql_details_t,
  in_param_details dbms_cloud_oci_stack_monitoring_sql_in_param_details_tbl,
  out_param_details dbms_cloud_oci_stack_monitoring_sql_out_param_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_sql_update_query_properties_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_sql_update_query_properties_t (
    collection_method varchar2,
    sql_type varchar2,
    sql_details dbms_cloud_oci_stack_monitoring_sql_details_t,
    in_param_details dbms_cloud_oci_stack_monitoring_sql_in_param_details_tbl,
    out_param_details dbms_cloud_oci_stack_monitoring_sql_out_param_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_sql_update_query_properties_t is a subtype of the dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t type.

Fields

Field Description

sql_type

(optional) Type of SQL data collection method i.e. either a Statement or SQL Script File

Allowed values are: 'STATEMENT', 'SQL_SCRIPT'

sql_details

(optional)

in_param_details

(optional) List of values and position of PL/SQL procedure IN parameters

out_param_details

(optional)

DBMS_CLOUD_OCI_STACK_MONITORING_UNIQUE_PROPERTY_SET_T Type

List of properties.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_unique_property_set_t FORCE AUTHID CURRENT_USER IS OBJECT (
  properties dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_unique_property_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_unique_property_set_t (
    properties dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

properties

(required) List of properties.

DBMS_CLOUD_OCI_STACK_MONITORING_UNIQUE_PROPERTY_SET_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_unique_property_set_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_unique_property_set_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_unique_property_set_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_SYSTEM_FORMAT_RESOURCE_TYPE_METADATA_DETAILS_T Type

The resource type metadata is defined in machine friendly format.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_system_format_resource_type_metadata_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_t (
  required_properties dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  agent_properties dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  valid_properties_for_create dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  valid_properties_for_update dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  unique_property_sets dbms_cloud_oci_stack_monitoring_unique_property_set_tbl,
  valid_property_values json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_system_format_resource_type_metadata_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_system_format_resource_type_metadata_details_t (
    format varchar2,
    required_properties dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    agent_properties dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    valid_properties_for_create dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    valid_properties_for_update dbms_cloud_oci_stack_monitoring_varchar2_tbl,
    unique_property_sets dbms_cloud_oci_stack_monitoring_unique_property_set_tbl,
    valid_property_values json_element_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_system_format_resource_type_metadata_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_resource_type_metadata_details_t type.

Fields

Field Description

required_properties

(optional) List of required properties for resource type.

agent_properties

(optional) List of properties needed by the agent for monitoring the resource. Valid only if resource type is OCI management agent based. When specified, these properties are passed to the management agent during resource create or update.

valid_properties_for_create

(optional) List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail.

valid_properties_for_update

(optional) List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail.

unique_property_sets

(optional) List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name.

valid_property_values

(optional) List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: `{ \"osType\": [\"Linux\",\"Windows\",\"Solaris\"]}`

DBMS_CLOUD_OCI_STACK_MONITORING_TEST_METRIC_EXTENSION_DATA_T Type

The Test result details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_test_metric_extension_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  test_run_id varchar2(32767),
  test_run_metric_suffix varchar2(32767),
  test_run_namespace_name varchar2(32767),
  test_run_resource_group_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_test_metric_extension_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_test_metric_extension_data_t (
    test_run_id varchar2,
    test_run_metric_suffix varchar2,
    test_run_namespace_name varchar2,
    test_run_resource_group_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

test_run_id

(required) Test Run Id

test_run_metric_suffix

(required) Test Run Metric Suffix

test_run_namespace_name

(required) Test Run Namespace name

test_run_resource_group_name

(optional) Test Run Resource Group name

DBMS_CLOUD_OCI_STACK_MONITORING_TEST_METRIC_EXTENSION_DETAILS_T Type

The resource Id on which test will be run

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_test_metric_extension_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_test_metric_extension_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_test_metric_extension_details_t (
    resource_ids dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

resource_ids

(required) List of Resource IDs [OCID]. Currently supports only one resource id per request.

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_AND_PROPAGATE_TAGS_DETAILS_T Type

The information about monitored resource tags. Request will fail if at least one of freeformTags or definedTags are not specified. Provided tags will be added or updated in the existing list of tags for the affected resources. Resources to be updated are identified based on association types specified. If association types are not specified, then tags will be updated only for the current resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_and_propagate_tags_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  association_types dbms_cloud_oci_stack_monitoring_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_and_propagate_tags_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_and_propagate_tags_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    association_types dbms_cloud_oci_stack_monitoring_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

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

association_types

(optional) Association types that will be traversed recursively starting from the current resource, to identify resources for which the tags will be updated. If no association type is specified, only current resource will be updated. Default is empty list, which means no related resources will be updated.

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_CONFIG_DETAILS_T Type

Change the configuration.

Syntax

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

Fields

Field Description

display_name

(optional) The display name of the configuration.

config_type

(optional) The type of configuration.

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

Change the details of an AUTO_PROMOTE config

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_auto_promote_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_update_config_details_t (
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_auto_promote_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_auto_promote_config_details_t (
    display_name varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_update_auto_promote_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_update_config_details_t type.

Fields

Field Description

is_enabled

(optional) True if automatic promotion is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_BASELINEABLE_METRIC_DETAILS_T Type

Summary for the baseline-able metric

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_baselineable_metric_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  tenancy_id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  l_column varchar2(32767),
  namespace varchar2(32767),
  resource_group varchar2(32767),
  is_out_of_box number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_baselineable_metric_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_baselineable_metric_details_t (
    id varchar2,
    lifecycle_state varchar2,
    tenancy_id varchar2,
    compartment_id varchar2,
    name varchar2,
    l_column varchar2,
    namespace varchar2,
    resource_group varchar2,
    is_out_of_box 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) OCID of the metric

lifecycle_state

(optional) The current lifecycle state of the metric extension

Allowed values are: 'ACTIVE', 'DELETED'

tenancy_id

(optional) OCID of the tenancy

compartment_id

(optional) OCID of the compartment

name

(required) name of the metric

l_column

(required) metric column name

namespace

(required) namespace of the metric

resource_group

(required) Resource group of the metric

is_out_of_box

(required) Is the metric created out of box, default false

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

Change the details of a LICENSE_AUTO_ASSIGN configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_license_auto_assign_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_update_config_details_t (
  license varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_license_auto_assign_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_license_auto_assign_config_details_t (
    display_name varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    license varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_update_license_auto_assign_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_update_config_details_t type.

Fields

Field Description

license

(optional) License edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_LICENSE_ENTERPRISE_EXTENSIBILITY_CONFIG_DETAILS_T Type

Change the details of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_license_enterprise_extensibility_config_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_stack_monitoring_update_config_details_t (
  is_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_license_enterprise_extensibility_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_license_enterprise_extensibility_config_details_t (
    display_name varchar2,
    config_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_enabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_stack_monitoring_update_license_enterprise_extensibility_config_details_t is a subtype of the dbms_cloud_oci_stack_monitoring_update_config_details_t type.

Fields

Field Description

is_enabled

(optional) True if enterprise extensibility is enabled, false if it is not enabled.

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_METRIC_EXTENSION_DETAILS_T Type

The information about updating a metric extension resource

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_metric_extension_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  collection_recurrences varchar2(32767),
  metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
  query_properties dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_metric_extension_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_metric_extension_details_t (
    display_name varchar2,
    description varchar2,
    collection_recurrences varchar2,
    metric_list dbms_cloud_oci_stack_monitoring_metric_tbl,
    query_properties dbms_cloud_oci_stack_monitoring_metric_extension_update_query_properties_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Metric Extension resource display name.

description

(optional) Description of the metric extension.

collection_recurrences

(optional) Schedule of metric extension should use RFC 5545 format -> recur-rule-part = \"FREQ\";\"INTERVAL\" where FREQ rule part identifies the type of recurrence rule. Valid values are \"MINUTELY\",\"HOURLY\",\"DAILY\" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

metric_list

(optional) List of metrics which are part of this metric extension

query_properties

(optional)

DBMS_CLOUD_OCI_STACK_MONITORING_UPDATE_MONITORED_RESOURCE_DETAILS_T Type

The information about updating a monitored resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_update_monitored_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  host_name varchar2(32767),
  resource_time_zone varchar2(32767),
  properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
  database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
  credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
  aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t,
  additional_credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_tbl,
  additional_aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_monitored_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_update_monitored_resource_details_t (
    display_name varchar2,
    host_name varchar2,
    resource_time_zone varchar2,
    properties dbms_cloud_oci_stack_monitoring_monitored_resource_property_tbl,
    database_connection_details dbms_cloud_oci_stack_monitoring_connection_details_t,
    credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_t,
    aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_t,
    additional_credentials dbms_cloud_oci_stack_monitoring_monitored_resource_credential_tbl,
    additional_aliases dbms_cloud_oci_stack_monitoring_monitored_resource_alias_credential_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Monitored resource display name.

host_name

(optional) Host name of the monitored resource.

resource_time_zone

(optional) Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

properties

(optional) List of monitored resource properties.

database_connection_details

(optional)

credentials

(optional)

aliases

(optional)

additional_credentials

(optional) List of MonitoredResourceCredentials. This property complements the existing \"credentials\" property by allowing user to specify more than one credential. If both \"credential\" and \"additionalCredentials\" are specified, union of the values is used as list of credentials applicable for this resource. If any duplicate found in the combined list of \"credentials\" and \"additionalCredentials\", an error will be thrown.

additional_aliases

(optional) List of MonitoredResourceAliasCredentials. This property complements the existing \"aliases\" property by allowing user to specify more than one credential alias. If both \"aliases\" and \"additionalAliases\" are specified, union of the values is used as list of aliases applicable for this resource. If any duplicate found in the combined list of \"alias\" and \"additionalAliases\", an error will be thrown.

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

The request details for the stack monitoring resource task.

Syntax

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

Fields

Field Description

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

The information to be updated for the monitored resource type.

Syntax

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

Fields

Field Description

display_name

(optional) Monitored resource type display name.

description

(optional) A friendly description.

metric_namespace

(optional) Metric namespace for resource type.

metadata

(optional)

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

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_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_stack_monitoring_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_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_STACK_MONITORING_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_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_stack_monitoring_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_stack_monitoring_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_stack_monitoring_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_RESOURCES', 'UPDATE_RESOURCES', 'DELETE_RESOURCES', 'MOVE_RESOURCES', 'ENABLE_EXTERNAL_DATABASE', 'DISABLE_EXTERNAL_DATABASE', 'ADD_SOURCES_TO_AGENT', 'ENABLE_METRIC_EXTENSION', 'DISABLE_METRIC_EXTENSION', 'TEST_METRIC_EXTENSION', 'BULK_ADD_RESOURCES', 'BULK_DELETE_RESOURCES', 'UPDATE_AND_PROPAGATE_TAGS', 'IMPORT_RESOURCES'

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

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_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_stack_monitoring_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_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_STACK_MONITORING_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_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_stack_monitoring_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_stack_monitoring_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_error_collection_t (
    items dbms_cloud_oci_stack_monitoring_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_STACK_MONITORING_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_stack_monitoring_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_stack_monitoring_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_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_STACK_MONITORING_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_stack_monitoring_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_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_stack_monitoring_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_stack_monitoring_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_log_entry_collection_t (
    items dbms_cloud_oci_stack_monitoring_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_STACK_MONITORING_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_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_stack_monitoring_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_stack_monitoring_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_stack_monitoring_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_RESOURCES', 'UPDATE_RESOURCES', 'DELETE_RESOURCES', 'MOVE_RESOURCES', 'ENABLE_EXTERNAL_DATABASE', 'DISABLE_EXTERNAL_DATABASE', 'ADD_SOURCES_TO_AGENT', 'ENABLE_METRIC_EXTENSION', 'DISABLE_METRIC_EXTENSION', 'TEST_METRIC_EXTENSION', 'BULK_ADD_RESOURCES', 'BULK_DELETE_RESOURCES', 'UPDATE_AND_PROPAGATE_TAGS', 'IMPORT_RESOURCES'

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

Nested table type of dbms_cloud_oci_stack_monitoring_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_stack_monitoring_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_stack_monitoring_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STACK_MONITORING_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_stack_monitoring_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_stack_monitoring_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_stack_monitoring_work_request_summary_collection_t (
    items dbms_cloud_oci_stack_monitoring_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?