Oracle Cloud Infrastructure Documentation
Try Free Tier

WAA Common Types

DBMS_CLOUD_OCI_WAA_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_WAA_CHANGE_RESOURCE_COMPARTMENT_DETAILS_T Type

Updates compartmentId of resource.

Syntax

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

DBMS_CLOUD_OCI_WAA_CHANGE_WEB_APP_ACCELERATION_COMPARTMENT_DETAILS_T Type

Updates compartmentId of resource.

Syntax

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

DBMS_CLOUD_OCI_WAA_CHANGE_WEB_APP_ACCELERATION_POLICY_COMPARTMENT_DETAILS_T Type

Updates compartmentId of resource.

Syntax

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

DBMS_CLOUD_OCI_WAA_CREATE_WEB_APP_ACCELERATION_DETAILS_T Type

The information about new WebAppAcceleration.

Syntax

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

Fields

Field Description

display_name

(optional) WebAppAcceleration display name, can be renamed.

backend_type

(required) Type of the WebAppFirewall, as example LOAD_BALANCER.

Allowed values are: 'LOAD_BALANCER'

compartment_id

(required) The OCID of the compartment.

web_app_acceleration_policy_id

(required) The OCID of WebAppAccelerationPolicy, which is attached to the resource.

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

The information about new WebAppAccelerationLoadBalancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_create_web_app_acceleration_load_balancer_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waa_create_web_app_acceleration_details_t (
  load_balancer_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_create_web_app_acceleration_load_balancer_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_create_web_app_acceleration_load_balancer_details_t (
    display_name varchar2,
    backend_type varchar2,
    compartment_id varchar2,
    web_app_acceleration_policy_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    load_balancer_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_waa_create_web_app_acceleration_load_balancer_details_t is a subtype of the dbms_cloud_oci_waa_create_web_app_acceleration_details_t type.

Fields

Field Description

load_balancer_id

(required) LoadBalancer OCID to which the WebAppAccelerationPolicy is attached to.

DBMS_CLOUD_OCI_WAA_RESPONSE_CACHING_POLICY_T Type

An object that specifies an HTTP response caching policy.

Syntax

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

Fields

Field Description

is_response_header_based_caching_enabled

(optional) When false, responses will not be cached by the backend based on response headers. When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers. The \"X-Accel-Expires\" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached. If the header does not include the \"X-Accel-Expires\" field, parameters of caching may be set in the header fields \"Expires\" or \"Cache-Control\". If the header includes the \"Set-Cookie\" field, such a response will not be cached. If the header includes the \"Vary\" field with the special value \"*\", such a response will not be cached. If the header includes the \"Vary\" field with another value, such a response will be cached taking into account the corresponding request header fields.

DBMS_CLOUD_OCI_WAA_GZIP_COMPRESSION_POLICY_T Type

An object that specifies the gzip compression policy.

Syntax

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

Fields

Field Description

is_enabled

(optional) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the \"Accept-Encoding: gzip\" request header. When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.

DBMS_CLOUD_OCI_WAA_RESPONSE_COMPRESSION_POLICY_T Type

An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client. This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used. HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the \"Accept-Encoding\" request header.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_response_compression_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  gzip_compression dbms_cloud_oci_waa_gzip_compression_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_response_compression_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_response_compression_policy_t (
    gzip_compression dbms_cloud_oci_waa_gzip_compression_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

gzip_compression

(optional)

DBMS_CLOUD_OCI_WAA_CREATE_WEB_APP_ACCELERATION_POLICY_DETAILS_T Type

The information about new WebAppAccelerationPolicy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_create_web_app_acceleration_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
  response_compression_policy dbms_cloud_oci_waa_response_compression_policy_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_create_web_app_acceleration_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_create_web_app_acceleration_policy_details_t (
    display_name varchar2,
    compartment_id varchar2,
    response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
    response_compression_policy dbms_cloud_oci_waa_response_compression_policy_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

display_name

(optional) WebAppAccelerationPolicy display name, can be renamed.

compartment_id

(required) The OCID of the compartment.

response_caching_policy

(optional)

response_compression_policy

(optional)

freeform_tags

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

defined_tags

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

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

Error Information.

Syntax

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

Specifies options for a cache purge.

Syntax

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

Fields

Field Description

purge_type

(required) Type of cache purge to perform.

Allowed values are: 'ENTIRE_CACHE'

DBMS_CLOUD_OCI_WAA_PURGE_ENTIRE_WEB_APP_ACCELERATION_CACHE_DETAILS_T Type

Clears all resources from the cache of the WebAppAcceleration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_purge_entire_web_app_acceleration_cache_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waa_purge_web_app_acceleration_cache_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_purge_entire_web_app_acceleration_cache_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_purge_entire_web_app_acceleration_cache_details_t (
    purge_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_waa_purge_entire_web_app_acceleration_cache_details_t is a subtype of the dbms_cloud_oci_waa_purge_web_app_acceleration_cache_details_t type.

DBMS_CLOUD_OCI_WAA_UPDATE_WEB_APP_ACCELERATION_DETAILS_T Type

The information to be updated for WebAppAcceleration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_update_web_app_acceleration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  web_app_acceleration_policy_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_update_web_app_acceleration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_update_web_app_acceleration_details_t (
    display_name varchar2,
    web_app_acceleration_policy_id 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

(optional) WebAppAcceleration display name, can be renamed.

web_app_acceleration_policy_id

(optional) The OCID of WebAppAccelerationPolicy, which is attached to the resource. This update guarantees that the resource always has WebAppAccelerationPolicy attached at any time.

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

The information to be updated. When updating WebAppAccelerationPolicy, shallow merge is used for all top-level fields, meaning that top-level fields with defined values are completely overwritten and top-level fields without defined values are unchanged.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_update_web_app_acceleration_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
  response_compression_policy dbms_cloud_oci_waa_response_compression_policy_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_update_web_app_acceleration_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_update_web_app_acceleration_policy_details_t (
    display_name varchar2,
    response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
    response_compression_policy dbms_cloud_oci_waa_response_compression_policy_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

display_name

(optional) WebAppAccelerationPolicy display name, can be renamed.

response_caching_policy

(optional)

response_compression_policy

(optional)

freeform_tags

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

defined_tags

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

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

A resource connecting a WebAppAccelerationPolicy to a backend of particular type, applying that policy's coverage to the backend.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  backend_type varchar2(32767),
  web_app_acceleration_policy_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backend_type varchar2,
    web_app_acceleration_policy_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

id

(required) The OCID of the WebAppAcceleration.

display_name

(required) WebAppAcceleration display name, can be renamed.

compartment_id

(required) The OCID of the compartment.

backend_type

(required) Type of the WebAppFirewall, as example LOAD_BALANCER.

Allowed values are: 'LOAD_BALANCER'

web_app_acceleration_policy_id

(required) The OCID of WebAppAccelerationPolicy, which is attached to the resource.

time_created

(required) The time the WebAppAcceleration was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the WebAppAcceleration was updated. An RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the WebAppAcceleration.

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

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

freeform_tags

(required) 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

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

system_tags

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

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_SUMMARY_T Type

Summary of the WebAppAcceleration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  backend_type varchar2(32767),
  web_app_acceleration_policy_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backend_type varchar2,
    web_app_acceleration_policy_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

id

(required) The OCID of the WebAppAcceleration.

display_name

(required) WebAppAcceleration display name, can be renamed.

compartment_id

(required) The OCID of the compartment.

backend_type

(required) Type of the WebAppFirewall, as example LOAD_BALANCER.

Allowed values are: 'LOAD_BALANCER'

web_app_acceleration_policy_id

(required) The OCID of WebAppAccelerationPolicy, which is attached to the resource.

time_created

(required) The time the WebAppAcceleration was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the WebAppAcceleration was updated. An RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the WebAppAcceleration.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

freeform_tags

(required) 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

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

system_tags

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

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_waa_web_app_acceleration_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_web_app_acceleration_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_COLLECTION_T Type

Result of a WebAppAcceleration list operation.

Syntax

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

Fields

Field Description

items

(required) List of WebAppAccelerations.

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_LOAD_BALANCER_T Type

WebAppAcceleration to a LoadBalancer resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_load_balancer_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waa_web_app_acceleration_t (
  load_balancer_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_load_balancer_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_load_balancer_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backend_type varchar2,
    web_app_acceleration_policy_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    load_balancer_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_waa_web_app_acceleration_load_balancer_t is a subtype of the dbms_cloud_oci_waa_web_app_acceleration_t type.

Fields

Field Description

load_balancer_id

(required) LoadBalancer OCID to which the WebAppAccelerationPolicy is attached to.

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_LOAD_BALANCER_SUMMARY_T Type

Summary of the WebAppAccelerationLoadBalancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_load_balancer_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waa_web_app_acceleration_summary_t (
  load_balancer_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_load_balancer_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_load_balancer_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    backend_type varchar2,
    web_app_acceleration_policy_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    load_balancer_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_waa_web_app_acceleration_load_balancer_summary_t is a subtype of the dbms_cloud_oci_waa_web_app_acceleration_summary_t type.

Fields

Field Description

load_balancer_id

(required) LoadBalancer OCID to which the WebAppAccelerationPolicy is attached to.

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_POLICY_T Type

The details of WebAppAccelerationPolicy. A policy is comprised of rules, which allows enablement of Caching and Compression of HTTP response. Caching can be enabled for a particular path Compression is enabled at global level

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_policy_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_state varchar2(32767),
  lifecycle_details varchar2(32767),
  response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
  response_compression_policy dbms_cloud_oci_waa_response_compression_policy_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_policy_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    response_caching_policy dbms_cloud_oci_waa_response_caching_policy_t,
    response_compression_policy dbms_cloud_oci_waa_response_compression_policy_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 WebAppAccelerationPolicy.

display_name

(required) WebAppAccelerationPolicy display name, can be renamed.

compartment_id

(required) The OCID of the compartment.

time_created

(required) The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the WebAppAccelerationPolicy.

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

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

response_caching_policy

(optional)

response_compression_policy

(optional)

freeform_tags

(required) 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

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

system_tags

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

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_POLICY_SUMMARY_T Type

Summary of the WebAppAccelerationPolicy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_policy_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_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_policy_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_web_app_acceleration_policy_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details 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 WebAppAccelerationPolicy.

display_name

(required) WebAppAccelerationPolicy display name, can be renamed.

compartment_id

(required) The OCID of the compartment.

time_created

(required) The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.

lifecycle_state

(required) The current state of the WebAppAccelerationPolicy.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

freeform_tags

(required) 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

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

system_tags

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

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_POLICY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_waa_web_app_acceleration_policy_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_web_app_acceleration_policy_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_web_app_acceleration_policy_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WEB_APP_ACCELERATION_POLICY_COLLECTION_T Type

Contains WebAppAccelerationPolicySummary items.

Syntax

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

Fields

Field Description

items

(required) A list of WebAppAccelerationPolicySummary objects.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a WorkRequest.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_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_waa_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_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 WorkRequest affects.

action_type

(required) The way in which this resource is affected by the work tracked in the WorkRequest. 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 WorkRequest affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_waa_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_T Type

A description of WorkRequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_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_waa_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_waa_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_waa_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) Type of the WorkRequest

Allowed values are: 'CREATE_WAA_POLICY', 'UPDATE_WAA_POLICY', 'DELETE_WAA_POLICY', 'MOVE_WAA_POLICY', 'CREATE_WEB_APP_ACCELERATION', 'UPDATE_WEB_APP_ACCELERATION', 'DELETE_WEB_APP_ACCELERATION', 'MOVE_WEB_APP_ACCELERATION', 'PURGE_WEB_APP_ACCELERATION_CACHE'

status

(required) Status of current work request.

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

id

(required) The OCID of the WorkRequest.

compartment_id

(required) The OCID of the compartment that contains the WorkRequest. WorkRequests should be scoped to the same compartment as the resource the work request affects.

resources

(required) The resources affected by this WorkRequest.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_TBL Type

Nested table type of dbms_cloud_oci_waa_work_request_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_work_request_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_work_request_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_COLLECTION_T Type

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

Syntax

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

Fields

Field Description

items

(required) List of WorkRequests.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_ERROR_T Type

An error encountered while executing a WorkRequest.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_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_waa_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_waa_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 on https://docs.cloud.oracle.com/Content/API/References/apierrors.htm.

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_waa_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_ERROR_COLLECTION_T Type

Result of a WorkRequestError search. Contains both WorkRequestError items and other information, such as metadata.

Syntax

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

Fields

Field Description

items

(required) List of WorkRequestError objects.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a WorkRequest.

Syntax

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

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_waa_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waa_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_waa_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_WAA_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Result of a WorkRequestLog search. Contains both WorkRequestLog items and other information, such as metadata.

Syntax

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

Fields

Field Description

items

(required) List of WorkRequestLogEntries.

Was this article helpful?