Oracle Cloud Infrastructure Documentation
Try Free Tier

OpenSearch Common Types

DBMS_CLOUD_OCI_OPENSEARCH_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_OPENSEARCH_BACKUP_EVENT_DETAILS_T Type

Details about a cluster backup event.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_backup_event_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cluster_id varchar2(32767),
  backup_state varchar2(32767),
  snapshot_name varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  backup_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_backup_event_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_backup_event_details_t (
    cluster_id varchar2,
    backup_state varchar2,
    snapshot_name varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    backup_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cluster_id

(required) The OCID of the OpenSearch cluster for the cluster backup.

backup_state

(required) The result of the cluster backup operation.

Allowed values are: 'DELETED', 'SUCCESS', 'FAILED'

snapshot_name

(optional) The name of the cluster backup.

time_started

(required) The date and time the cluster backup event started. Format defined by RFC3339.

time_ended

(required) The date and time the cluster backup event started. Format defined by RFC3339.

backup_size

(optional) The cluster backup size in GB.

DBMS_CLOUD_OCI_OPENSEARCH_BACKUP_OPENSEARCH_CLUSTER_DETAILS_T Type

Information about an OpenSearch cluster backup.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment where the cluster backup is located.

display_name

(required) The name of the cluster backup. Avoid entering confidential information.

DBMS_CLOUD_OCI_OPENSEARCH_CHANGE_OPENSEARCH_CLUSTER_BACKUP_COMPARTMENT_DETAILS_T Type

Details about the compartment that the cluster backup should move to.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the cluster backup should be moved.

DBMS_CLOUD_OCI_OPENSEARCH_CHANGE_OPENSEARCH_CLUSTER_COMPARTMENT_DETAILS_T Type

Details about the compartment that the OpenSearch cluster should move to.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the cluster should be moved.

DBMS_CLOUD_OCI_OPENSEARCH_CREATE_OPENSEARCH_CLUSTER_DETAILS_T Type

The configuration details for a new OpenSearch cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_create_opensearch_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  software_version varchar2(32767),
  master_node_count number,
  master_node_host_type varchar2(32767),
  master_node_host_bare_metal_shape varchar2(32767),
  master_node_host_ocpu_count number,
  master_node_host_memory_gb number,
  data_node_count number,
  data_node_host_type varchar2(32767),
  data_node_host_bare_metal_shape varchar2(32767),
  data_node_host_ocpu_count number,
  data_node_host_memory_gb number,
  data_node_storage_gb number,
  opendashboard_node_count number,
  opendashboard_node_host_ocpu_count number,
  opendashboard_node_host_memory_gb number,
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  vcn_compartment_id varchar2(32767),
  subnet_compartment_id varchar2(32767),
  security_mode varchar2(32767),
  security_master_user_name varchar2(32767),
  security_master_user_password_hash varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_create_opensearch_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_create_opensearch_cluster_details_t (
    display_name varchar2,
    compartment_id varchar2,
    software_version varchar2,
    master_node_count number,
    master_node_host_type varchar2,
    master_node_host_bare_metal_shape varchar2,
    master_node_host_ocpu_count number,
    master_node_host_memory_gb number,
    data_node_count number,
    data_node_host_type varchar2,
    data_node_host_bare_metal_shape varchar2,
    data_node_host_ocpu_count number,
    data_node_host_memory_gb number,
    data_node_storage_gb number,
    opendashboard_node_count number,
    opendashboard_node_host_ocpu_count number,
    opendashboard_node_host_memory_gb number,
    vcn_id varchar2,
    subnet_id varchar2,
    vcn_compartment_id varchar2,
    subnet_compartment_id varchar2,
    security_mode varchar2,
    security_master_user_name varchar2,
    security_master_user_password_hash varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The name of the cluster. Avoid entering confidential information.

compartment_id

(required) The OCID of the compartment to create the cluster in.

software_version

(required) The version of the software the cluster is running.

master_node_count

(required) The number of master nodes to configure for the cluster.

master_node_host_type

(required) The instance type for the cluster's master nodes.

Allowed values are: 'FLEX', 'BM'

master_node_host_bare_metal_shape

(optional) The bare metal shape for the cluster's master nodes.

master_node_host_ocpu_count

(required) The number of OCPUs to configure for the cluser's master nodes.

master_node_host_memory_gb

(required) The amount of memory in GB, to configure per node for the cluster's master nodes.

data_node_count

(required) The number of data nodes to configure for the cluster.

data_node_host_type

(required) TThe instance type for the cluster's data nodes.

Allowed values are: 'FLEX', 'BM'

data_node_host_bare_metal_shape

(optional) The bare metal shape for the cluster's data nodes.

data_node_host_ocpu_count

(required) The number of OCPUs to configure for the cluster's data nodes.

data_node_host_memory_gb

(required) The amount of memory in GB, to configure per node for the cluster's data nodes.

data_node_storage_gb

(required) The amount of storage in GB, to configure per node for the cluster's data nodes.

opendashboard_node_count

(required) The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboard_node_host_ocpu_count

(required) The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_memory_gb

(required) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

vcn_id

(required) The OCID of the cluster's VCN.

subnet_id

(required) The OCID of the cluster's subnet.

vcn_compartment_id

(required) The OCID for the compartment where the cluster's VCN is located.

subnet_compartment_id

(required) The OCID for the compartment where the cluster's subnet is located.

security_mode

(optional) The security mode of the cluster.

Allowed values are: 'DISABLED', 'PERMISSIVE', 'ENFORCING'

security_master_user_name

(optional) The name of the master user that are used to manage security config

security_master_user_password_hash

(optional) The password hash of the master user that are used to manage security config

freeform_tags

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

defined_tags

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

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_OPENSEARCH_ERROR_T Type

Error Information.

Syntax

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

Information about the cluster backup to export.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_export_opensearch_cluster_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  object_storage_namespace varchar2(32767),
  object_storage_bucket_name varchar2(32767),
  object_storage_prefix varchar2(32767),
  snapshot_name varchar2(32767),
  repository_name varchar2(32767),
  prefix varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_export_opensearch_cluster_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_export_opensearch_cluster_backup_details_t (
    compartment_id varchar2,
    object_storage_namespace varchar2,
    object_storage_bucket_name varchar2,
    object_storage_prefix varchar2,
    snapshot_name varchar2,
    repository_name varchar2,
    prefix varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(optional) The OCID of the compartment where the Object Storage resources for the cluster backup are located.

object_storage_namespace

(required) The Object Storage namespace for the cluster backup export operation.

object_storage_bucket_name

(required) The name of the Object Storage bucket for the cluster backup export operation.

object_storage_prefix

(optional) The prefix within the Object Storage bucket for the cluster backup export operation.

snapshot_name

(required) The name of the snapshot for the cluster backup export operation.

repository_name

(required) The name of the repository containing the snapshots for the cluster backup export operation.

prefix

(required) The prefix within object storage bucket for the cluster backup export operation.

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

The response returned for the get manifest call.

Syntax

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

Fields

Field Description

serialized_manifest

(optional) The serialized manifest response.

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_T Type

An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see About Search Service with OpenSearch.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  time_deleted timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  software_version varchar2(32767),
  total_storage_gb number,
  opensearch_fqdn varchar2(32767),
  opensearch_private_ip varchar2(32767),
  opendashboard_fqdn varchar2(32767),
  opendashboard_private_ip varchar2(32767),
  master_node_count number,
  master_node_host_type varchar2(32767),
  master_node_host_bare_metal_shape varchar2(32767),
  master_node_host_ocpu_count number,
  master_node_host_memory_gb number,
  data_node_count number,
  data_node_host_type varchar2(32767),
  data_node_host_bare_metal_shape varchar2(32767),
  data_node_host_ocpu_count number,
  data_node_host_memory_gb number,
  data_node_storage_gb number,
  opendashboard_node_count number,
  opendashboard_node_host_ocpu_count number,
  opendashboard_node_host_memory_gb number,
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  vcn_compartment_id varchar2(32767),
  subnet_compartment_id varchar2(32767),
  fqdn varchar2(32767),
  availability_domains dbms_cloud_oci_opensearch_varchar2_tbl,
  security_mode varchar2(32767),
  security_master_user_name varchar2(32767),
  security_master_user_password_hash varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    time_deleted timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    software_version varchar2,
    total_storage_gb number,
    opensearch_fqdn varchar2,
    opensearch_private_ip varchar2,
    opendashboard_fqdn varchar2,
    opendashboard_private_ip varchar2,
    master_node_count number,
    master_node_host_type varchar2,
    master_node_host_bare_metal_shape varchar2,
    master_node_host_ocpu_count number,
    master_node_host_memory_gb number,
    data_node_count number,
    data_node_host_type varchar2,
    data_node_host_bare_metal_shape varchar2,
    data_node_host_ocpu_count number,
    data_node_host_memory_gb number,
    data_node_storage_gb number,
    opendashboard_node_count number,
    opendashboard_node_host_ocpu_count number,
    opendashboard_node_host_memory_gb number,
    vcn_id varchar2,
    subnet_id varchar2,
    vcn_compartment_id varchar2,
    subnet_compartment_id varchar2,
    fqdn varchar2,
    availability_domains dbms_cloud_oci_opensearch_varchar2_tbl,
    security_mode varchar2,
    security_master_user_name varchar2,
    security_master_user_password_hash varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cluster.

display_name

(required) The name of the cluster. Avoid entering confidential information.

compartment_id

(required) The OCID of the compartment where the cluster is located.

lifecycle_state

(required) The current state of the cluster.

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

time_created

(required) The amount of time in milliseconds since the cluster was created.

time_updated

(optional) The amount of time in milliseconds since the cluster was updated.

time_deleted

(optional) The amount of time in milliseconds since the cluster was updated.

lifecycle_details

(optional) Additional information about the current lifecycle state of the cluster.

freeform_tags

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

defined_tags

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

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

software_version

(required) The software version the cluster is running.

total_storage_gb

(required) The size in GB of the cluster's total storage.

opensearch_fqdn

(required) The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearch_private_ip

(required) The cluster's private IP address.

opendashboard_fqdn

(required) The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboard_private_ip

(required) The private IP address for the cluster's OpenSearch Dashboard.

master_node_count

(required) The number of master nodes configured for the cluster.

master_node_host_type

(required) The instance type for the cluster's master nodes.

Allowed values are: 'FLEX', 'BM'

master_node_host_bare_metal_shape

(optional) The bare metal shape for the cluster's master nodes.

master_node_host_ocpu_count

(required) The number of OCPUs configured for cluster's master nodes.

master_node_host_memory_gb

(required) The amount of memory in GB, for the cluster's master nodes.

data_node_count

(required) The number of data nodes configured for the cluster.

data_node_host_type

(required) The instance type for the cluster's data nodes.

Allowed values are: 'FLEX', 'BM'

data_node_host_bare_metal_shape

(optional) The bare metal shape for the cluster's data nodes.

data_node_host_ocpu_count

(required) The number of OCPUs configured for the cluster's data nodes.

data_node_host_memory_gb

(required) The amount of memory in GB, for the cluster's data nodes.

data_node_storage_gb

(required) The amount of storage in GB, to configure per node for the cluster's data nodes.

opendashboard_node_count

(required) The number of OpenSearch Dashboard nodes configured for the cluster.

opendashboard_node_host_ocpu_count

(required) The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_memory_gb

(required) The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

vcn_id

(required) The OCID of the cluster's VCN.

subnet_id

(required) The OCID of the cluster's subnet.

vcn_compartment_id

(required) The OCID for the compartment where the cluster's VCN is located.

subnet_compartment_id

(required) The OCID for the compartment where the cluster's subnet is located.

fqdn

(optional) The fully qualified domain name (FQDN) for the cluster's API endpoint.

availability_domains

(required) The availability domains to distribute the cluser nodes across.

security_mode

(optional) The security mode of the cluster.

Allowed values are: 'DISABLED', 'PERMISSIVE', 'ENFORCING'

security_master_user_name

(optional) The name of the master user that are used to manage security config

security_master_user_password_hash

(optional) The password hash of the master user that are used to manage security config

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_BACKUP_T Type

An OpenSearch cluster backup resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Backups.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_backup_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  backup_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecyle_details varchar2(32767),
  source_cluster_id varchar2(32767),
  namespace varchar2(32767),
  bucket_name varchar2(32767),
  prefix varchar2(32767),
  time_expired timestamp with time zone,
  backup_size number,
  source_cluster_display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_backup_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_backup_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backup_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecyle_details varchar2,
    source_cluster_id varchar2,
    namespace varchar2,
    bucket_name varchar2,
    prefix varchar2,
    time_expired timestamp with time zone,
    backup_size number,
    source_cluster_display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cluster backup.

display_name

(optional) The name of the cluster backup. Avoid entering confidential information.

compartment_id

(required) The OCID of the compartment where the cluster backup is located.

backup_type

(required) Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

Allowed values are: 'SCHEDULED', 'MANUAL'

time_created

(optional) The date and time the cluster backup was created. Format defined by RFC3339.

time_updated

(optional) The date and time the cluster backup was updated. Format defined by RFC3339.

lifecycle_state

(required) The current state of the cluster backup.

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

lifecyle_details

(optional) Additional information about the current lifecycle state of the cluster backup.

source_cluster_id

(required) The OCID of the source OpenSearch cluster for the cluster backup.

namespace

(optional) The Object Storage namespace for the cluster backup.

bucket_name

(optional) The name of the Object Storage bucket for the cluster backup.

prefix

(optional) The prefix within the Object Storage bucket for the cluster backup.

time_expired

(optional) The date and time the cluster backup expires. Format defined by RFC3339.

backup_size

(optional) The size in GB of the cluster backup.

source_cluster_display_name

(optional) The name of the source OpenSearch cluster for the cluster backup.

freeform_tags

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

defined_tags

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

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_BACKUP_SUMMARY_T Type

The summary of information about an OpenSearch cluster backup.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  backup_type varchar2(32767),
  source_cluster_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_expired timestamp with time zone,
  backup_size number,
  source_cluster_display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backup_type varchar2,
    source_cluster_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_expired timestamp with time zone,
    backup_size number,
    source_cluster_display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cluster backup.

display_name

(optional) The name of the cluster backup. Avoid entering confidential information.

compartment_id

(required) The OCID of the compartment where the cluster backup is located.

backup_type

(required) Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

source_cluster_id

(required) The OCID of the source OpenSearch cluster for the cluster backup.

time_created

(optional) The date and time the cluster backup was created. Format defined by RFC3339.

time_updated

(optional) The date and time the cluster backup was updated. Format defined by RFC3339.

lifecycle_state

(required) The current state of the cluster backup.

lifecycle_details

(optional) Additional information about the current lifecycle state of the cluster backup.

time_expired

(optional) The date and time the cluster backup expires. Format defined by RFC3339.

backup_size

(optional) The size in GB of the cluster backup.

source_cluster_display_name

(optional) The name of the source OpenSearch cluster for the cluster backup.

freeform_tags

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

defined_tags

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

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_BACKUP_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_opensearch_cluster_backup_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_BACKUP_COLLECTION_T Type

The list of cluster backups returned in a cluster backup search.

Syntax

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

Fields

Field Description

items

(required) The list of cluster backups.

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_SUMMARY_T Type

The summary of information about an OpenSearch cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  software_version varchar2(32767),
  total_storage_gb number,
  lifecycle_state varchar2(32767),
  availability_domains dbms_cloud_oci_opensearch_varchar2_tbl,
  security_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_opensearch_cluster_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    software_version varchar2,
    total_storage_gb number,
    lifecycle_state varchar2,
    availability_domains dbms_cloud_oci_opensearch_varchar2_tbl,
    security_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cluster.

display_name

(optional) The name of the cluster. Avoid entering confidential information.

compartment_id

(required) The OCID for the compartment where the cluster is located.

time_created

(optional) The date and time the cluster was created. Format defined by RFC3339.

time_updated

(optional) The date and time the cluster was updated. Format defined by RFC3339.

lifecycle_details

(optional) Additional information about the current lifecycle state of the cluster.

freeform_tags

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

defined_tags

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

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

software_version

(required) The software version the cluster is running.

total_storage_gb

(required) The total amount of storage in GB, for the cluster.

lifecycle_state

(optional) The current state of the cluster.

availability_domains

(optional) The availability domains to distribute the cluser nodes across.

security_mode

(optional) The security mode of the cluster.

Allowed values are: 'DISABLED', 'PERMISSIVE', 'ENFORCING'

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_opensearch_opensearch_cluster_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_cluster_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_opensearch_cluster_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_CLUSTER_COLLECTION_T Type

The list of OpenSearch clusters returned in a cluster search.

Syntax

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

Fields

Field Description

items

(required) The list of clusters.

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_VERSIONS_SUMMARY_T Type

A description of Opensearch versions

Syntax

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

Fields

Field Description

version

(required) The version of OpenSearch.

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_VERSIONS_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_opensearch_opensearch_versions_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_opensearch_versions_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_opensearch_versions_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_OPENSEARCH_VERSIONS_COLLECTION_T Type

The list of OpenSearch versions returned in an OpenSearch version search.

Syntax

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

Fields

Field Description

items

(required) A list of OpenSearch versions.

DBMS_CLOUD_OCI_OPENSEARCH_RESIZE_OPENSEARCH_CLUSTER_HORIZONTAL_DETAILS_T Type

The node count configuration to update on an existing OpenSearch cluster for horizontal resizing.

Syntax

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

Fields

Field Description

master_node_count

(optional) The number of master nodes to configure for the cluster.

data_node_count

(optional) The number of data nodes to configure for the cluster.

opendashboard_node_count

(optional) The number of OpenSearch Dashboard nodes to configure for the cluster.

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

The OCPU and memory configuration to update on an existing OpenSearch cluster for vertical resizing.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_resize_opensearch_cluster_vertical_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  master_node_host_ocpu_count number,
  master_node_host_memory_gb number,
  data_node_host_ocpu_count number,
  data_node_host_memory_gb number,
  data_node_storage_gb number,
  opendashboard_node_host_ocpu_count number,
  opendashboard_node_host_memory_gb number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_resize_opensearch_cluster_vertical_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_resize_opensearch_cluster_vertical_details_t (
    master_node_host_ocpu_count number,
    master_node_host_memory_gb number,
    data_node_host_ocpu_count number,
    data_node_host_memory_gb number,
    data_node_storage_gb number,
    opendashboard_node_host_ocpu_count number,
    opendashboard_node_host_memory_gb number,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

master_node_host_ocpu_count

(optional) The number of OCPUs to configure for the cluster's master nodes.

master_node_host_memory_gb

(optional) The amount of memory in GB, to configure for the cluster's master nodes.

data_node_host_ocpu_count

(optional) The number of OCPUs to configure for the cluster's data nodes.

data_node_host_memory_gb

(optional) The amount of memory in GB, to configure for the cluster's data nodes.

data_node_storage_gb

(optional) The amount of storage in GB, to configure per node for the cluster's data nodes.

opendashboard_node_host_ocpu_count

(optional) The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_memory_gb

(optional) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

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

Information about the source OpenSearch cluster to restore the cluster backup from.

Syntax

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

Fields

Field Description

cluster_id

(required) The name of the source OpenSearch cluster for the cluster backup.

DBMS_CLOUD_OCI_OPENSEARCH_RESTORE_OPENSEARCH_CLUSTER_DETAILS_T Type

Information about the OpenSearch cluster backup to restore.

Syntax

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

Fields

Field Description

opensearch_cluster_backup_id

(required) The OCID of the cluster backup to restore.

compartment_id

(required) The OCID of the compartment where the cluster backup is located.

prefix

(optional) The prefix for the indices in the cluster backup.

DBMS_CLOUD_OCI_OPENSEARCH_UPDATE_CHECKIN_DETAILS_T Type

Information about the update checkin event.

Syntax

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

Fields

Field Description

cluster_id

(required) The OCID of the OpenSearch cluster.

DBMS_CLOUD_OCI_OPENSEARCH_UPDATE_CLUSTER_HARDENED_IMAGE_DETAILS_T Type

Information about the cluster's hardened image.

Syntax

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

Fields

Field Description

cluster_id

(required) The OCID of the OpenSearch cluster.

DBMS_CLOUD_OCI_OPENSEARCH_UPDATE_CLUSTER_STATUS_DETAILS_T Type

Information about the update cluster event.

Syntax

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

Fields

Field Description

cluster_id

(required) The OCID of the OpenSearch cluster.

lifecycle_state

(required) The state of the cluster after the cluster was updated.

DBMS_CLOUD_OCI_OPENSEARCH_UPDATE_OPENSEARCH_CLUSTER_BACKUP_DETAILS_T Type

Information about the cluster backup to update.

Syntax

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

Fields

Field Description

display_name

(required) The name of the cluster backup.

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

The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_update_opensearch_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  software_version varchar2(32767),
  security_mode varchar2(32767),
  security_master_user_name varchar2(32767),
  security_master_user_password_hash varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_update_opensearch_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_update_opensearch_cluster_details_t (
    display_name varchar2,
    software_version varchar2,
    security_mode varchar2,
    security_master_user_name varchar2,
    security_master_user_password_hash varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The name of the cluster. Avoid entering confidential information.

software_version

(optional)

security_mode

(optional) The security mode of the cluster.

Allowed values are: 'DISABLED', 'PERMISSIVE', 'ENFORCING'

security_master_user_name

(optional) The name of the master user that are used to manage security config

security_master_user_password_hash

(optional) The password hash of the master user that are used to manage security config

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

A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_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_opensearch_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED'

identifier

(required) The OCID of the resource the work request affects.

entity_uri

(optional) The URI path that you can use for a GET request to access the resource metadata.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_opensearch_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_T Type

An asynchronous work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_opensearch_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_opensearch_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_opensearch_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) The type of operation that spawned the work request.

Allowed values are: 'CREATE_OPENSEARCH_CLUSTER', 'UPDATE_OPENSEARCH_CLUSTER', 'DELETE_OPENSEARCH_CLUSTER', 'MOVE_OPENSEARCH_CLUSTER', 'RESTORE_OPENSEARCH_CLUSTER', 'BACKUP_OPENSEARCH_CLUSTER', 'UPDATE_OPENSEARCH_CLUSTER_BACKUP', 'MOVE_OPENSEARCH_CLUSTER_BACKUP', 'DELETE_OPENSEARCH_CLUSTER_BACKUP', 'UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG'

status

(required) The status of current work request.

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

id

(required) The OCID of the work request.

compartment_id

(required) The OCID of the compartment that contains the work request.

resources

(required) The resources that are affected by the work request.

percent_complete

(required) The percentage complete of the operation tracked by the work request.

time_accepted

(required) The date and time the work request was created, in the format defined by RFC 3339.

time_started

(optional) The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC 3339.

time_finished

(optional) The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC 3339.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_TBL Type

Nested table type of dbms_cloud_oci_opensearch_work_request_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_work_request_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_work_request_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_COLLECTION_T Type

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Syntax

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

Fields

Field Description

items

(required) List of workRequests.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_ERROR_T Type

An error encountered while executing an operation that is tracked by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_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_opensearch_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. For a list of error codes, see API Errors.

message

(required) A human-readable string describing the error that occurred.

l_timestamp

(required) The day and time the error occured, in the format defined by RFC 3339.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_opensearch_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_ERROR_COLLECTION_T Type

The list of work request errors returned in a work request error search.

Syntax

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

Fields

Field Description

items

(required) A list of work request errors.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_LOG_ENTRY_T Type

A log message from executing an operation that is tracked by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_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_opensearch_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_opensearch_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) A human-readable log message.

l_timestamp

(required) The day and time the log message was written, in the format defined by RFC 3339.

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_opensearch_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_opensearch_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_opensearch_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OPENSEARCH_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

The list of work request log entries returned in a work request log search.

Syntax

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

Fields

Field Description

items

(required) A list of work request log entries.

Was this article helpful?