Nested table type of varchar2(32767).

Syntax

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

The reqeust body when activating a BDS metastore configuration

Syntax

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

Fields

Policy definition for the autoscale configuration. An autoscaling policy is part of an autoscaling configuration. For more information, see Autoscaling You can create following type of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule. An autoscaling configuration can have one of above supported policies.

Syntax

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

Fields

An autoscale action is triggered when a performance metric exceeds a threshold.

Syntax

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

Fields

Metric and threshold details for triggering an autoscale action.

Syntax

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

Fields

A rule that defines a specific autoscale action to take and the metric that triggers that action.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_auto_scale_policy_rule_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_auto_scale_policy_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_auto_scale_policy_rule_t) NOT PERSISTABLE;

This model for autoscaling policy is deprecated and not supported for ODH clusters. Use the `AutoScalePolicyDetails` model to manage autoscale policy details for ODH clusters.

Syntax

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

Fields

The information about the autoscale configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_auto_scaling_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  node_type varchar2(32767),
  is_enabled number,
  cluster_admin_password varchar2(32767),
  policy dbms_cloud_oci_bds_auto_scale_policy_t,
  policy_details dbms_cloud_oci_bds_add_auto_scale_policy_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_auto_scaling_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_auto_scaling_configuration_details_t (
    display_name varchar2,
    node_type varchar2,
    is_enabled number,
    cluster_admin_password varchar2,
    policy dbms_cloud_oci_bds_auto_scale_policy_t,
    policy_details dbms_cloud_oci_bds_add_auto_scale_policy_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about added block volumes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_block_storage_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  block_volume_size_in_g_bs number,
  node_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_block_storage_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_block_storage_details_t (
    cluster_admin_password varchar2,
    block_volume_size_in_g_bs number,
    node_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The shape configuration requested for the node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_shape_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ocpus number,
  memory_in_g_bs number,
  nvmes number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_shape_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_shape_config_details_t (
    ocpus number,
    memory_in_g_bs number,
    nvmes number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the added Cloud SQL.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_cloud_sql_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape varchar2(32767),
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  block_volume_size_in_g_bs number,
  cluster_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_cloud_sql_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_cloud_sql_details_t (
    shape varchar2,
    shape_config dbms_cloud_oci_bds_shape_config_details_t,
    block_volume_size_in_g_bs number,
    cluster_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the Kafka service to be added.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_kafka_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape varchar2(32767),
  number_of_kafka_nodes number,
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  block_volume_size_in_g_bs number,
  cluster_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_kafka_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_kafka_details_t (
    shape varchar2,
    number_of_kafka_nodes number,
    shape_config dbms_cloud_oci_bds_shape_config_details_t,
    block_volume_size_in_g_bs number,
    cluster_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about added master nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_master_nodes_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  number_of_master_nodes number,
  shape varchar2(32767),
  block_volume_size_in_g_bs number,
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_master_nodes_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_master_nodes_details_t (
    cluster_admin_password varchar2,
    number_of_master_nodes number,
    shape varchar2,
    block_volume_size_in_g_bs number,
    shape_config dbms_cloud_oci_bds_shape_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configration for a metric based horizontal scale-out policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
  max_node_count number,
  step_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t (
    metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
    max_node_count number,
    step_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configration for a metric based horizontal scale-in policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
  min_node_count number,
  step_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t (
    metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
    min_node_count number,
    step_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_metric_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_add_auto_scale_policy_details_t (
  scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
  scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_metric_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_metric_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
    scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_add_metric_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_add_auto_scale_policy_details_t type.

Fields

Configration for a metric based vertical scale-up policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
  max_ocpus_per_node number,
  max_memory_per_node number,
  ocpu_step_size number,
  memory_step_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t (
    metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
    max_ocpus_per_node number,
    max_memory_per_node number,
    ocpu_step_size number,
    memory_step_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configration for a metric based vertical scale-down policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
  min_ocpus_per_node number,
  min_memory_per_node number,
  ocpu_step_size number,
  memory_step_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t (
    metric dbms_cloud_oci_bds_auto_scale_policy_metric_rule_t,
    min_ocpus_per_node number,
    min_memory_per_node number,
    ocpu_step_size number,
    memory_step_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_metric_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_add_auto_scale_policy_details_t (
  scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
  scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_metric_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_metric_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
    scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_add_metric_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_add_auto_scale_policy_details_t type.

Fields

Details of a horizontal scaling schedule.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_horizontal_scaling_schedule_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_horizontal_scaling_schedule_details_t) NOT PERSISTABLE;

Details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_schedule_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_add_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_schedule_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_schedule_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_add_schedule_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_add_auto_scale_policy_details_t type.

Fields

Details of a vertical scaling schedule.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_vertical_scaling_schedule_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_vertical_scaling_schedule_details_t) NOT PERSISTABLE;

Details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_schedule_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_add_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_schedule_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_schedule_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_add_schedule_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_add_auto_scale_policy_details_t type.

Fields

The information about added utility nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_utility_nodes_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  number_of_utility_nodes number,
  shape varchar2(32767),
  block_volume_size_in_g_bs number,
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_utility_nodes_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_utility_nodes_details_t (
    cluster_admin_password varchar2,
    number_of_utility_nodes number,
    shape varchar2,
    block_volume_size_in_g_bs number,
    shape_config dbms_cloud_oci_bds_shape_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about added nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_add_worker_nodes_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  number_of_worker_nodes number,
  node_type varchar2(32767),
  shape varchar2(32767),
  block_volume_size_in_g_bs number,
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_worker_nodes_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_add_worker_nodes_details_t (
    cluster_admin_password varchar2,
    number_of_worker_nodes number,
    node_type varchar2,
    shape varchar2,
    block_volume_size_in_g_bs number,
    shape_config dbms_cloud_oci_bds_shape_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Details of an autoscale policy. You can create following types of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule.

Syntax

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

Fields

The information about the autoscale configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_auto_scaling_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  node_type varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  policy dbms_cloud_oci_bds_auto_scale_policy_t,
  policy_details dbms_cloud_oci_bds_auto_scale_policy_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_auto_scaling_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_auto_scaling_configuration_t (
    id varchar2,
    display_name varchar2,
    node_type varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    policy dbms_cloud_oci_bds_auto_scale_policy_t,
    policy_details dbms_cloud_oci_bds_auto_scale_policy_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the autoscale configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_auto_scaling_configuration_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  node_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  policy dbms_cloud_oci_bds_auto_scale_policy_t,
  policy_details dbms_cloud_oci_bds_auto_scale_policy_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_auto_scaling_configuration_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_auto_scaling_configuration_summary_t (
    id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    node_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    policy dbms_cloud_oci_bds_auto_scale_policy_t,
    policy_details dbms_cloud_oci_bds_auto_scale_policy_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The API key information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_bds_api_key_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  user_id varchar2(32767),
  key_alias varchar2(32767),
  default_region varchar2(32767),
  tenant_id varchar2(32767),
  fingerprint varchar2(32767),
  pemfilepath varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_api_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_api_key_t (
    id varchar2,
    user_id varchar2,
    key_alias varchar2,
    default_region varchar2,
    tenant_id varchar2,
    fingerprint varchar2,
    pemfilepath varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The API key summary.

Syntax

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

Fields

Additional configuration of the user's network.

Syntax

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

Fields

Specific info about a Hadoop cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  bda_version varchar2(32767),
  bdm_version varchar2(32767),
  bds_version varchar2(32767),
  os_version varchar2(32767),
  db_version varchar2(32767),
  bd_cell_version varchar2(32767),
  csql_cell_version varchar2(32767),
  time_created timestamp with time zone,
  time_refreshed timestamp with time zone,
  cloudera_manager_url varchar2(32767),
  ambari_url varchar2(32767),
  big_data_manager_url varchar2(32767),
  hue_server_url varchar2(32767),
  odh_version varchar2(32767),
  jupyter_hub_url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_cluster_details_t (
    bda_version varchar2,
    bdm_version varchar2,
    bds_version varchar2,
    os_version varchar2,
    db_version varchar2,
    bd_cell_version varchar2,
    csql_cell_version varchar2,
    time_created timestamp with time zone,
    time_refreshed timestamp with time zone,
    cloudera_manager_url varchar2,
    ambari_url varchar2,
    big_data_manager_url varchar2,
    hue_server_url varchar2,
    odh_version varchar2,
    jupyter_hub_url varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A detail of the attached block volume.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_volume_attachment_detail_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_volume_attachment_detail_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_volume_attachment_detail_t) NOT PERSISTABLE;

Details about a node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  instance_id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  node_type varchar2(32767),
  shape varchar2(32767),
  attached_block_volumes dbms_cloud_oci_bds_volume_attachment_detail_tbl,
  subnet_id varchar2(32767),
  ip_address varchar2(32767),
  hostname varchar2(32767),
  image_id varchar2(32767),
  ssh_fingerprint varchar2(32767),
  availability_domain varchar2(32767),
  fault_domain varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  ocpus number,
  memory_in_g_bs number,
  nvmes number,
  local_disks_total_size_in_g_bs number,
  time_maintenance_reboot_due timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_node_t (
    instance_id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    node_type varchar2,
    shape varchar2,
    attached_block_volumes dbms_cloud_oci_bds_volume_attachment_detail_tbl,
    subnet_id varchar2,
    ip_address varchar2,
    hostname varchar2,
    image_id varchar2,
    ssh_fingerprint varchar2,
    availability_domain varchar2,
    fault_domain varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    ocpus number,
    memory_in_g_bs number,
    nvmes number,
    local_disks_total_size_in_g_bs number,
    time_maintenance_reboot_due timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Details about the Kerberos principals.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_kerberos_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_kerberos_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_kerberos_details_t) NOT PERSISTABLE;

The information about added Cloud SQL capability

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_cloud_sql_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape varchar2(32767),
  block_volume_size_in_g_bs number,
  is_kerberos_mapped_to_database_users number,
  ip_address varchar2(32767),
  kerberos_details dbms_cloud_oci_bds_kerberos_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_cloud_sql_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_cloud_sql_details_t (
    shape varchar2,
    block_volume_size_in_g_bs number,
    is_kerberos_mapped_to_database_users number,
    ip_address varchar2,
    kerberos_details dbms_cloud_oci_bds_kerberos_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_node_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_node_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_node_t) NOT PERSISTABLE;

Description of the cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_bds_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  cluster_version varchar2(32767),
  is_high_availability number,
  is_secure number,
  is_cloud_sql_configured number,
  is_kafka_configured number,
  network_config dbms_cloud_oci_bds_network_config_t,
  cluster_details dbms_cloud_oci_bds_cluster_details_t,
  nodes dbms_cloud_oci_bds_node_tbl,
  cloud_sql_details dbms_cloud_oci_bds_cloud_sql_details_t,
  created_by varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  number_of_nodes number,
  number_of_nodes_requiring_maintenance_reboot number,
  bootstrap_script_url varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  kms_key_id varchar2(32767),
  cluster_profile varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_instance_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    cluster_version varchar2,
    is_high_availability number,
    is_secure number,
    is_cloud_sql_configured number,
    is_kafka_configured number,
    network_config dbms_cloud_oci_bds_network_config_t,
    cluster_details dbms_cloud_oci_bds_cluster_details_t,
    nodes dbms_cloud_oci_bds_node_tbl,
    cloud_sql_details dbms_cloud_oci_bds_cloud_sql_details_t,
    created_by varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    number_of_nodes number,
    number_of_nodes_requiring_maintenance_reboot number,
    bootstrap_script_url varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    kms_key_id varchar2,
    cluster_profile varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Summary details of the Big Data Service cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_bds_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  number_of_nodes number,
  number_of_nodes_requiring_maintenance_reboot number,
  cluster_version varchar2(32767),
  is_high_availability number,
  is_secure number,
  is_cloud_sql_configured number,
  is_kafka_configured number,
  cluster_profile varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_instance_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    number_of_nodes number,
    number_of_nodes_requiring_maintenance_reboot number,
    cluster_version varchar2,
    is_high_availability number,
    is_secure number,
    is_cloud_sql_configured number,
    is_kafka_configured number,
    cluster_profile varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The metastore configuration information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_bds_metastore_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  metastore_type varchar2(32767),
  metastore_id varchar2(32767),
  bds_api_key_id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_metastore_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_metastore_configuration_t (
    id varchar2,
    display_name varchar2,
    metastore_type varchar2,
    metastore_id varchar2,
    bds_api_key_id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The summary of metastore configuration information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_bds_metastore_configuration_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  metastore_type varchar2(32767),
  metastore_id varchar2(32767),
  bds_api_key_id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_metastore_configuration_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_bds_metastore_configuration_summary_t (
    id varchar2,
    display_name varchar2,
    metastore_type varchar2,
    metastore_id varchar2,
    bds_api_key_id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Details for certificate service info

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_certificate_service_info_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  services dbms_cloud_oci_bds_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_certificate_service_info_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_certificate_service_info_details_t (
    services dbms_cloud_oci_bds_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Host specific certificate details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_host_specific_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  host_name varchar2(32767),
  certificate_type varchar2(32767),
  time_expiry timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_host_specific_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_host_specific_certificate_details_t (
    host_name varchar2,
    certificate_type varchar2,
    time_expiry timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_host_specific_certificate_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_host_specific_certificate_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_host_specific_certificate_details_t) NOT PERSISTABLE;

List of TLS/SSL information of services

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_certificate_service_info_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  service varchar2(32767),
  service_certificate_status varchar2(32767),
  host_specific_certificate_details dbms_cloud_oci_bds_host_specific_certificate_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_certificate_service_info_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_certificate_service_info_summary_t (
    service varchar2,
    service_certificate_status varchar2,
    host_specific_certificate_details dbms_cloud_oci_bds_host_specific_certificate_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Move a Cluster to a Different Compartment

Syntax

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

Fields

Individual worker nodes groups details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_change_shape_nodes_t FORCE AUTHID CURRENT_USER IS OBJECT (
  worker varchar2(32767),
  worker_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  compute_only_worker varchar2(32767),
  compute_only_worker_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  master varchar2(32767),
  master_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  utility varchar2(32767),
  utility_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  cloudsql varchar2(32767),
  cloudsql_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  edge varchar2(32767),
  edge_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  kafka_broker varchar2(32767),
  kafka_broker_shape_config dbms_cloud_oci_bds_shape_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_change_shape_nodes_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_change_shape_nodes_t (
    worker varchar2,
    worker_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    compute_only_worker varchar2,
    compute_only_worker_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    master varchar2,
    master_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    utility varchar2,
    utility_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    cloudsql varchar2,
    cloudsql_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    edge varchar2,
    edge_shape_config dbms_cloud_oci_bds_shape_config_details_t,
    kafka_broker varchar2,
    kafka_broker_shape_config dbms_cloud_oci_bds_shape_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Resize details specified for individual nodes.

Syntax

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

Fields

API key created on user's behalf.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_create_bds_api_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  user_id varchar2(32767),
  passphrase varchar2(32767),
  default_region varchar2(32767),
  key_alias varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_api_key_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_api_key_details_t (
    user_id varchar2,
    passphrase varchar2,
    default_region varchar2,
    key_alias varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the new node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_create_node_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  node_type varchar2(32767),
  shape varchar2(32767),
  block_volume_size_in_g_bs number,
  subnet_id varchar2(32767),
  shape_config dbms_cloud_oci_bds_shape_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_node_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_node_details_t (
    node_type varchar2,
    shape varchar2,
    block_volume_size_in_g_bs number,
    subnet_id varchar2,
    shape_config dbms_cloud_oci_bds_shape_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_create_node_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_create_node_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_create_node_details_t) NOT PERSISTABLE;

The information about the new cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_create_bds_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  cluster_version varchar2(32767),
  cluster_public_key varchar2(32767),
  cluster_admin_password varchar2(32767),
  is_high_availability number,
  is_secure number,
  network_config dbms_cloud_oci_bds_network_config_t,
  bootstrap_script_url varchar2(32767),
  nodes dbms_cloud_oci_bds_create_node_details_tbl,
  kerberos_realm_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  kms_key_id varchar2(32767),
  cluster_profile varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_instance_details_t (
    compartment_id varchar2,
    display_name varchar2,
    cluster_version varchar2,
    cluster_public_key varchar2,
    cluster_admin_password varchar2,
    is_high_availability number,
    is_secure number,
    network_config dbms_cloud_oci_bds_network_config_t,
    bootstrap_script_url varchar2,
    nodes dbms_cloud_oci_bds_create_node_details_tbl,
    kerberos_realm_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    kms_key_id varchar2,
    cluster_profile varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The request body when creating BDS metastore configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_create_bds_metastore_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  metastore_id varchar2(32767),
  bds_api_key_id varchar2(32767),
  bds_api_key_passphrase varchar2(32767),
  cluster_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_metastore_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_create_bds_metastore_configuration_details_t (
    display_name varchar2,
    metastore_id varchar2,
    bds_api_key_id varchar2,
    bds_api_key_passphrase varchar2,
    cluster_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Time of day and horizontal scaling configuration.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_time_and_horizontal_scaling_config_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_time_and_horizontal_scaling_config_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_time_and_horizontal_scaling_config_t) NOT PERSISTABLE;

Details of day based horizontal scaling schedule.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_day_based_horizontal_scaling_schedule_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_horizontal_scaling_schedule_details_t (
  time_and_horizontal_scaling_config dbms_cloud_oci_bds_time_and_horizontal_scaling_config_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_day_based_horizontal_scaling_schedule_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_day_based_horizontal_scaling_schedule_details_t (
    schedule_type varchar2,
    time_and_horizontal_scaling_config dbms_cloud_oci_bds_time_and_horizontal_scaling_config_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_day_based_horizontal_scaling_schedule_details_t is a subtype of the dbms_cloud_oci_bds_horizontal_scaling_schedule_details_t type.

Fields

Time of day and vertical scaling configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_time_and_vertical_scaling_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_recurrence varchar2(32767),
  target_shape varchar2(32767),
  target_ocpus_per_node number,
  target_memory_per_node number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_time_and_vertical_scaling_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_time_and_vertical_scaling_config_t (
    time_recurrence varchar2,
    target_shape varchar2,
    target_ocpus_per_node number,
    target_memory_per_node number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_time_and_vertical_scaling_config_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_time_and_vertical_scaling_config_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_time_and_vertical_scaling_config_t) NOT PERSISTABLE;

Details of day based vertical scaling schedule.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_day_based_vertical_scaling_schedule_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_vertical_scaling_schedule_details_t (
  time_and_vertical_scaling_config dbms_cloud_oci_bds_time_and_vertical_scaling_config_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_day_based_vertical_scaling_schedule_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_day_based_vertical_scaling_schedule_details_t (
    schedule_type varchar2,
    time_and_vertical_scaling_config dbms_cloud_oci_bds_time_and_vertical_scaling_config_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_day_based_vertical_scaling_schedule_details_t is a subtype of the dbms_cloud_oci_bds_vertical_scaling_schedule_details_t type.

Fields

Error Information.

Syntax

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

Fields

The request body info about disable certificate service list.

Syntax

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

Fields

Details about the host and corresponding certificate.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_bds_host_cert_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_host_cert_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_host_cert_details_t) NOT PERSISTABLE;

The request body info about configure certificate service list.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_enable_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  services dbms_cloud_oci_bds_varchar2_tbl,
  root_certificate varchar2(32767),
  host_cert_details dbms_cloud_oci_bds_host_cert_details_tbl,
  server_key_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_enable_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_enable_certificate_details_t (
    cluster_admin_password varchar2,
    services dbms_cloud_oci_bds_varchar2_tbl,
    root_certificate varchar2,
    host_cert_details dbms_cloud_oci_bds_host_cert_details_tbl,
    server_key_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the bootstrap script to be executed.

Syntax

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

Fields

Os patch details for installing a os patches to a cluster.

Syntax

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

Fields

The reqeust body while installing a patch to a cluster.

Syntax

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

Fields

Details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_auto_scale_policy_details_t (
  scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
  scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    trigger_type varchar2,
    action_type varchar2,
    scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
    scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_metric_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_auto_scale_policy_details_t type.

Fields

Details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_metric_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_auto_scale_policy_details_t (
  scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
  scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_metric_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    trigger_type varchar2,
    action_type varchar2,
    scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
    scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_metric_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_auto_scale_policy_details_t type.

Fields

Summary of a package contained in a os patch.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_os_patch_package_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  package_name varchar2(32767),
  target_version varchar2(32767),
  update_type varchar2(32767),
  related_cv_es dbms_cloud_oci_bds_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_package_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_package_summary_t (
    package_name varchar2,
    target_version varchar2,
    update_type varchar2,
    related_cv_es dbms_cloud_oci_bds_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_os_patch_package_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_os_patch_package_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_os_patch_package_summary_t) NOT PERSISTABLE;

Details of an os patch.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_os_patch_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  os_patch_version varchar2(32767),
  min_bds_version varchar2(32767),
  min_compatible_odh_version_map json_element_t,
  target_packages dbms_cloud_oci_bds_os_patch_package_summary_tbl,
  release_date timestamp with time zone,
  patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_details_t (
    os_patch_version varchar2,
    min_bds_version varchar2,
    min_compatible_odh_version_map json_element_t,
    target_packages dbms_cloud_oci_bds_os_patch_package_summary_tbl,
    release_date timestamp with time zone,
    patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Summary of an available os patch to a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_os_patch_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  os_patch_version varchar2(32767),
  release_date timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_os_patch_summary_t (
    os_patch_version varchar2,
    release_date timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Patch history of this cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_patch_history_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  lifecycle_state varchar2(32767),
  time_updated timestamp with time zone,
  patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_patch_history_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_patch_history_summary_t (
    version varchar2,
    lifecycle_state varchar2,
    time_updated timestamp with time zone,
    patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The patch that is currently available for the cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_patch_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  time_released timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_patch_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_patch_summary_t (
    version varchar2,
    time_released timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about the removed autoscale configuration.

Syntax

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

Fields

The information about the Cloud SQL installation that was removed.

Syntax

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

Fields

The information about the Kafka installation to be removed. All configured Kafka nodes are considered for removal.

Syntax

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

Fields

The information about node to be removed.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_remove_node_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  is_force_remove_enabled number,
  node_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_remove_node_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_remove_node_details_t (
    cluster_admin_password varchar2,
    is_force_remove_enabled number,
    node_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The request body info about renew certificate service list.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_renew_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_admin_password varchar2(32767),
  services dbms_cloud_oci_bds_varchar2_tbl,
  root_certificate varchar2(32767),
  host_cert_details dbms_cloud_oci_bds_host_cert_details_tbl,
  server_key_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_renew_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_renew_certificate_details_t (
    cluster_admin_password varchar2,
    services dbms_cloud_oci_bds_varchar2_tbl,
    root_certificate varchar2,
    host_cert_details dbms_cloud_oci_bds_host_cert_details_tbl,
    server_key_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about restarted node.

Syntax

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

Fields

Details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_schedule_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_schedule_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_schedule_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    trigger_type varchar2,
    action_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_schedule_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_auto_scale_policy_details_t type.

Fields

Details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_schedule_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_schedule_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_schedule_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    trigger_type varchar2,
    action_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_schedule_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_auto_scale_policy_details_t type.

Fields

The request body for starting a BDS cluster.

Syntax

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

Fields

The request body for stopping a BDS cluster.

Syntax

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

Fields

The reqeust body when testing a BDS metastore configuration

Syntax

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

Fields

Test access to specified Object Storage bucket using the API key.

Syntax

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

Fields

Update details of an autoscaling policy.

Syntax

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

Fields

The information about the autoscale configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_update_auto_scaling_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  is_enabled number,
  cluster_admin_password varchar2(32767),
  policy dbms_cloud_oci_bds_auto_scale_policy_t,
  policy_details dbms_cloud_oci_bds_update_auto_scale_policy_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_auto_scaling_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_auto_scaling_configuration_details_t (
    display_name varchar2,
    is_enabled number,
    cluster_admin_password varchar2,
    policy dbms_cloud_oci_bds_auto_scale_policy_t,
    policy_details dbms_cloud_oci_bds_update_auto_scale_policy_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information about to-be-updated Big Data Service cluster.

Syntax

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

Fields

The request body when updating BDS metastore configuration.

Syntax

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

Fields

Update details of a metric based horizontal autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_update_metric_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_update_auto_scale_policy_details_t (
  scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
  scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_metric_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_metric_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    scale_out_config dbms_cloud_oci_bds_metric_based_horizontal_scale_out_config_t,
    scale_in_config dbms_cloud_oci_bds_metric_based_horizontal_scale_in_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_update_metric_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_update_auto_scale_policy_details_t type.

Fields

Update details of a metric based vertical autoscaling policy. In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_update_metric_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_update_auto_scale_policy_details_t (
  scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
  scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_metric_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_metric_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    scale_up_config dbms_cloud_oci_bds_metric_based_vertical_scale_up_config_t,
    scale_down_config dbms_cloud_oci_bds_metric_based_vertical_scale_down_config_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_update_metric_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_update_auto_scale_policy_details_t type.

Fields

Update details of a schedule based horizontal autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_update_schedule_based_horizontal_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_update_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_schedule_based_horizontal_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_schedule_based_horizontal_scaling_policy_details_t (
    policy_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_horizontal_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_update_schedule_based_horizontal_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_update_auto_scale_policy_details_t type.

Fields

Update details of a schedule based vertical autoscaling policy. In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_update_schedule_based_vertical_scaling_policy_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bds_update_auto_scale_policy_details_t (
  timezone varchar2(32767),
  schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_schedule_based_vertical_scaling_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_update_schedule_based_vertical_scaling_policy_details_t (
    policy_type varchar2,
    timezone varchar2,
    schedule_details dbms_cloud_oci_bds_vertical_scaling_schedule_details_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bds_update_schedule_based_vertical_scaling_policy_details_t is a subtype of the dbms_cloud_oci_bds_update_auto_scale_policy_details_t type.

Fields

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_bds_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_bds_work_request_resource_t) NOT PERSISTABLE;

Description of the work request status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  operation_type varchar2(32767),
  status varchar2(32767),
  resources dbms_cloud_oci_bds_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_t (
    id varchar2,
    compartment_id varchar2,
    operation_type varchar2,
    status varchar2,
    resources dbms_cloud_oci_bds_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bds_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bds_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A log message from the execution of a work request.

Syntax

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

Fields