Application Performance Monitoring Synthetics Common Types

DBMS_CLOUD_OCI_APM_SYNTHETICS_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_APM_SYNTHETICS_NUMBER_TBL Type

Nested table type of number.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_number_tbl FORCE IS TABLE OF (number) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_EXECUTION_T Type

Details of a vantage point execution.

Syntax

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

Fields

Field Description

name

(optional) Name of the vantage point.

executions

(optional) List of execution times in milliseconds.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_EXECUTION_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_vantage_point_execution_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_vantage_point_execution_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_vantage_point_execution_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_AGGREGATE_NETWORK_DATA_DETAILS_T Type

Details of the vantage point and corresponding execution times.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_aggregate_network_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  vantage_point_execution_times dbms_cloud_oci_apm_synthetics_vantage_point_execution_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregate_network_data_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregate_network_data_details_t (
    vantage_point_execution_times dbms_cloud_oci_apm_synthetics_vantage_point_execution_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

vantage_point_execution_times

(required) List of VantagePointExecution items.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_NODE_T Type

Details of the vantage point node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_vantage_point_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  display_name varchar2(32767),
  geo_info varchar2(32767),
  outgoing_links dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_vantage_point_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_vantage_point_node_t (
    id varchar2,
    name varchar2,
    display_name varchar2,
    geo_info varchar2,
    outgoing_links dbms_cloud_oci_apm_synthetics_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) ID of the vantage point node.

name

(required) Name of the vantage point node.

display_name

(optional) Display name of the vantage point node.

geo_info

(optional) Geographical information of the vantage point node.

outgoing_links

(optional) Outgoing links from the vantage point node.

DBMS_CLOUD_OCI_APM_SYNTHETICS_LINK_T Type

Details of the link between two nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_link_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  source varchar2(32767),
  destination varchar2(32767),
  repeat_count number,
  forwarding_loss number,
  delay_in_milliseconds number,
  min_delay_in_milliseconds number,
  max_delay_in_milliseconds number,
  paths dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_link_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_link_t (
    id varchar2,
    source varchar2,
    destination varchar2,
    repeat_count number,
    forwarding_loss number,
    delay_in_milliseconds number,
    min_delay_in_milliseconds number,
    max_delay_in_milliseconds number,
    paths dbms_cloud_oci_apm_synthetics_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) ID of the link.

source

(optional) ID of the source node.

destination

(optional) ID of the destination node.

repeat_count

(optional) Number of times the link is repeated.

forwarding_loss

(optional) Average packet loss.

delay_in_milliseconds

(optional) Difference of the packet response time between source and destination nodes, in milliseconds.

min_delay_in_milliseconds

(optional) Minimum delay in milliseconds.

max_delay_in_milliseconds

(optional) Maximum delay in milliseconds.

paths

(optional) List of all path IDs of which this link is part of.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_NODE_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_vantage_point_node_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_vantage_point_node_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_vantage_point_node_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_AGGREGATED_NETWORK_DATA_T Type

Details of the aggregated network data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_aggregated_network_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  result_state varchar2(32767),
  vantage_point_nodes dbms_cloud_oci_apm_synthetics_vantage_point_node_tbl,
  nodes_by_level json_array_t,
  links json_element_t,
  error_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregated_network_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregated_network_data_t (
    result_state varchar2,
    vantage_point_nodes dbms_cloud_oci_apm_synthetics_vantage_point_node_tbl,
    nodes_by_level json_array_t,
    links json_element_t,
    error_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

result_state

(required) Status of the aggregated network data result.

Allowed values are: 'SUCCESS', 'FAILURE', 'PARTIAL'

vantage_point_nodes

(optional) List of vantage point nodes.

nodes_by_level

(optional) An array of node arrays where each internal array corresponds to nodes at one level.

links

(optional) Map of link objects.

error_details

(optional) String containing error details.

DBMS_CLOUD_OCI_APM_SYNTHETICS_AGGREGATED_NETWORK_DATA_RESULT_T Type

The aggregated network results.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_aggregated_network_data_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  aggregated_network_data dbms_cloud_oci_apm_synthetics_aggregated_network_data_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregated_network_data_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_aggregated_network_data_result_t (
    aggregated_network_data dbms_cloud_oci_apm_synthetics_aggregated_network_data_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

aggregated_network_data

(required)

DBMS_CLOUD_OCI_APM_SYNTHETICS_AVAILABILITY_CONFIGURATION_T Type

Monitor availability configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_availability_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  max_allowed_failures_per_interval number,
  min_allowed_runs_per_interval number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_availability_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_availability_configuration_t (
    max_allowed_failures_per_interval number,
    min_allowed_runs_per_interval number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

max_allowed_failures_per_interval

(optional) Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.

min_allowed_runs_per_interval

(optional) Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.

DBMS_CLOUD_OCI_APM_SYNTHETICS_DNS_CONFIGURATION_T Type

Information about the DNS settings.

Syntax

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

Fields

Field Description

is_override_dns

(optional) If isOverrideDns is true, then DNS settings will be overridden.

override_dns_ip

(optional) Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VERIFY_TEXT_T Type

Details to verify text.

Syntax

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

Fields

Field Description

text

(optional) Verification text in the response.

DBMS_CLOUD_OCI_APM_SYNTHETICS_NETWORK_CONFIGURATION_T Type

Details of the network configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_network_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  number_of_hops number,
  probe_per_hop number,
  transmission_rate number,
  protocol varchar2(32767),
  probe_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_network_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_network_configuration_t (
    number_of_hops number,
    probe_per_hop number,
    transmission_rate number,
    protocol varchar2,
    probe_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

number_of_hops

(optional) Number of hops.

probe_per_hop

(optional) Number of probes per hop.

transmission_rate

(optional) Number of probe packets sent out simultaneously.

protocol

(optional) Type of protocol.

Allowed values are: 'ICMP', 'TCP'

probe_mode

(optional) Type of probe mode when TCP protocol is selected.

Allowed values are: 'SACK', 'SYN'

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_CONFIGURATION_T Type

Details of monitor configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  config_type varchar2(32767),
  is_failure_retried number,
  dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

config_type

(optional) Type of configuration.

Allowed values are: 'BROWSER_CONFIG', 'SCRIPTED_BROWSER_CONFIG', 'REST_CONFIG', 'SCRIPTED_REST_CONFIG', 'NETWORK_CONFIG'

is_failure_retried

(optional) If isFailureRetried is enabled, then a failed call will be retried.

dns_configuration

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_VERIFY_TEXT_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_verify_text_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_verify_text_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_verify_text_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_BROWSER_MONITOR_CONFIGURATION_T Type

Configuration details for the BROWSER monitor type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_browser_monitor_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
  is_certificate_validation_enabled number,
  is_default_snapshot_enabled number,
  verify_texts dbms_cloud_oci_apm_synthetics_verify_text_tbl,
  verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_browser_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_browser_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
    is_certificate_validation_enabled number,
    is_default_snapshot_enabled number,
    verify_texts dbms_cloud_oci_apm_synthetics_verify_text_tbl,
    verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_browser_monitor_configuration_t is a subtype of the dbms_cloud_oci_apm_synthetics_monitor_configuration_t type.

Fields

Field Description

is_certificate_validation_enabled

(optional) If certificate validation is enabled, then the call will fail in case of certification errors.

is_default_snapshot_enabled

(optional) If disabled, auto snapshots are not collected.

verify_texts

(optional) Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

verify_response_codes

(optional) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

network_configuration

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_CLIENT_CERTIFICATE_T Type

Client certificate in PEM format.

Syntax

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

Fields

Field Description

file_name

(required) Name of the certificate file. The name should not contain any confidential information.

content

(required) Content of the client certificate file.

DBMS_CLOUD_OCI_APM_SYNTHETICS_PRIVATE_KEY_T Type

The private key associated with the client certificate in PEM format.

Syntax

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

Fields

Field Description

file_name

(required) Name of the private key file.

content

(required) Content of the private key file.

DBMS_CLOUD_OCI_APM_SYNTHETICS_CLIENT_CERTIFICATE_DETAILS_T Type

Details for client certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_client_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  client_certificate dbms_cloud_oci_apm_synthetics_client_certificate_t,
  private_key dbms_cloud_oci_apm_synthetics_private_key_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_client_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_client_certificate_details_t (
    client_certificate dbms_cloud_oci_apm_synthetics_client_certificate_t,
    private_key dbms_cloud_oci_apm_synthetics_private_key_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

client_certificate

(optional)

private_key

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_DVP_STACK_DETAILS_T Type

Details of a Dedicated Vantage Point (DVP) stack in Resource Manager.

Syntax

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

Fields

Field Description

dvp_stack_type

(required) Type of stack.

Allowed values are: 'ORACLE_RM_STACK'

dvp_version

(required) Version of the dedicated vantage point.

DBMS_CLOUD_OCI_APM_SYNTHETICS_CREATE_DEDICATED_VANTAGE_POINT_DETAILS_T Type

Details of the request body used to create a new dedicated vantage point.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_create_dedicated_vantage_point_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
  l_region varchar2(32767),
  status varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_dedicated_vantage_point_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_dedicated_vantage_point_details_t (
    display_name varchar2,
    dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
    l_region varchar2,
    status varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information.

dvp_stack_details

(required)

l_region

(required) Name of the region.

status

(optional) Status of the dedicated vantage point.

Allowed values are: 'ENABLED', 'DISABLED'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SCRIPT_PARAMETER_T Type

Details of the script parameter that can be used to overwrite the parameter present in the script.

Syntax

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

Fields

Field Description

param_name

(required) Name of the parameter.

param_value

(required) Value of the parameter.

DBMS_CLOUD_OCI_APM_SYNTHETICS_MAINTENANCE_WINDOW_SCHEDULE_T Type

Details required to schedule maintenance window.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t (
    time_started timestamp with time zone,
    time_ended timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_started

(optional) Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_ended

(optional) End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SCRIPT_PARAMETER_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_monitor_script_parameter_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_script_parameter_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_monitor_script_parameter_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_CREATE_MONITOR_DETAILS_T Type

Details of the request body used to create a new monitor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_create_monitor_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  monitor_type varchar2(32767),
  vantage_points dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  script_id varchar2(32767),
  status varchar2(32767),
  repeat_interval_in_seconds number,
  is_run_once number,
  timeout_in_seconds number,
  target varchar2(32767),
  script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_tbl,
  configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
  availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
  maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_run_now number,
  scheduling_policy varchar2(32767),
  batch_interval_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_monitor_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_monitor_details_t (
    display_name varchar2,
    monitor_type varchar2,
    vantage_points dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    script_id varchar2,
    status varchar2,
    repeat_interval_in_seconds number,
    is_run_once number,
    timeout_in_seconds number,
    target varchar2,
    script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_tbl,
    configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
    availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
    maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_run_now number,
    scheduling_policy varchar2,
    batch_interval_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

monitor_type

(required) Type of monitor.

Allowed values are: 'SCRIPTED_BROWSER', 'BROWSER', 'SCRIPTED_REST', 'REST', 'NETWORK'

vantage_points

(required) A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.

script_id

(optional) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status

(optional) Enables or disables the monitor.

Allowed values are: 'ENABLED', 'DISABLED', 'INVALID'

repeat_interval_in_seconds

(required) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

is_run_once

(optional) If runOnce is enabled, then the monitor will run once.

timeout_in_seconds

(optional) Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

target

(optional) Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80

script_parameters

(optional) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{\"paramName\": \"userid\", \"paramValue\":\"testuser\"}]`

configuration

(optional)

availability_configuration

(optional)

maintenance_window_schedule

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

is_run_now

(optional) If isRunNow is enabled, then the monitor will run immediately.

scheduling_policy

(optional) Scheduling policy to decide the distribution of monitor executions on vantage points.

Allowed values are: 'ALL', 'ROUND_ROBIN', 'BATCHED_ROUND_ROBIN'

batch_interval_in_seconds

(optional) Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_PARAMETER_T Type

Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the script content.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_parameter_t FORCE AUTHID CURRENT_USER IS OBJECT (
  param_name varchar2(32767),
  param_value varchar2(32767),
  is_secret number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_parameter_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_parameter_t (
    param_name varchar2,
    param_value varchar2,
    is_secret number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

param_name

(required) Name of the parameter.

param_value

(optional) Value of the parameter.

is_secret

(optional) If the parameter value is secret and should be kept confidential, then set isSecret to true.

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_PARAMETER_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_script_parameter_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_parameter_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_script_parameter_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_CREATE_SCRIPT_DETAILS_T Type

Details of the request body used to create a new script. Only Side or JavaScript content types are supported and content should be in Side or JavaScript formats only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_create_script_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  content_type varchar2(32767),
  content varchar2(32767),
  content_file_name varchar2(32767),
  parameters dbms_cloud_oci_apm_synthetics_script_parameter_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_script_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_create_script_details_t (
    display_name varchar2,
    content_type varchar2,
    content varchar2,
    content_file_name varchar2,
    parameters dbms_cloud_oci_apm_synthetics_script_parameter_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

content_type

(required) Content type of script.

Allowed values are: 'SIDE', 'JS'

content

(required) The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `<ORAP><ON>param name</ON></ORAP>` With parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.

content_file_name

(optional) File name of uploaded script content.

parameters

(optional) List of script parameters. Example: `[{\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": 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\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_STATUS_COUNT_MAP_T Type

Details of the monitor count per state. Example: `{ \"total\" : 5, \"enabled\" : 3 , \"disabled\" : 2, \"invalid\" : 0 }`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t FORCE AUTHID CURRENT_USER IS OBJECT (
  total number,
  enabled number,
  disabled number,
  invalid number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t (
    total number,
    enabled number,
    disabled number,
    invalid number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

total

(required) Total number of monitors using the script.

enabled

(required) Number of enabled monitors using the script.

disabled

(required) Number of disabled monitors using the script.

invalid

(required) Number of invalid monitors using the script.

DBMS_CLOUD_OCI_APM_SYNTHETICS_DEDICATED_VANTAGE_POINT_T Type

The information about a dedicated vantage point.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  name varchar2(32767),
  status varchar2(32767),
  dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
  l_region varchar2(32767),
  monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_t (
    id varchar2,
    display_name varchar2,
    name varchar2,
    status varchar2,
    dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
    l_region varchar2,
    monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the dedicated vantage point.

display_name

(required) Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information.

name

(required) Unique permanent name of the dedicated vantage point. This is the same as the displayName.

status

(required) Status of the dedicated vantage point.

Allowed values are: 'ENABLED', 'DISABLED'

dvp_stack_details

(required)

l_region

(required) Name of the region.

monitor_status_count_map

(required)

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_DEDICATED_VANTAGE_POINT_SUMMARY_T Type

Information about dedicated vantage points.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  name varchar2(32767),
  status varchar2(32767),
  dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
  l_region varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_t (
    id varchar2,
    display_name varchar2,
    name varchar2,
    status varchar2,
    dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
    l_region varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the dedicated vantage point.

display_name

(required) Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information.

name

(required) Unique permanent name of the vantage point.

status

(required) Status of the dedicated vantage point.

Allowed values are: 'ENABLED', 'DISABLED'

dvp_stack_details

(required)

l_region

(required) Name of the region.

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

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

monitor_status_count_map

(required)

DBMS_CLOUD_OCI_APM_SYNTHETICS_DEDICATED_VANTAGE_POINT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_dedicated_vantage_point_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_DEDICATED_VANTAGE_POINT_COLLECTION_T Type

The results of a dedicated vantage point search, which contains DedicatedVantagePointSummary items and other data in an APM domain.

Syntax

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

Fields

Field Description

items

(required) List of DedicatedVantagePointSummary items.

DBMS_CLOUD_OCI_APM_SYNTHETICS_ERROR_T Type

Details of an error that occurred.

Syntax

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

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_APM_SYNTHETICS_GEO_SUMMARY_T Type

Geographic summary of a vantage point.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_geo_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  admin_div_code varchar2(32767),
  city_name varchar2(32767),
  country_code varchar2(32767),
  country_name varchar2(32767),
  latitude number,
  longitude number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_geo_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_geo_summary_t (
    admin_div_code varchar2,
    city_name varchar2,
    country_code varchar2,
    country_name varchar2,
    latitude number,
    longitude number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

admin_div_code

(optional) The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.

city_name

(optional) Common English-language name for the city.

country_code

(optional) The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.

country_name

(optional) The common English-language name for the country.

latitude

(optional) Degrees north of the equator.

longitude

(optional) Degrees east of the prime meridian.

DBMS_CLOUD_OCI_APM_SYNTHETICS_HEADER_T Type

Details of the header.

Syntax

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

Fields

Field Description

header_name

(required) Name of the header.

header_value

(optional) Value of the header.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_INFO_T Type

Details of the vantage point.

Syntax

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

Fields

Field Description

name

(required) Name of the vantage point.

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SCRIPT_PARAMETER_INFO_T Type

Details of the script parameters in the monitor. isOverwritten specifies that the script parameters are overwritten in the monitor. If the user overwrites the parameter value in the monitor, then the overwritten values will be used to run the monitor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
  monitor_script_parameter dbms_cloud_oci_apm_synthetics_monitor_script_parameter_t,
  is_secret number,
  is_overwritten number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_t (
    monitor_script_parameter dbms_cloud_oci_apm_synthetics_monitor_script_parameter_t,
    is_secret number,
    is_overwritten number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

monitor_script_parameter

(required)

is_secret

(required) Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

is_overwritten

(required) If parameter value is default or overwritten.

DBMS_CLOUD_OCI_APM_SYNTHETICS_VANTAGE_POINT_INFO_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_vantage_point_info_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_vantage_point_info_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_vantage_point_info_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SCRIPT_PARAMETER_INFO_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_T Type

The information about a monitor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  monitor_type varchar2(32767),
  vantage_points dbms_cloud_oci_apm_synthetics_vantage_point_info_tbl,
  vantage_point_count number,
  script_id varchar2(32767),
  script_name varchar2(32767),
  status varchar2(32767),
  repeat_interval_in_seconds number,
  is_run_once number,
  timeout_in_seconds number,
  target varchar2(32767),
  script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_tbl,
  configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
  availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
  maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_run_now number,
  scheduling_policy varchar2(32767),
  batch_interval_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_t (
    id varchar2,
    display_name varchar2,
    monitor_type varchar2,
    vantage_points dbms_cloud_oci_apm_synthetics_vantage_point_info_tbl,
    vantage_point_count number,
    script_id varchar2,
    script_name varchar2,
    status varchar2,
    repeat_interval_in_seconds number,
    is_run_once number,
    timeout_in_seconds number,
    target varchar2,
    script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_info_tbl,
    configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
    availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
    maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_run_now number,
    scheduling_policy varchar2,
    batch_interval_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the monitor.

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

monitor_type

(required) Type of monitor.

Allowed values are: 'SCRIPTED_BROWSER', 'BROWSER', 'SCRIPTED_REST', 'REST', 'NETWORK'

vantage_points

(required) List of public and dedicated vantage points where the monitor is running.

vantage_point_count

(required) Number of vantage points where monitor is running.

script_id

(required) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

script_name

(required) Name of the script.

status

(required) Enables or disables the monitor.

Allowed values are: 'ENABLED', 'DISABLED', 'INVALID'

repeat_interval_in_seconds

(required) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

is_run_once

(required) If runOnce is enabled, then the monitor will run once.

timeout_in_seconds

(required) Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

target

(optional) Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80

script_parameters

(optional) List of script parameters. Example: `[{\"monitorScriptParameter\": {\"paramName\": \"userid\", \"paramValue\":\"testuser\"}, \"isSecret\": false, \"isOverwritten\": false}]`

configuration

(optional)

availability_configuration

(optional)

maintenance_window_schedule

(optional)

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_run_now

(required) If isRunNow is enabled, then the monitor will run immediately.

scheduling_policy

(required) Scheduling policy to decide the distribution of monitor executions on vantage points.

Allowed values are: 'ALL', 'ROUND_ROBIN', 'BATCHED_ROUND_ROBIN'

batch_interval_in_seconds

(required) Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SUMMARY_T Type

Information about the monitor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  monitor_type varchar2(32767),
  vantage_points dbms_cloud_oci_apm_synthetics_vantage_point_info_tbl,
  vantage_point_count number,
  script_id varchar2(32767),
  script_name varchar2(32767),
  status varchar2(32767),
  repeat_interval_in_seconds number,
  is_run_once number,
  timeout_in_seconds number,
  target varchar2(32767),
  maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_run_now number,
  scheduling_policy varchar2(32767),
  batch_interval_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_summary_t (
    id varchar2,
    display_name varchar2,
    monitor_type varchar2,
    vantage_points dbms_cloud_oci_apm_synthetics_vantage_point_info_tbl,
    vantage_point_count number,
    script_id varchar2,
    script_name varchar2,
    status varchar2,
    repeat_interval_in_seconds number,
    is_run_once number,
    timeout_in_seconds number,
    target varchar2,
    maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_run_now number,
    scheduling_policy varchar2,
    batch_interval_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the monitor.

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

monitor_type

(required) The type of monitor.

Allowed values are: 'SCRIPTED_BROWSER', 'BROWSER', 'SCRIPTED_REST', 'REST', 'NETWORK'

vantage_points

(required) List of public and dedicated vantage points where the monitor is running.

vantage_point_count

(required) Number of vantage points where monitor is running.

script_id

(required) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

script_name

(required) Name of the script.

status

(required) Enables or disables the monitor.

Allowed values are: 'ENABLED', 'DISABLED', 'INVALID'

repeat_interval_in_seconds

(required) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

is_run_once

(required) If runOnce is enabled, then the monitor will run once.

timeout_in_seconds

(required) Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

target

(optional) Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80

maintenance_window_schedule

(optional)

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_run_now

(required) If isRunNow is enabled, then the monitor will run immediately.

scheduling_policy

(required) Scheduling policy to decide the distribution of monitor executions on vantage points.

Allowed values are: 'ALL', 'ROUND_ROBIN', 'BATCHED_ROUND_ROBIN'

batch_interval_in_seconds

(required) Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_monitor_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_monitor_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_COLLECTION_T Type

The results of a monitor search, which contains both MonitorSummary items and other data in an APM domain.

Syntax

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

Fields

Field Description

items

(required) List of MonitorSummary items.

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_RESULT_DATA_T Type

Details of the monitor result data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_result_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  byte_content clob,
  string_content varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_result_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_result_data_t (
    name varchar2,
    byte_content clob,
    string_content varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) Name of the data.

byte_content

(optional) Data content in byte format. Example: Zip or Screenshot.

string_content

(optional) Data content in string format. Example: HAR.

l_timestamp

(optional) The time when the data was generated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_RESULT_DATA_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_monitor_result_data_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_result_data_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_monitor_result_data_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_MONITOR_RESULT_T Type

The monitor result for a specific execution.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_monitor_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  result_type varchar2(32767),
  result_content_type varchar2(32767),
  result_data_set dbms_cloud_oci_apm_synthetics_monitor_result_data_tbl,
  monitor_id varchar2(32767),
  vantage_point varchar2(32767),
  execution_time varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_monitor_result_t (
    result_type varchar2,
    result_content_type varchar2,
    result_data_set dbms_cloud_oci_apm_synthetics_monitor_result_data_tbl,
    monitor_id varchar2,
    vantage_point varchar2,
    execution_time varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

result_type

(optional) Type of result. Example: HAR, Screenshot, Log or Network.

result_content_type

(required) Type of result content. Example: Zip or Raw file.

result_data_set

(optional) Monitor result data set.

monitor_id

(optional) The OCID of the monitor.

vantage_point

(optional) The name of the public or dedicated vantage point.

execution_time

(optional) The specific point of time when the result of an execution is collected.

DBMS_CLOUD_OCI_APM_SYNTHETICS_NETWORK_MONITOR_CONFIGURATION_T Type

Request configuration details for the NETWORK monitor type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_network_monitor_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
  network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_network_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_network_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
    network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_network_monitor_configuration_t is a subtype of the dbms_cloud_oci_apm_synthetics_monitor_configuration_t type.

Fields

Field Description

network_configuration

(required)

DBMS_CLOUD_OCI_APM_SYNTHETICS_NODE_T Type

Details of the network node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  ip_address varchar2(32767),
  display_name varchar2(32767),
  geo_info varchar2(32767),
  outgoing_links dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  consecutive_anonymous_count number,
  l_level number,
  avg_packet_response_time_in_ms number,
  avg_packet_loss_percent number,
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_node_t (
    id varchar2,
    ip_address varchar2,
    display_name varchar2,
    geo_info varchar2,
    outgoing_links dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    consecutive_anonymous_count number,
    l_level number,
    avg_packet_response_time_in_ms number,
    avg_packet_loss_percent number,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) ID of the network node.

ip_address

(optional) IP address of the network node.

display_name

(optional) Display name of the network node.

geo_info

(optional) Geographical information of the network node.

outgoing_links

(optional) Outgoing links from the network node.

consecutive_anonymous_count

(optional) Number of consecutive anonymous network nodes.

l_level

(optional) Level of the network node.

avg_packet_response_time_in_ms

(optional) Average packet response time in milliseconds.

avg_packet_loss_percent

(optional) Percentage of the average packet loss.

l_type

(optional) Type of network node.

Allowed values are: 'SOURCE', 'DESTINATION', 'ANONYMOUS', 'INTERNAL', 'DANGLING'

DBMS_CLOUD_OCI_APM_SYNTHETICS_ORACLE_RM_STACK_T Type

Details of the Oracle Resource Manager stack, which is a subtype of the Dedicated Vantage Point stack.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_oracle_rm_stack_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_dvp_stack_details_t (
  dvp_stack_id varchar2(32767),
  dvp_stream_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_oracle_rm_stack_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_oracle_rm_stack_t (
    dvp_stack_type varchar2,
    dvp_version varchar2,
    dvp_stack_id varchar2,
    dvp_stream_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_oracle_rm_stack_t is a subtype of the dbms_cloud_oci_apm_synthetics_dvp_stack_details_t type.

Fields

Field Description

dvp_stack_id

(required) Stack OCID of the Resource Manager stack for dedicated vantage point.

dvp_stream_id

(required) Stream OCID of the Resource Manager stack for dedicated vantage point.

DBMS_CLOUD_OCI_APM_SYNTHETICS_PUBLIC_VANTAGE_POINT_SUMMARY_T Type

Information about public vantage points.

Syntax

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

Fields

Field Description

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

name

(required) Unique permanent name of the vantage point.

geo

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_PUBLIC_VANTAGE_POINT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_public_vantage_point_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_public_vantage_point_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_public_vantage_point_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_PUBLIC_VANTAGE_POINT_COLLECTION_T Type

The results of a public vantage point search, which contains PublicVantagePointSummary items and other data in an APM domain.

Syntax

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

Fields

Field Description

items

(required) List of PublicVantagePointSummary items.

DBMS_CLOUD_OCI_APM_SYNTHETICS_HEADER_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_header_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_header_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_header_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_REQUEST_AUTHENTICATION_DETAILS_T Type

Details for request HTTP authentication.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_request_authentication_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  oauth_scheme varchar2(32767),
  auth_user_name varchar2(32767),
  auth_user_password varchar2(32767),
  auth_token varchar2(32767),
  auth_url varchar2(32767),
  auth_headers dbms_cloud_oci_apm_synthetics_header_tbl,
  auth_request_method varchar2(32767),
  auth_request_post_body varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_request_authentication_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_request_authentication_details_t (
    oauth_scheme varchar2,
    auth_user_name varchar2,
    auth_user_password varchar2,
    auth_token varchar2,
    auth_url varchar2,
    auth_headers dbms_cloud_oci_apm_synthetics_header_tbl,
    auth_request_method varchar2,
    auth_request_post_body varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

oauth_scheme

(optional) Request HTTP OAuth scheme.

Allowed values are: 'NONE', 'BASIC'

auth_user_name

(optional) User name for authentication.

auth_user_password

(optional) User password for authentication.

auth_token

(optional) Authentication token.

auth_url

(optional) URL to get authentication token.

auth_headers

(optional) List of authentication headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`

auth_request_method

(optional) Request method.

Allowed values are: 'GET', 'POST'

auth_request_post_body

(optional) Request post body.

DBMS_CLOUD_OCI_APM_SYNTHETICS_REQUEST_QUERY_PARAM_T Type

Information about request query parameters.

Syntax

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

Fields

Field Description

param_name

(required) Name of request query parameter.

param_value

(optional) Value of request query parameter.

DBMS_CLOUD_OCI_APM_SYNTHETICS_REQUEST_QUERY_PARAM_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_request_query_param_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_request_query_param_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_request_query_param_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_REST_MONITOR_CONFIGURATION_T Type

Request configuration details for the REST monitor type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_rest_monitor_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
  is_redirection_enabled number,
  is_certificate_validation_enabled number,
  request_method varchar2(32767),
  req_authentication_scheme varchar2(32767),
  req_authentication_details dbms_cloud_oci_apm_synthetics_request_authentication_details_t,
  client_certificate_details dbms_cloud_oci_apm_synthetics_client_certificate_details_t,
  request_headers dbms_cloud_oci_apm_synthetics_header_tbl,
  request_query_params dbms_cloud_oci_apm_synthetics_request_query_param_tbl,
  request_post_body varchar2(32767),
  verify_response_content varchar2(32767),
  verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_rest_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_rest_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
    is_redirection_enabled number,
    is_certificate_validation_enabled number,
    request_method varchar2,
    req_authentication_scheme varchar2,
    req_authentication_details dbms_cloud_oci_apm_synthetics_request_authentication_details_t,
    client_certificate_details dbms_cloud_oci_apm_synthetics_client_certificate_details_t,
    request_headers dbms_cloud_oci_apm_synthetics_header_tbl,
    request_query_params dbms_cloud_oci_apm_synthetics_request_query_param_tbl,
    request_post_body varchar2,
    verify_response_content varchar2,
    verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_rest_monitor_configuration_t is a subtype of the dbms_cloud_oci_apm_synthetics_monitor_configuration_t type.

Fields

Field Description

is_redirection_enabled

(optional) If redirection is enabled, then redirects will be allowed while accessing target URL.

is_certificate_validation_enabled

(optional) If certificate validation is enabled, then call will fail for certificate errors.

request_method

(optional) Request HTTP method.

Allowed values are: 'GET', 'POST'

req_authentication_scheme

(optional) Request HTTP authentication scheme.

Allowed values are: 'OAUTH', 'NONE', 'BASIC', 'BEARER', 'RESOURCE_PRINCIPAL'

req_authentication_details

(optional)

client_certificate_details

(optional)

request_headers

(optional) List of request headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`

request_query_params

(optional) List of request query params. Example: `[{\"paramName\": \"sortOrder\", \"paramValue\": \"asc\"}]`

request_post_body

(optional) Request post body content.

verify_response_content

(optional) Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

verify_response_codes

(optional) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

network_configuration

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_PARAMETER_INFO_T Type

Information about script parameters. isOverwritten specifies that the default parameter present in the script content is overwritten.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_parameter_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
  script_parameter dbms_cloud_oci_apm_synthetics_script_parameter_t,
  is_overwritten number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_parameter_info_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_parameter_info_t (
    script_parameter dbms_cloud_oci_apm_synthetics_script_parameter_t,
    is_overwritten number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

script_parameter

(required)

is_overwritten

(required) If parameter value is default or overwritten.

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_PARAMETER_INFO_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_script_parameter_info_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_parameter_info_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_script_parameter_info_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_T Type

The information about the script.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  content_type varchar2(32767),
  content varchar2(32767),
  time_uploaded timestamp with time zone,
  content_size_in_bytes number,
  content_file_name varchar2(32767),
  parameters dbms_cloud_oci_apm_synthetics_script_parameter_info_tbl,
  monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_t (
    id varchar2,
    display_name varchar2,
    content_type varchar2,
    content varchar2,
    time_uploaded timestamp with time zone,
    content_size_in_bytes number,
    content_file_name varchar2,
    parameters dbms_cloud_oci_apm_synthetics_script_parameter_info_tbl,
    monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

content_type

(required) Content type of the script.

Allowed values are: 'SIDE', 'JS'

content

(optional) The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `<ORAP><ON>param name</ON></ORAP>` With parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.

time_uploaded

(optional) The time the script was uploaded.

content_size_in_bytes

(optional) Size of the script content.

content_file_name

(optional) File name of the uploaded script content.

parameters

(optional) List of script parameters. Example: `[{\"scriptParameter\": {\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": false}, \"isOverwritten\": false}]`

monitor_status_count_map

(required)

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_SUMMARY_T Type

Information about the script.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  content_type varchar2(32767),
  monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_script_summary_t (
    id varchar2,
    display_name varchar2,
    content_type varchar2,
    monitor_status_count_map dbms_cloud_oci_apm_synthetics_monitor_status_count_map_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

display_name

(required) Unique name that can be edited. The name should not contain any confidential information.

content_type

(required) Content type of the script.

Allowed values are: 'SIDE', 'JS'

monitor_status_count_map

(required)

time_created

(optional) The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

time_updated

(optional) The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_synthetics_script_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_script_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_synthetics_script_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPT_COLLECTION_T Type

The results of a script search, which contains both ScriptSummary items and other data in an APM domain.

Syntax

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

Fields

Field Description

items

(required) List of ScriptSummary items.

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPTED_BROWSER_MONITOR_CONFIGURATION_T Type

Configuration details for the SCRIPTED_BROWSER monitor type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_scripted_browser_monitor_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
  is_certificate_validation_enabled number,
  is_default_snapshot_enabled number,
  network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_scripted_browser_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_scripted_browser_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
    is_certificate_validation_enabled number,
    is_default_snapshot_enabled number,
    network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_scripted_browser_monitor_configuration_t is a subtype of the dbms_cloud_oci_apm_synthetics_monitor_configuration_t type.

Fields

Field Description

is_certificate_validation_enabled

(optional) If certificate validation is enabled, then the call will fail in case of certification errors.

is_default_snapshot_enabled

(optional) If disabled, auto snapshots are not collected.

network_configuration

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_SCRIPTED_REST_MONITOR_CONFIGURATION_T Type

Configuration details for the SCRIPTED_REST monitor type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_scripted_rest_monitor_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_synthetics_monitor_configuration_t (
  req_authentication_scheme varchar2(32767),
  verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_scripted_rest_monitor_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_scripted_rest_monitor_configuration_t (
    config_type varchar2,
    is_failure_retried number,
    dns_configuration dbms_cloud_oci_apm_synthetics_dns_configuration_t,
    req_authentication_scheme varchar2,
    verify_response_codes dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    network_configuration dbms_cloud_oci_apm_synthetics_network_configuration_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apm_synthetics_scripted_rest_monitor_configuration_t is a subtype of the dbms_cloud_oci_apm_synthetics_monitor_configuration_t type.

Fields

Field Description

req_authentication_scheme

(optional) Request HTTP authentication scheme.

Allowed values are: 'NONE', 'RESOURCE_PRINCIPAL'

verify_response_codes

(optional) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

network_configuration

(optional)

DBMS_CLOUD_OCI_APM_SYNTHETICS_UPDATE_DEDICATED_VANTAGE_POINT_DETAILS_T Type

Details of the request body used to update a dedicated vantage point.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_update_dedicated_vantage_point_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
  l_region varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_dedicated_vantage_point_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_dedicated_vantage_point_details_t (
    status varchar2,
    dvp_stack_details dbms_cloud_oci_apm_synthetics_dvp_stack_details_t,
    l_region varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

status

(optional) Status of the dedicated vantage point.

Allowed values are: 'ENABLED', 'DISABLED'

dvp_stack_details

(optional)

l_region

(optional) Name of the region.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_APM_SYNTHETICS_UPDATE_MONITOR_DETAILS_T Type

Details of the request body used to update a monitor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_update_monitor_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  vantage_points dbms_cloud_oci_apm_synthetics_varchar2_tbl,
  script_id varchar2(32767),
  status varchar2(32767),
  repeat_interval_in_seconds number,
  is_run_once number,
  timeout_in_seconds number,
  target varchar2(32767),
  script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_tbl,
  configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
  availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
  maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_run_now number,
  scheduling_policy varchar2(32767),
  batch_interval_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_monitor_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_monitor_details_t (
    display_name varchar2,
    vantage_points dbms_cloud_oci_apm_synthetics_varchar2_tbl,
    script_id varchar2,
    status varchar2,
    repeat_interval_in_seconds number,
    is_run_once number,
    timeout_in_seconds number,
    target varchar2,
    script_parameters dbms_cloud_oci_apm_synthetics_monitor_script_parameter_tbl,
    configuration dbms_cloud_oci_apm_synthetics_monitor_configuration_t,
    availability_configuration dbms_cloud_oci_apm_synthetics_availability_configuration_t,
    maintenance_window_schedule dbms_cloud_oci_apm_synthetics_maintenance_window_schedule_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_run_now number,
    scheduling_policy varchar2,
    batch_interval_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Unique name that can be edited. The name should not contain any confidential information.

vantage_points

(optional) A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.

script_id

(optional) The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status

(optional) Enables or disables the monitor.

Allowed values are: 'ENABLED', 'DISABLED', 'INVALID'

repeat_interval_in_seconds

(optional) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

is_run_once

(optional) If runOnce is enabled, then the monitor will run once.

timeout_in_seconds

(optional) Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

target

(optional) Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80

script_parameters

(optional) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{\"paramName\": \"userid\", \"paramValue\":\"testuser\"}]`

configuration

(optional)

availability_configuration

(optional)

maintenance_window_schedule

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

is_run_now

(optional) If isRunNow is enabled, then the monitor will run immediately.

scheduling_policy

(optional) Scheduling policy to decide the distribution of monitor executions on vantage points.

Allowed values are: 'ALL', 'ROUND_ROBIN', 'BATCHED_ROUND_ROBIN'

batch_interval_in_seconds

(optional) Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).

DBMS_CLOUD_OCI_APM_SYNTHETICS_UPDATE_SCRIPT_DETAILS_T Type

Details of the request body used to update a script. Only Side or JavaScript content types are supported and content should be in Side or JavaScript formats only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_synthetics_update_script_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  content_type varchar2(32767),
  content varchar2(32767),
  content_file_name varchar2(32767),
  parameters dbms_cloud_oci_apm_synthetics_script_parameter_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_script_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_synthetics_update_script_details_t (
    display_name varchar2,
    content_type varchar2,
    content varchar2,
    content_file_name varchar2,
    parameters dbms_cloud_oci_apm_synthetics_script_parameter_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Unique name that can be edited. The name should not contain any confidential information.

content_type

(optional) Content type of script.

Allowed values are: 'SIDE', 'JS'

content

(optional) The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `<ORAP><ON>param name</ON></ORAP>` With parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.

content_file_name

(optional) File name of uploaded script content.

parameters

(optional) List of script parameters. Example: `[{\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": 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\"}}`

Was this article helpful?