Oracle Cloud Infrastructure Documentation

Redis Common Types

DBMS_CLOUD_OCI_REDIS_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_REDIS_CHANGE_REDIS_CLUSTER_COMPARTMENT_DETAILS_T Type

The configuration details for the move operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_change_redis_cluster_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_change_redis_cluster_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_change_redis_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 Redis cluster should be moved.

DBMS_CLOUD_OCI_REDIS_CREATE_REDIS_CLUSTER_DETAILS_T Type

The configuration details for a new Redis cluster. A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_create_redis_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  node_count number,
  software_version varchar2(32767),
  node_memory_in_g_bs number,
  subnet_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_create_redis_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_create_redis_cluster_details_t (
    display_name varchar2,
    compartment_id varchar2,
    node_count number,
    software_version varchar2,
    node_memory_in_g_bs number,
    subnet_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

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

compartment_id

(required) The OCID of the compartment that contains the Redis cluster.

node_count

(required) The number of nodes in the Redis cluster.

software_version

(required) The Redis version that the cluster is running.

node_memory_in_g_bs

(required) The amount of memory allocated to the Redis cluster's nodes, in gigabytes.

subnet_id

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

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

Specifies details for an error.

Syntax

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

Fields

Field Description

code

(required) A machine-usable code for the error that occured.

message

(required) A human-readable error string for the error that occured.

DBMS_CLOUD_OCI_REDIS_NODE_T Type

The details of each node in the Redis cluster.

Syntax

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

Fields

Field Description

private_endpoint_fqdn

(required) The fully qualified domain name (FQDN) of the API endpoint to access a specific node.

private_endpoint_ip_address

(required) The private IP address of the API endpoint to access a specific node.

display_name

(required) A user-friendly name of a Redis cluster node.

DBMS_CLOUD_OCI_REDIS_NODE_TBL Type

Nested table type of dbms_cloud_oci_redis_node_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_node_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_node_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_NODE_COLLECTION_T Type

The collection of Redis cluster nodes.

Syntax

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

Fields

Field Description

items

(required) Collection of node objects.

DBMS_CLOUD_OCI_REDIS_REDIS_CLUSTER_T Type

A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_redis_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  node_count number,
  node_memory_in_g_bs number,
  primary_fqdn varchar2(32767),
  primary_endpoint_ip_address varchar2(32767),
  replicas_fqdn varchar2(32767),
  replicas_endpoint_ip_address varchar2(32767),
  software_version varchar2(32767),
  subnet_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  node_collection dbms_cloud_oci_redis_node_collection_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_redis_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_redis_cluster_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    node_count number,
    node_memory_in_g_bs number,
    primary_fqdn varchar2,
    primary_endpoint_ip_address varchar2,
    replicas_fqdn varchar2,
    replicas_endpoint_ip_address varchar2,
    software_version varchar2,
    subnet_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    node_collection dbms_cloud_oci_redis_node_collection_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Redis cluster.

display_name

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

compartment_id

(required) The OCID of the compartment that contains the Redis cluster.

lifecycle_state

(optional) The current state of the Redis cluster.

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

lifecycle_details

(optional) A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state.

node_count

(required) The number of nodes in the Redis cluster.

node_memory_in_g_bs

(required) The amount of memory allocated to the Redis cluster's nodes, in gigabytes.

primary_fqdn

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

primary_endpoint_ip_address

(required) The private IP address of the API endpoint for the Redis cluster's primary node.

replicas_fqdn

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

replicas_endpoint_ip_address

(required) The private IP address of the API endpoint for the Redis cluster's replica nodes.

software_version

(required) The Redis version that the cluster is running.

Allowed values are: 'V7_0_5'

subnet_id

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

time_created

(optional) The date and time the Redis cluster was created. An RFC3339 formatted datetime string.

time_updated

(optional) The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.

node_collection

(required)

freeform_tags

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

defined_tags

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

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

Summary of information about a Redis cluster. A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_redis_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  node_count number,
  node_memory_in_g_bs number,
  primary_fqdn varchar2(32767),
  primary_endpoint_ip_address varchar2(32767),
  replicas_fqdn varchar2(32767),
  replicas_endpoint_ip_address varchar2(32767),
  software_version varchar2(32767),
  subnet_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_redis_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_redis_cluster_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    node_count number,
    node_memory_in_g_bs number,
    primary_fqdn varchar2,
    primary_endpoint_ip_address varchar2,
    replicas_fqdn varchar2,
    replicas_endpoint_ip_address varchar2,
    software_version varchar2,
    subnet_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Redis cluster.

display_name

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

compartment_id

(required) The OCID of the compartment that contains the Redis cluster.

lifecycle_state

(optional) The current state of the Redis cluster.

lifecycle_details

(optional) A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state.

node_count

(required) The number of nodes in the Redis cluster.

node_memory_in_g_bs

(required) The amount of memory allocated to the Redis cluster's nodes, in gigabytes.

primary_fqdn

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

primary_endpoint_ip_address

(required) The private IP address of the API endpoint for the Redis cluster's primary node.

replicas_fqdn

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

replicas_endpoint_ip_address

(required) The private IP address of the API endpoint for the Redis cluster's replica nodes.

software_version

(required) The Redis version that the cluster is running.

subnet_id

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

time_created

(optional) The date and time the Redis cluster was created. An RFC3339 formatted datetime string.

time_updated

(optional) The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.

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

Nested table type of dbms_cloud_oci_redis_redis_cluster_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_redis_cluster_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_redis_cluster_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_REDIS_CLUSTER_COLLECTION_T Type

A list of Redis clusters that match filter criteria, if any. A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

Syntax

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

Fields

Field Description

items

(required) The list of Redis clusters.

DBMS_CLOUD_OCI_REDIS_UPDATE_REDIS_CLUSTER_DETAILS_T Type

The configuration to update for an existing Redis cluster.

Syntax

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

Fields

Field Description

display_name

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

node_count

(optional) The number of nodes in the Redis cluster.

node_memory_in_g_bs

(optional) The amount of memory allocated to the Redis cluster's nodes, in gigabytes.

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

The resources that are affected by the work request.

Syntax

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

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

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

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

identifier

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

entity_uri

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

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_redis_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_T Type

An asynchronous work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_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_redis_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_redis_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_redis_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_REDIS_CLUSTER', 'UPDATE_REDIS_CLUSTER', 'DELETE_REDIS_CLUSTER', 'MOVE_REDIS_CLUSTER', 'FAILOVER_REDIS_CLUSTER', 'CREATE_REDIS_CONFIG_SET', 'UPDATE_REDIS_CONFIG_SET', 'DELETE_REDIS_CONFIG_SET', 'MOVE_REDIS_CONFIG_SET'

status

(required) The status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'NEEDS_ATTENTION', '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 was started, in the format defined by RFC 3339.

time_finished

(optional) The date and time the work request completed, in the format defined by RFC 3339.

DBMS_CLOUD_OCI_REDIS_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_redis_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_redis_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed at API Errors.

message

(required) A human-readable error string for the error that occured.

l_timestamp

(required) The time and time the error occured.

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_redis_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_ERROR_COLLECTION_T Type

A list of errors for a work request.

Syntax

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

Fields

Field Description

items

(required) A collection of work request errors.

DBMS_CLOUD_OCI_REDIS_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_redis_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_redis_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_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 date and time the log message was written.

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_redis_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

A list of logs for the specified work request.

Syntax

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

Fields

Field Description

items

(required) A collection of work request logs.

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_SUMMARY_T Type

A description of the work request status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_redis_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,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_redis_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_redis_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,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) 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_REDIS_CLUSTER', 'UPDATE_REDIS_CLUSTER', 'DELETE_REDIS_CLUSTER', 'MOVE_REDIS_CLUSTER', 'FAILOVER_REDIS_CLUSTER', 'CREATE_REDIS_CONFIG_SET', 'UPDATE_REDIS_CONFIG_SET', 'DELETE_REDIS_CONFIG_SET', 'MOVE_REDIS_CONFIG_SET'

status

(required) The status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'NEEDS_ATTENTION', '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 affected by this work request.

percent_complete

(required) Percentage of the request completed.

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 was started, in the format defined by RFC 3339.

time_finished

(optional) The date and time the work request completed, in the format defined by RFC 3339.

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

Nested table type of dbms_cloud_oci_redis_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_redis_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_redis_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_REDIS_WORK_REQUEST_SUMMARY_COLLECTION_T Type

A list of work requests.

Syntax

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

Fields

Field Description

items

(required) A collection of work requests.