Nested table type of varchar2(32767).

Syntax

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

Configures the logging policies for the access logs of an API Deployment.

Syntax

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

Fields

An individual JWT claim.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_json_web_token_claim_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  l_values dbms_cloud_oci_apigateway_varchar2_tbl,
  is_required number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_json_web_token_claim_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_json_web_token_claim_t (
    key varchar2,
    l_values dbms_cloud_oci_apigateway_varchar2_tbl,
    is_required number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_json_web_token_claim_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_json_web_token_claim_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_json_web_token_claim_t) NOT PERSISTABLE;

Additional JWT validation checks.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_additional_validation_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  issuers dbms_cloud_oci_apigateway_varchar2_tbl,
  audiences dbms_cloud_oci_apigateway_varchar2_tbl,
  verify_claims dbms_cloud_oci_apigateway_json_web_token_claim_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_additional_validation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_additional_validation_policy_t (
    issuers dbms_cloud_oci_apigateway_varchar2_tbl,
    audiences dbms_cloud_oci_apigateway_varchar2_tbl,
    verify_claims dbms_cloud_oci_apigateway_json_web_token_claim_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.

Syntax

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

Fields

For a type of ANONYMOUS, an authenticated API must have the \"isAnonymousAccessAllowed\" property set to \"true\" in the authentication policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_anonymous_route_authorization_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_route_authorization_policy_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_anonymous_route_authorization_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_anonymous_route_authorization_policy_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_anonymous_route_authorization_policy_t is a subtype of the dbms_cloud_oci_apigateway_route_authorization_policy_t type.

If authentication has been performed, validate whether the request scope (if any) applies to this route.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_any_of_route_authorization_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_route_authorization_policy_t (
  allowed_scope dbms_cloud_oci_apigateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_any_of_route_authorization_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_any_of_route_authorization_policy_t (
    l_type varchar2,
    allowed_scope dbms_cloud_oci_apigateway_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_any_of_route_authorization_policy_t is a subtype of the dbms_cloud_oci_apigateway_route_authorization_policy_t type.

Fields

Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_dynamic_selection_key_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  is_default number,
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_selection_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_selection_key_t (
    l_type varchar2,
    is_default number,
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_any_of_selection_key_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_dynamic_selection_key_t (
  l_values dbms_cloud_oci_apigateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_any_of_selection_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_any_of_selection_key_t (
    l_type varchar2,
    is_default number,
    name varchar2,
    l_values dbms_cloud_oci_apigateway_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_any_of_selection_key_t is a subtype of the dbms_cloud_oci_apigateway_dynamic_selection_key_t type.

Fields

The result of single validation.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_api_validation_result_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_validation_result_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_api_validation_result_t) NOT PERSISTABLE;

An API is simple container for an API Specification. For more information, see API Gateway Concepts.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_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),
  specification_type varchar2(32767),
  validation_results dbms_cloud_oci_apigateway_api_validation_result_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_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,
    specification_type varchar2,
    validation_results dbms_cloud_oci_apigateway_api_validation_result_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A summary of the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_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),
  specification_type varchar2(32767),
  validation_results dbms_cloud_oci_apigateway_api_validation_result_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_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,
    specification_type varchar2,
    validation_results dbms_cloud_oci_apigateway_api_validation_result_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_api_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_api_summary_t) NOT PERSISTABLE;

Collection of API summaries.

Syntax

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

Fields

Information on how to authenticate incoming requests.

Syntax

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

Fields

Limit the number of requests that should be handled for the specified window using a specfic key.

Syntax

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

Fields

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_cors_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  allowed_origins dbms_cloud_oci_apigateway_varchar2_tbl,
  allowed_methods dbms_cloud_oci_apigateway_varchar2_tbl,
  allowed_headers dbms_cloud_oci_apigateway_varchar2_tbl,
  exposed_headers dbms_cloud_oci_apigateway_varchar2_tbl,
  is_allow_credentials_enabled number,
  max_age_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_cors_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_cors_policy_t (
    allowed_origins dbms_cloud_oci_apigateway_varchar2_tbl,
    allowed_methods dbms_cloud_oci_apigateway_varchar2_tbl,
    allowed_headers dbms_cloud_oci_apigateway_varchar2_tbl,
    exposed_headers dbms_cloud_oci_apigateway_varchar2_tbl,
    is_allow_credentials_enabled number,
    max_age_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_mutual_tls_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_verified_certificate_required number,
  allowed_sans dbms_cloud_oci_apigateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_mutual_tls_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_mutual_tls_details_t (
    is_verified_certificate_required number,
    allowed_sans dbms_cloud_oci_apigateway_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Usage plan policies for this deployment

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_usage_plans_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  token_locations dbms_cloud_oci_apigateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plans_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plans_policy_t (
    token_locations dbms_cloud_oci_apigateway_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The type of selector to use when dynamically routing and dynamically authenticating requests.

Syntax

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

Fields

Policy for the details regarding each authentication server under dynamic authentication. We specify the value of selectors for which this authentication server must be selected for a request under keys. We specify the configuration details of authentication server under authenticationServerDetail.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_authentication_server_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key dbms_cloud_oci_apigateway_dynamic_selection_key_t,
  authentication_server_detail dbms_cloud_oci_apigateway_authentication_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_authentication_server_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_authentication_server_policy_t (
    key dbms_cloud_oci_apigateway_dynamic_selection_key_t,
    authentication_server_detail dbms_cloud_oci_apigateway_authentication_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_authentication_server_policy_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_authentication_server_policy_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_authentication_server_policy_t) NOT PERSISTABLE;

Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_dynamic_authentication_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  selection_source dbms_cloud_oci_apigateway_selection_source_policy_t,
  authentication_servers dbms_cloud_oci_apigateway_authentication_server_policy_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_authentication_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_authentication_policy_t (
    selection_source dbms_cloud_oci_apigateway_selection_source_policy_t,
    authentication_servers dbms_cloud_oci_apigateway_authentication_server_policy_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Global behavior applied to all requests received by the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_request_policies_t FORCE AUTHID CURRENT_USER IS OBJECT (
  authentication dbms_cloud_oci_apigateway_authentication_policy_t,
  rate_limiting dbms_cloud_oci_apigateway_rate_limiting_policy_t,
  cors dbms_cloud_oci_apigateway_cors_policy_t,
  mutual_tls dbms_cloud_oci_apigateway_mutual_tls_details_t,
  usage_plans dbms_cloud_oci_apigateway_usage_plans_policy_t,
  dynamic_authentication dbms_cloud_oci_apigateway_dynamic_authentication_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_request_policies_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_request_policies_t (
    authentication dbms_cloud_oci_apigateway_authentication_policy_t,
    rate_limiting dbms_cloud_oci_apigateway_rate_limiting_policy_t,
    cors dbms_cloud_oci_apigateway_cors_policy_t,
    mutual_tls dbms_cloud_oci_apigateway_mutual_tls_details_t,
    usage_plans dbms_cloud_oci_apigateway_usage_plans_policy_t,
    dynamic_authentication dbms_cloud_oci_apigateway_dynamic_authentication_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configures the logging policies for the execution logs of an API Deployment.

Syntax

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

Fields

Policies controlling the pushing of logs to OCI Public Logging.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_logging_policies_t FORCE AUTHID CURRENT_USER IS OBJECT (
  access_log dbms_cloud_oci_apigateway_access_log_policy_t,
  execution_log dbms_cloud_oci_apigateway_execution_log_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_logging_policies_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_logging_policies_t (
    access_log dbms_cloud_oci_apigateway_access_log_policy_t,
    execution_log dbms_cloud_oci_apigateway_execution_log_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Query parameter validation properties.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_query_parameter_validation_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_query_parameter_validation_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_query_parameter_validation_item_t) NOT PERSISTABLE;

Validate the URL query parameters on the incoming API requests on a specific route.

Syntax

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

Fields

Header validation properties.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_header_validation_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_header_validation_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_header_validation_item_t) NOT PERSISTABLE;

Validate the HTTP headers on the incoming API requests on a specific route.

Syntax

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

Fields

Content validation properties.

Syntax

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

Fields

Validate the payload body of the incoming API requests on a specific route.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_body_validation_request_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  required number,
  content json_element_t,
  validation_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_body_validation_request_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_body_validation_request_policy_t (
    required number,
    content json_element_t,
    validation_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Set will add a new header if it was not in the original request. If the header already exists on the request, you can choose to override, append, or skip it.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_set_header_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_set_header_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_set_header_policy_item_t) NOT PERSISTABLE;

Set HTTP headers as they pass through the gateway.

Syntax

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

Fields

The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_rename_header_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_rename_header_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_rename_header_policy_item_t) NOT PERSISTABLE;

Rename HTTP headers as they pass through the gateway.

Syntax

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

Fields

A header to drop (with BLOCK) or pass through (with ALLOW).

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_filter_header_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_filter_header_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_filter_header_policy_item_t) NOT PERSISTABLE;

Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

Syntax

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

Fields

A set of transformations to apply to HTTP headers that pass through the gateway.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_header_transformation_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  set_headers dbms_cloud_oci_apigateway_set_header_policy_t,
  rename_headers dbms_cloud_oci_apigateway_rename_header_policy_t,
  filter_headers dbms_cloud_oci_apigateway_filter_header_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_header_transformation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_header_transformation_policy_t (
    set_headers dbms_cloud_oci_apigateway_set_header_policy_t,
    rename_headers dbms_cloud_oci_apigateway_rename_header_policy_t,
    filter_headers dbms_cloud_oci_apigateway_filter_header_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_set_query_parameter_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_set_query_parameter_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_set_query_parameter_policy_item_t) NOT PERSISTABLE;

Set parameters on the query string as they pass through the gateway.

Syntax

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

Fields

The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_rename_query_parameter_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_rename_query_parameter_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_rename_query_parameter_policy_item_t) NOT PERSISTABLE;

Rename parameters on the query string as they pass through the gateway.

Syntax

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

Fields

A query parameter to drop (with BLOCK) or pass through (with ALLOW).

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_filter_query_parameter_policy_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_filter_query_parameter_policy_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_filter_query_parameter_policy_item_t) NOT PERSISTABLE;

Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

Syntax

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

Fields

A set of transformations to apply to query parameters that pass through the gateway.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_query_parameter_transformation_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  set_query_parameters dbms_cloud_oci_apigateway_set_query_parameter_policy_t,
  rename_query_parameters dbms_cloud_oci_apigateway_rename_query_parameter_policy_t,
  filter_query_parameters dbms_cloud_oci_apigateway_filter_query_parameter_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_query_parameter_transformation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_query_parameter_transformation_policy_t (
    set_query_parameters dbms_cloud_oci_apigateway_set_query_parameter_policy_t,
    rename_query_parameters dbms_cloud_oci_apigateway_rename_query_parameter_policy_t,
    filter_query_parameters dbms_cloud_oci_apigateway_filter_query_parameter_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Base policy for Response Cache lookup.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_response_cache_lookup_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  is_enabled number,
  is_private_caching_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_response_cache_lookup_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_response_cache_lookup_policy_t (
    l_type varchar2,
    is_enabled number,
    is_private_caching_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Behavior applied to any requests received by the API on this route.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_route_request_policies_t FORCE AUTHID CURRENT_USER IS OBJECT (
  authorization dbms_cloud_oci_apigateway_route_authorization_policy_t,
  cors dbms_cloud_oci_apigateway_cors_policy_t,
  query_parameter_validations dbms_cloud_oci_apigateway_query_parameter_validation_request_policy_t,
  header_validations dbms_cloud_oci_apigateway_header_validation_request_policy_t,
  body_validation dbms_cloud_oci_apigateway_body_validation_request_policy_t,
  header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t,
  query_parameter_transformations dbms_cloud_oci_apigateway_query_parameter_transformation_policy_t,
  response_cache_lookup dbms_cloud_oci_apigateway_response_cache_lookup_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_request_policies_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_request_policies_t (
    authorization dbms_cloud_oci_apigateway_route_authorization_policy_t,
    cors dbms_cloud_oci_apigateway_cors_policy_t,
    query_parameter_validations dbms_cloud_oci_apigateway_query_parameter_validation_request_policy_t,
    header_validations dbms_cloud_oci_apigateway_header_validation_request_policy_t,
    body_validation dbms_cloud_oci_apigateway_body_validation_request_policy_t,
    header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t,
    query_parameter_transformations dbms_cloud_oci_apigateway_query_parameter_transformation_policy_t,
    response_cache_lookup dbms_cloud_oci_apigateway_response_cache_lookup_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Base policy for how a response from a backend is cached in the Response Cache.

Syntax

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

Fields

Behavior applied to any responses sent by the API for requests on this route.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_route_response_policies_t FORCE AUTHID CURRENT_USER IS OBJECT (
  header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t,
  response_cache_store dbms_cloud_oci_apigateway_response_cache_store_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_response_policies_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_response_policies_t (
    header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t,
    response_cache_store dbms_cloud_oci_apigateway_response_cache_store_policy_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The backend to forward requests to.

Syntax

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

Fields

A single route that forwards requests to a particular backend and may contain some additional policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_route_t FORCE AUTHID CURRENT_USER IS OBJECT (
  path varchar2(32767),
  methods dbms_cloud_oci_apigateway_varchar2_tbl,
  request_policies dbms_cloud_oci_apigateway_api_specification_route_request_policies_t,
  response_policies dbms_cloud_oci_apigateway_api_specification_route_response_policies_t,
  logging_policies dbms_cloud_oci_apigateway_api_specification_logging_policies_t,
  backend dbms_cloud_oci_apigateway_api_specification_route_backend_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_route_t (
    path varchar2,
    methods dbms_cloud_oci_apigateway_varchar2_tbl,
    request_policies dbms_cloud_oci_apigateway_api_specification_route_request_policies_t,
    response_policies dbms_cloud_oci_apigateway_api_specification_route_response_policies_t,
    logging_policies dbms_cloud_oci_apigateway_api_specification_logging_policies_t,
    backend dbms_cloud_oci_apigateway_api_specification_route_backend_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_api_specification_route_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_route_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_api_specification_route_t) NOT PERSISTABLE;

The logical configuration of the API exposed by a deployment.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_specification_t FORCE AUTHID CURRENT_USER IS OBJECT (
  request_policies dbms_cloud_oci_apigateway_api_specification_request_policies_t,
  logging_policies dbms_cloud_oci_apigateway_api_specification_logging_policies_t,
  routes dbms_cloud_oci_apigateway_api_specification_route_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_specification_t (
    request_policies dbms_cloud_oci_apigateway_api_specification_request_policies_t,
    logging_policies dbms_cloud_oci_apigateway_api_specification_logging_policies_t,
    routes dbms_cloud_oci_apigateway_api_specification_route_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Detail of a single error or warning.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_validation_detail_t FORCE AUTHID CURRENT_USER IS OBJECT (
  msg varchar2(32767),
  severity varchar2(32767),
  src json_array_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_validation_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_validation_detail_t (
    msg varchar2,
    severity varchar2,
    src json_array_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_api_validation_detail_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_validation_detail_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_api_validation_detail_t) NOT PERSISTABLE;

Detail of an error or warning.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_api_validation_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_validation_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_api_validation_details_t) NOT PERSISTABLE;

The result of validations conducted on the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_api_validations_t FORCE AUTHID CURRENT_USER IS OBJECT (
  validations dbms_cloud_oci_apigateway_api_validation_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_validations_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_api_validations_t (
    validations dbms_cloud_oci_apigateway_api_validation_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Only authentication is performed for the request and authorization is skipped.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_authentication_only_route_authorization_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_route_authorization_policy_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_authentication_only_route_authorization_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_authentication_only_route_authorization_policy_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_authentication_only_route_authorization_policy_t is a subtype of the dbms_cloud_oci_apigateway_route_authorization_policy_t type.

Reference to the CA bundle that should be used on the gateway

Syntax

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

Fields

A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see API Gateway Concepts.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_certificate_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  subject_names dbms_cloud_oci_apigateway_varchar2_tbl,
  time_not_valid_after timestamp with time zone,
  certificate varchar2(32767),
  intermediate_certificates 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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificate_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificate_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    subject_names dbms_cloud_oci_apigateway_varchar2_tbl,
    time_not_valid_after timestamp with time zone,
    certificate varchar2,
    intermediate_certificates 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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A summary of the certificate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_certificate_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  subject_names dbms_cloud_oci_apigateway_varchar2_tbl,
  time_not_valid_after timestamp with time zone,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificate_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificate_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    subject_names dbms_cloud_oci_apigateway_varchar2_tbl,
    time_not_valid_after timestamp with time zone,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_certificate_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_certificate_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_certificate_summary_t) NOT PERSISTABLE;

Collection of certificate summaries.

Syntax

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

Fields

CA bundle from Certificates Service that should be used on the gateway for TLS validation

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_certificates_ca_bundle_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_ca_bundle_t (
  ca_bundle_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificates_ca_bundle_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificates_ca_bundle_t (
    l_type varchar2,
    ca_bundle_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_certificates_ca_bundle_t is a subtype of the dbms_cloud_oci_apigateway_ca_bundle_t type.

Fields

Certificate Authority from Certificates Service that should be used on the gateway for TLS validation

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_certificates_certificate_authority_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_ca_bundle_t (
  certificate_authority_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificates_certificate_authority_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_certificates_certificate_authority_t (
    l_type varchar2,
    certificate_authority_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_certificates_certificate_authority_t is a subtype of the dbms_cloud_oci_apigateway_ca_bundle_t type.

Fields

The new compartment details for the API.

Syntax

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

Fields

The new compartment details for the certificate.

Syntax

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

Fields

The new compartment details for the deployment.

Syntax

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

Fields

The new compartment details for the gateway.

Syntax

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

Fields

The new compartment details for the subscriber.

Syntax

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

Fields

The new compartment details for the usage plan.

Syntax

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

Fields

A Client.

Syntax

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

Fields

Client App Credential details.

Syntax

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

Fields

A summary of a client.

Syntax

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

Fields

Information about the new API.

Syntax

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

Fields

Information about a new certificate.

Syntax

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

Fields

Information about a new deployment.

Syntax

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

Fields

Base Gateway response cache.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_ca_bundle_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_ca_bundle_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_ca_bundle_t) NOT PERSISTABLE;

Information about the new gateway.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_create_gateway_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_type varchar2(32767),
  subnet_id varchar2(32767),
  network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
  certificate_id varchar2(32767),
  response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_create_gateway_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_create_gateway_details_t (
    display_name varchar2,
    compartment_id varchar2,
    endpoint_type varchar2,
    subnet_id varchar2,
    network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
    certificate_id varchar2,
    response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Information about the new SDK.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_client_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_client_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_client_t) NOT PERSISTABLE;

Information about a new subscriber.

Syntax

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

Fields

Rate-limiting policy for a usage plan.

Syntax

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

Fields

Quota policy for a usage plan.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_quota_t FORCE AUTHID CURRENT_USER IS OBJECT (
  value number,
  unit varchar2(32767),
  reset_policy varchar2(32767),
  operation_on_breach varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_quota_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_quota_t (
    value number,
    unit varchar2,
    reset_policy varchar2,
    operation_on_breach varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An entitlement target, describing which deployment the entitlement should be applied to.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_entitlement_target_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_entitlement_target_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_entitlement_target_t) NOT PERSISTABLE;

A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_entitlement_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  description varchar2(32767),
  rate_limit dbms_cloud_oci_apigateway_rate_limit_t,
  quota dbms_cloud_oci_apigateway_quota_t,
  targets dbms_cloud_oci_apigateway_entitlement_target_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_entitlement_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_entitlement_t (
    name varchar2,
    description varchar2,
    rate_limit dbms_cloud_oci_apigateway_rate_limit_t,
    quota dbms_cloud_oci_apigateway_quota_t,
    targets dbms_cloud_oci_apigateway_entitlement_target_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_entitlement_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_entitlement_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_entitlement_t) NOT PERSISTABLE;

Information about a new usage plan.

Syntax

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

Fields

Policy for defining behaviour on validation failure.

Syntax

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

Fields

Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_custom_authentication_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_authentication_policy_t (
  function_id varchar2(32767),
  token_header varchar2(32767),
  token_query_param varchar2(32767),
  parameters json_element_t,
  cache_key dbms_cloud_oci_apigateway_varchar2_tbl,
  validation_failure_policy dbms_cloud_oci_apigateway_validation_failure_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_custom_authentication_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_custom_authentication_policy_t (
    is_anonymous_access_allowed number,
    l_type varchar2,
    function_id varchar2,
    token_header varchar2,
    token_query_param varchar2,
    parameters json_element_t,
    cache_key dbms_cloud_oci_apigateway_varchar2_tbl,
    validation_failure_policy dbms_cloud_oci_apigateway_validation_failure_policy_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_custom_authentication_policy_t is a subtype of the dbms_cloud_oci_apigateway_authentication_policy_t type.

Fields

Client App Credentials to be provided again.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_custom_client_app_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_client_app_details_t (
  client_id varchar2(32767),
  client_secret_id varchar2(32767),
  client_secret_version_number number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_custom_client_app_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_custom_client_app_details_t (
    l_type varchar2,
    client_id varchar2,
    client_secret_id varchar2,
    client_secret_version_number number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_custom_client_app_details_t is a subtype of the dbms_cloud_oci_apigateway_client_app_details_t type.

Fields

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_deployment_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  gateway_id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  path_prefix varchar2(32767),
  endpoint varchar2(32767),
  specification dbms_cloud_oci_apigateway_api_specification_t,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_deployment_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_deployment_t (
    id varchar2,
    gateway_id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    path_prefix varchar2,
    endpoint varchar2,
    specification dbms_cloud_oci_apigateway_api_specification_t,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A summary of the deployment.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_deployment_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  gateway_id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  path_prefix varchar2(32767),
  endpoint 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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_deployment_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_deployment_summary_t (
    id varchar2,
    gateway_id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    path_prefix varchar2,
    endpoint 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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_deployment_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_deployment_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_deployment_summary_t) NOT PERSISTABLE;

Collection of deployment summaries.

Syntax

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

Fields

Auth endpoint details.

Syntax

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

Fields

Discovery Uri information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_discovery_uri_source_uri_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_source_uri_details_t (
  uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_discovery_uri_source_uri_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_discovery_uri_source_uri_details_t (
    l_type varchar2,
    uri varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_discovery_uri_source_uri_details_t is a subtype of the dbms_cloud_oci_apigateway_source_uri_details_t type.

Fields

Policy for the details regarding each routing backend under dynamic routing. We specify the value of selectors for which this routing backend must be selected for a request under keys. We specify the configuration details of routing backend under backend.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key dbms_cloud_oci_apigateway_dynamic_selection_key_t,
  backend dbms_cloud_oci_apigateway_api_specification_route_backend_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_t (
    key dbms_cloud_oci_apigateway_dynamic_selection_key_t,
    backend dbms_cloud_oci_apigateway_api_specification_route_backend_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_t) NOT PERSISTABLE;

Send the request to the backend dynamically selected based on the incoming request's context.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_dynamic_routing_backend_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_api_specification_route_backend_t (
  selection_source dbms_cloud_oci_apigateway_selection_source_policy_t,
  routing_backends dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_routing_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_dynamic_routing_backend_t (
    l_type varchar2,
    selection_source dbms_cloud_oci_apigateway_selection_source_policy_t,
    routing_backends dbms_cloud_oci_apigateway_dynamic_routing_type_routing_backend_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_dynamic_routing_backend_t is a subtype of the dbms_cloud_oci_apigateway_api_specification_route_backend_t type.

Fields

A summary of an entitlement included in a usage plan.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_entitlement_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  description varchar2(32767),
  rate_limit dbms_cloud_oci_apigateway_rate_limit_t,
  quota dbms_cloud_oci_apigateway_quota_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_entitlement_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_entitlement_summary_t (
    name varchar2,
    description varchar2,
    rate_limit dbms_cloud_oci_apigateway_rate_limit_t,
    quota dbms_cloud_oci_apigateway_quota_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Error Information.

Syntax

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

Fields

Details of a RESP based cache store server

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_response_cache_resp_server_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_response_cache_resp_server_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_response_cache_resp_server_t) NOT PERSISTABLE;

Connection details for an external RESP based cache store for Response Caching.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_external_resp_cache_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_response_cache_details_t (
  servers dbms_cloud_oci_apigateway_response_cache_resp_server_tbl,
  authentication_secret_id varchar2(32767),
  authentication_secret_version_number number,
  is_ssl_enabled number,
  is_ssl_verify_disabled number,
  connect_timeout_in_ms number,
  read_timeout_in_ms number,
  send_timeout_in_ms number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_external_resp_cache_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_external_resp_cache_t (
    l_type varchar2,
    servers dbms_cloud_oci_apigateway_response_cache_resp_server_tbl,
    authentication_secret_id varchar2,
    authentication_secret_version_number number,
    is_ssl_enabled number,
    is_ssl_verify_disabled number,
    connect_timeout_in_ms number,
    read_timeout_in_ms number,
    send_timeout_in_ms number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_external_resp_cache_t is a subtype of the dbms_cloud_oci_apigateway_response_cache_details_t type.

Fields

How a response from a backend is cached in the Response Cache.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_fixed_ttl_response_cache_store_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_response_cache_store_policy_t (
  time_to_live_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_fixed_ttl_response_cache_store_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_fixed_ttl_response_cache_store_policy_t (
    l_type varchar2,
    time_to_live_in_seconds number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_fixed_ttl_response_cache_store_policy_t is a subtype of the dbms_cloud_oci_apigateway_response_cache_store_policy_t type.

Fields

IP address associated with the gateway.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_ip_address_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_ip_address_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_ip_address_t) NOT PERSISTABLE;

A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_gateway_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_type varchar2(32767),
  subnet_id varchar2(32767),
  network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  hostname varchar2(32767),
  certificate_id varchar2(32767),
  ip_addresses dbms_cloud_oci_apigateway_ip_address_tbl,
  response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_gateway_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_gateway_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    endpoint_type varchar2,
    subnet_id varchar2,
    network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    hostname varchar2,
    certificate_id varchar2,
    ip_addresses dbms_cloud_oci_apigateway_ip_address_tbl,
    response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A summary of the gateway.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_gateway_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_type varchar2(32767),
  subnet_id varchar2(32767),
  network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  hostname varchar2(32767),
  certificate_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_gateway_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_gateway_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    endpoint_type varchar2,
    subnet_id varchar2,
    network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    hostname varchar2,
    certificate_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_gateway_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_gateway_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_gateway_summary_t) NOT PERSISTABLE;

Collection of gateway summaries.

Syntax

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

Fields

Send the request to an HTTP backend.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_http_backend_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_api_specification_route_backend_t (
  url varchar2(32767),
  connect_timeout_in_seconds number,
  read_timeout_in_seconds number,
  send_timeout_in_seconds number,
  is_ssl_verify_disabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_http_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_http_backend_t (
    l_type varchar2,
    url varchar2,
    connect_timeout_in_seconds number,
    read_timeout_in_seconds number,
    send_timeout_in_seconds number,
    is_ssl_verify_disabled number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_http_backend_t is a subtype of the dbms_cloud_oci_apigateway_api_specification_route_backend_t type.

Fields

Header in key/value pair.

Syntax

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

Fields

A static public key which is used to verify the JWT signature.

Syntax

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

Fields

A JSON Web Key that represents the public key used for verifying the JWT signature.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_json_web_key_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_static_public_key_t (
  kty varchar2(32767),
  use varchar2(32767),
  key_ops dbms_cloud_oci_apigateway_varchar2_tbl,
  alg varchar2(32767),
  n varchar2(32767),
  e varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_json_web_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_json_web_key_t (
    kid varchar2,
    format varchar2,
    kty varchar2,
    use varchar2,
    key_ops dbms_cloud_oci_apigateway_varchar2_tbl,
    alg varchar2,
    n varchar2,
    e varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_json_web_key_t is a subtype of the dbms_cloud_oci_apigateway_static_public_key_t type.

Fields

A set of Public Keys that will be used to verify the JWT signature.

Syntax

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

Fields

Validate a JWT token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_jwt_authentication_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_authentication_policy_t (
  token_header varchar2(32767),
  token_query_param varchar2(32767),
  token_auth_scheme varchar2(32767),
  max_clock_skew_in_seconds number,
  issuers dbms_cloud_oci_apigateway_varchar2_tbl,
  audiences dbms_cloud_oci_apigateway_varchar2_tbl,
  verify_claims dbms_cloud_oci_apigateway_json_web_token_claim_tbl,
  public_keys dbms_cloud_oci_apigateway_public_key_set_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_jwt_authentication_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_jwt_authentication_policy_t (
    is_anonymous_access_allowed number,
    l_type varchar2,
    token_header varchar2,
    token_query_param varchar2,
    token_auth_scheme varchar2,
    max_clock_skew_in_seconds number,
    issuers dbms_cloud_oci_apigateway_varchar2_tbl,
    audiences dbms_cloud_oci_apigateway_varchar2_tbl,
    verify_claims dbms_cloud_oci_apigateway_json_web_token_claim_tbl,
    public_keys dbms_cloud_oci_apigateway_public_key_set_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_jwt_authentication_policy_t is a subtype of the dbms_cloud_oci_apigateway_authentication_policy_t type.

Fields

Policy to specify how to modify the response code, body and headers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_modify_response_validation_failure_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_validation_failure_policy_t (
  response_code varchar2(32767),
  response_message varchar2(32767),
  response_header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_modify_response_validation_failure_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_modify_response_validation_failure_policy_t (
    l_type varchar2,
    response_code varchar2,
    response_message varchar2,
    response_header_transformations dbms_cloud_oci_apigateway_header_transformation_policy_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_modify_response_validation_failure_policy_t is a subtype of the dbms_cloud_oci_apigateway_validation_failure_policy_t type.

Fields

Configures the gateway with no caching. Cache lookup and store policies will not be supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_no_cache_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_response_cache_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_no_cache_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_no_cache_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_no_cache_t is a subtype of the dbms_cloud_oci_apigateway_response_cache_details_t type.

No content validation properties.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_no_content_validation_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_content_validation_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_no_content_validation_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_no_content_validation_t (
    validation_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_no_content_validation_t is a subtype of the dbms_cloud_oci_apigateway_content_validation_t type.

Backend which when called triggers OAuth2 logout.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_o_auth2_logout_backend_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_api_specification_route_backend_t (
  allowed_post_logout_uris dbms_cloud_oci_apigateway_varchar2_tbl,
  post_logout_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_o_auth2_logout_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_o_auth2_logout_backend_t (
    l_type varchar2,
    allowed_post_logout_uris dbms_cloud_oci_apigateway_varchar2_tbl,
    post_logout_state varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_o_auth2_logout_backend_t is a subtype of the dbms_cloud_oci_apigateway_api_specification_route_backend_t type.

Fields

Policy to specify OAuth2 flow configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_o_auth2_response_validation_failure_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_validation_failure_policy_t (
  client_details dbms_cloud_oci_apigateway_client_app_details_t,
  source_uri_details dbms_cloud_oci_apigateway_source_uri_details_t,
  scopes dbms_cloud_oci_apigateway_varchar2_tbl,
  max_expiry_duration_in_hours number,
  use_cookies_for_session number,
  use_cookies_for_intermediate_steps number,
  use_pkce number,
  response_type varchar2(32767),
  fallback_redirect_path varchar2(32767),
  logout_path varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_o_auth2_response_validation_failure_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_o_auth2_response_validation_failure_policy_t (
    l_type varchar2,
    client_details dbms_cloud_oci_apigateway_client_app_details_t,
    source_uri_details dbms_cloud_oci_apigateway_source_uri_details_t,
    scopes dbms_cloud_oci_apigateway_varchar2_tbl,
    max_expiry_duration_in_hours number,
    use_cookies_for_session number,
    use_cookies_for_intermediate_steps number,
    use_pkce number,
    response_type varchar2,
    fallback_redirect_path varchar2,
    logout_path varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_o_auth2_response_validation_failure_policy_t is a subtype of the dbms_cloud_oci_apigateway_validation_failure_policy_t type.

Fields

Send the request to an Oracle Functions function.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_oracle_function_backend_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_api_specification_route_backend_t (
  function_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_oracle_function_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_oracle_function_backend_t (
    l_type varchar2,
    function_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_oracle_function_backend_t is a subtype of the dbms_cloud_oci_apigateway_api_specification_route_backend_t type.

Fields

A PEM-encoded public key used for verifying the JWT signature.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_pem_encoded_public_key_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_static_public_key_t (
  key varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_pem_encoded_public_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_pem_encoded_public_key_t (
    kid varchar2,
    format varchar2,
    key varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_pem_encoded_public_key_t is a subtype of the dbms_cloud_oci_apigateway_static_public_key_t type.

Fields

A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_remote_json_web_key_set_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_public_key_set_t (
  uri varchar2(32767),
  is_ssl_verify_disabled number,
  max_cache_duration_in_hours number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_remote_json_web_key_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_remote_json_web_key_set_t (
    l_type varchar2,
    uri varchar2,
    is_ssl_verify_disabled number,
    max_cache_duration_in_hours number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_remote_json_web_key_set_t is a subtype of the dbms_cloud_oci_apigateway_public_key_set_t type.

Fields

Common parameter validation properties.

Syntax

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

Fields

Information about the SDK.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  api_id varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  display_name varchar2(32767),
  target_language varchar2(32767),
  artifact_url varchar2(32767),
  time_artifact_url_expires_at timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  parameters json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_sdk_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_sdk_t (
    id varchar2,
    api_id varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    display_name varchar2,
    target_language varchar2,
    artifact_url varchar2,
    time_artifact_url_expires_at timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    parameters json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A summary of the SDK.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_sdk_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_sdk_summary_t) NOT PERSISTABLE;

Collection of the existing SDKs.

Syntax

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

Fields

Allowed value object.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_sdk_language_optional_parameters_allowed_value_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_language_optional_parameters_allowed_value_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_sdk_language_optional_parameters_allowed_value_t) NOT PERSISTABLE;

List of additional applicable parameters for any given target language.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_language_optional_parameters_t FORCE AUTHID CURRENT_USER IS OBJECT (
  param_name varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  is_required number,
  max_size number,
  input_type varchar2(32767),
  allowed_values dbms_cloud_oci_apigateway_sdk_language_optional_parameters_allowed_value_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_sdk_language_optional_parameters_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_sdk_language_optional_parameters_t (
    param_name varchar2,
    display_name varchar2,
    description varchar2,
    is_required number,
    max_size number,
    input_type varchar2,
    allowed_values dbms_cloud_oci_apigateway_sdk_language_optional_parameters_allowed_value_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_sdk_language_optional_parameters_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_language_optional_parameters_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_sdk_language_optional_parameters_t) NOT PERSISTABLE;

SDK target language details.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_sdk_language_type_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_sdk_language_type_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_sdk_language_type_summary_t) NOT PERSISTABLE;

Collection of available SDK target languages.

Syntax

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

Fields

SDK target language details.

Syntax

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

Fields

Provides ability to vary the cache key using context expressions.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_simple_lookup_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_response_cache_lookup_policy_t (
  cache_key_additions dbms_cloud_oci_apigateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_simple_lookup_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_simple_lookup_policy_t (
    l_type varchar2,
    is_enabled number,
    is_private_caching_enabled number,
    cache_key_additions dbms_cloud_oci_apigateway_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_simple_lookup_policy_t is a subtype of the dbms_cloud_oci_apigateway_response_cache_lookup_policy_t type.

Fields

The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_single_selection_source_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_selection_source_policy_t (
  selector varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_single_selection_source_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_single_selection_source_policy_t (
    l_type varchar2,
    selector varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_single_selection_source_policy_t is a subtype of the dbms_cloud_oci_apigateway_selection_source_policy_t type.

Fields

Nested table type of dbms_cloud_oci_apigateway_static_public_key_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_static_public_key_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_static_public_key_t) NOT PERSISTABLE;

A set of static public keys that will be used to verify the JWT signature.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_static_public_key_set_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_public_key_set_t (
  keys dbms_cloud_oci_apigateway_static_public_key_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_static_public_key_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_static_public_key_set_t (
    l_type varchar2,
    keys dbms_cloud_oci_apigateway_static_public_key_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_static_public_key_set_t is a subtype of the dbms_cloud_oci_apigateway_public_key_set_t type.

Fields

Nested table type of dbms_cloud_oci_apigateway_header_field_specification_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_header_field_specification_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_header_field_specification_t) NOT PERSISTABLE;

Send the request to a mock backend.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_stock_response_backend_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_api_specification_route_backend_t (
  body varchar2(32767),
  status number,
  headers dbms_cloud_oci_apigateway_header_field_specification_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_stock_response_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_stock_response_backend_t (
    l_type varchar2,
    body varchar2,
    status number,
    headers dbms_cloud_oci_apigateway_header_field_specification_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_stock_response_backend_t is a subtype of the dbms_cloud_oci_apigateway_api_specification_route_backend_t type.

Fields

A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_subscriber_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  clients dbms_cloud_oci_apigateway_client_tbl,
  usage_plans dbms_cloud_oci_apigateway_varchar2_tbl,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_subscriber_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_subscriber_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    clients dbms_cloud_oci_apigateway_client_tbl,
    usage_plans dbms_cloud_oci_apigateway_varchar2_tbl,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_client_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_client_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_client_summary_t) NOT PERSISTABLE;

A summary of a subscriber.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_subscriber_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  clients dbms_cloud_oci_apigateway_client_summary_tbl,
  usage_plans dbms_cloud_oci_apigateway_varchar2_tbl,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_subscriber_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_subscriber_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    clients dbms_cloud_oci_apigateway_client_summary_tbl,
    usage_plans dbms_cloud_oci_apigateway_varchar2_tbl,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_subscriber_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_subscriber_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_subscriber_summary_t) NOT PERSISTABLE;

Collection of subscriber summaries.

Syntax

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

Fields

Authentication Policies for the Token Authentication types.

Syntax

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

Fields

Validate a token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_token_authentication_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_authentication_policy_t (
  token_header varchar2(32767),
  token_query_param varchar2(32767),
  token_auth_scheme varchar2(32767),
  max_clock_skew_in_seconds number,
  validation_policy dbms_cloud_oci_apigateway_token_authentication_validation_policy_t,
  validation_failure_policy dbms_cloud_oci_apigateway_validation_failure_policy_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_policy_t (
    is_anonymous_access_allowed number,
    l_type varchar2,
    token_header varchar2,
    token_query_param varchar2,
    token_auth_scheme varchar2,
    max_clock_skew_in_seconds number,
    validation_policy dbms_cloud_oci_apigateway_token_authentication_validation_policy_t,
    validation_failure_policy dbms_cloud_oci_apigateway_validation_failure_policy_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_token_authentication_policy_t is a subtype of the dbms_cloud_oci_apigateway_authentication_policy_t type.

Fields

Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_token_authentication_remote_discovery_validation_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_token_authentication_validation_policy_t (
  client_details dbms_cloud_oci_apigateway_client_app_details_t,
  source_uri_details dbms_cloud_oci_apigateway_source_uri_details_t,
  is_ssl_verify_disabled number,
  max_cache_duration_in_hours number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_remote_discovery_validation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_remote_discovery_validation_policy_t (
    l_type varchar2,
    additional_validation_policy dbms_cloud_oci_apigateway_additional_validation_policy_t,
    client_details dbms_cloud_oci_apigateway_client_app_details_t,
    source_uri_details dbms_cloud_oci_apigateway_source_uri_details_t,
    is_ssl_verify_disabled number,
    max_cache_duration_in_hours number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_token_authentication_remote_discovery_validation_policy_t is a subtype of the dbms_cloud_oci_apigateway_token_authentication_validation_policy_t type.

Fields

A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_token_authentication_remote_jwks_validation_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_token_authentication_validation_policy_t (
  uri varchar2(32767),
  is_ssl_verify_disabled number,
  max_cache_duration_in_hours number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_remote_jwks_validation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_remote_jwks_validation_policy_t (
    l_type varchar2,
    additional_validation_policy dbms_cloud_oci_apigateway_additional_validation_policy_t,
    uri varchar2,
    is_ssl_verify_disabled number,
    max_cache_duration_in_hours number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_token_authentication_remote_jwks_validation_policy_t is a subtype of the dbms_cloud_oci_apigateway_token_authentication_validation_policy_t type.

Fields

A set of static public keys that will be used to verify the JWT signature.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_token_authentication_static_keys_validation_policy_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_token_authentication_validation_policy_t (
  keys dbms_cloud_oci_apigateway_static_public_key_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_static_keys_validation_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_token_authentication_static_keys_validation_policy_t (
    l_type varchar2,
    additional_validation_policy dbms_cloud_oci_apigateway_additional_validation_policy_t,
    keys dbms_cloud_oci_apigateway_static_public_key_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_token_authentication_static_keys_validation_policy_t is a subtype of the dbms_cloud_oci_apigateway_token_authentication_validation_policy_t type.

Fields

The information to be updated.

Syntax

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

Fields

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_update_certificate_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_apigateway_update_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_update_certificate_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information to be updated.

Syntax

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

Fields

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_update_gateway_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
  certificate_id varchar2(32767),
  response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_update_gateway_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_update_gateway_details_t (
    display_name varchar2,
    network_security_group_ids dbms_cloud_oci_apigateway_varchar2_tbl,
    certificate_id varchar2,
    response_cache_details dbms_cloud_oci_apigateway_response_cache_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    ca_bundles dbms_cloud_oci_apigateway_ca_bundle_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_update_sdk_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_apigateway_update_sdk_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_update_sdk_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The information to be updated.

Syntax

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

Fields

The information to be updated.

Syntax

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

Fields

A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_usage_plan_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  entitlements dbms_cloud_oci_apigateway_entitlement_tbl,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plan_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plan_t (
    id varchar2,
    display_name varchar2,
    entitlements dbms_cloud_oci_apigateway_entitlement_tbl,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_entitlement_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_entitlement_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_entitlement_summary_t) NOT PERSISTABLE;

A summary of the usage plan.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_usage_plan_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  entitlements dbms_cloud_oci_apigateway_entitlement_summary_tbl,
  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,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plan_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_usage_plan_summary_t (
    id varchar2,
    display_name varchar2,
    entitlements dbms_cloud_oci_apigateway_entitlement_summary_tbl,
    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
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_apigateway_usage_plan_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_usage_plan_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_usage_plan_summary_t) NOT PERSISTABLE;

Collection of usage plan summaries.

Syntax

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

Fields

Client App Credentials to be used from validation block.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_validation_block_client_app_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_client_app_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_validation_block_client_app_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_validation_block_client_app_details_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_validation_block_client_app_details_t is a subtype of the dbms_cloud_oci_apigateway_client_app_details_t type.

Source Uri information to be used from validation block.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_validation_block_source_uri_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_source_uri_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_validation_block_source_uri_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_validation_block_source_uri_details_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_validation_block_source_uri_details_t is a subtype of the dbms_cloud_oci_apigateway_source_uri_details_t type.

Top-level validation policy mixin (not directly used).

Syntax

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

Fields

When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_wildcard_selection_key_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apigateway_dynamic_selection_key_t (
  expression varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_wildcard_selection_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_wildcard_selection_key_t (
    l_type varchar2,
    is_default number,
    name varchar2,
    expression varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_apigateway_wildcard_selection_key_t is a subtype of the dbms_cloud_oci_apigateway_dynamic_selection_key_t type.

Fields

A resource created or operated on by a work request.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_work_request_resource_t) NOT PERSISTABLE;

A description of the work request status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  operation_type varchar2(32767),
  status varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_apigateway_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_apigateway_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_work_request_t (
    id varchar2,
    operation_type varchar2,
    status varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_apigateway_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

A summary of the work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  work_request_id varchar2(32767),
  compartment_id varchar2(32767),
  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_apigateway_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apigateway_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    work_request_id varchar2,
    compartment_id varchar2,
    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

Nested table type of dbms_cloud_oci_apigateway_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_work_request_summary_t) NOT PERSISTABLE;

Collection of work request summaries.

Syntax

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

Fields

An error encountered while executing a work request.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_work_request_error_t) NOT PERSISTABLE;

Collection of work request errors.

Syntax

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

Fields

A log message from the execution of a work request.

Syntax

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

Fields

Nested table type of dbms_cloud_oci_apigateway_work_request_log_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apigateway_work_request_log_tbl FORCE IS TABLE OF (dbms_cloud_oci_apigateway_work_request_log_t) NOT PERSISTABLE;

Collection of work request logs.

Syntax

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

Fields