Oracle Cloud Infrastructure Documentation
Try Free Tier

OCI Control Center Common Types

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_DIMENSION_VALUE_T Type

The dimension value for the given dimension name as key.

Syntax

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

Fields

Field Description

dimension_value

(optional) The value of the dimension.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_ERROR_T Type

Error Information.

Syntax

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

A summary of the properties that define a metric.

Syntax

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

Fields

Field Description

metric_name

(required) The name of the metric.

dimensions

(optional) Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_METRIC_PROPERTY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_oci_control_center_metric_property_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oci_control_center_metric_property_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oci_control_center_metric_property_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_METRIC_PROPERTY_COLLECTION_T Type

A list of available metrics and their associated properties such as dimensions.

Syntax

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

Fields

Field Description

items

(required) An array of MetricPropertySummary objects.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_NAMESPACE_SUMMARY_T Type

A summary of the source service or application emitting the metric.

Syntax

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

Fields

Field Description

namespace_name

(required) The name of the source service emitting the metric.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_NAMESPACE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_oci_control_center_namespace_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oci_control_center_namespace_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oci_control_center_namespace_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_NAMESPACE_COLLECTION_T Type

The list of source services called namespaces emitting metrics that you can explore using OCI Control Center.

Syntax

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

Fields

Field Description

items

(required) An array of NamespaceSummary objects.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_REQUEST_SUMMARIZED_METRIC_DATA_DETAILS_T Type

The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oci_control_center_request_summarized_metric_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  namespace_name varchar2(32767),
  metric_name varchar2(32767),
  compartment_id varchar2(32767),
  dimensions json_element_t,
  start_time timestamp with time zone,
  end_time timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oci_control_center_request_summarized_metric_data_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oci_control_center_request_summarized_metric_data_details_t (
    namespace_name varchar2,
    metric_name varchar2,
    compartment_id varchar2,
    dimensions json_element_t,
    start_time timestamp with time zone,
    end_time timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

namespace_name

(required) The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see LIST_NAMESPACES Function.

metric_name

(required) The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see LIST_METRIC_PROPERTIES Function.

compartment_id

(required) The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.

dimensions

(optional) Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see LIST_METRIC_PROPERTIES Function.

start_time

(optional) The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href=\"https://www.rfc-editor.org/rfc/rfc3339\">RFC3339</a>. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z

end_time

(optional) The end of the sampled time range to use when searching for metric data points. Format is defined by <a href=\"https://www.rfc-editor.org/rfc/rfc3339\">RFC3339</a>. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_SUMMARIZED_METRIC_DATA_T Type

The recorded metric value at a specific timestamp.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oci_control_center_summarized_metric_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  sample_time timestamp with time zone,
  resolution varchar2(32767),
  dimensions json_element_t,
  aggregation_method varchar2(32767),
  aggregated_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oci_control_center_summarized_metric_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_oci_control_center_summarized_metric_data_t (
    sample_time timestamp with time zone,
    resolution varchar2,
    dimensions json_element_t,
    aggregation_method varchar2,
    aggregated_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

sample_time

(optional) The time at which the metric data was recorded.

resolution

(optional) The duration over which the metric data is aggregated. Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.

dimensions

(optional) Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace.

aggregation_method

(optional) The aggregation method used for aggregating the metric values. The aggregation method depends on the metric itself.

aggregated_value

(optional) The aggregated metric value for the specified request.

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_SUMMARIZED_METRIC_DATA_TBL Type

Nested table type of dbms_cloud_oci_oci_control_center_summarized_metric_data_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oci_control_center_summarized_metric_data_tbl FORCE IS TABLE OF (dbms_cloud_oci_oci_control_center_summarized_metric_data_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OCI_CONTROL_CENTER_SUMMARIZED_METRIC_DATA_COLLECTION_T Type

A list of aggregated metric data objects with properties.

Syntax

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

Fields

Field Description

items

(required) An array of SummarizedMetricData items.

Was this article helpful?