Oracle Cloud Infrastructure Documentation

Service Manager Proxy Common Types

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_ERROR_ENTITY_T Type

The model for the error entity.

Syntax

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

Fields

Field Description

code

(required) A short error code that defines the error.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_DEFINITION_T Type

Details for a service definition.

Syntax

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

Fields

Field Description

l_type

(required) The service definition type. For example, a service definition type \"RGBUOROMS\" would be for the service \"Oracle Retail Order Management Cloud Service\".

display_name

(required) Display name of the service. For example, \"Oracle Retail Order Management Cloud Service\".

short_display_name

(required) Short display name of the service. For example, \"Retail Order Management\".

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_END_POINT_OVERVIEW_T Type

An overview of service environment endpoints.

Syntax

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

Fields

Field Description

environment_type

(required) Service environment endpoint type.

Allowed values are: 'INSTANCE_URL_PROD', 'INSTANCE_URL_TEST', 'INSTANCE_URL_DEV', 'OTHER'

url

(required) Service environment instance URL.

description

(optional) Description of the environment link

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_END_POINT_OVERVIEW_TBL Type

Nested table type of dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_tbl FORCE IS TABLE OF (dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_T Type

Detailed information about a service environment. **Note:** Service URL formats may vary from the provided example.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_service_manager_proxy_service_environment_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  subscription_id varchar2(32767),
  status varchar2(32767),
  compartment_id varchar2(32767),
  service_definition dbms_cloud_oci_service_manager_proxy_service_definition_t,
  console_url varchar2(32767),
  service_environment_endpoints dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_service_manager_proxy_service_environment_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_service_manager_proxy_service_environment_t (
    id varchar2,
    subscription_id varchar2,
    status varchar2,
    compartment_id varchar2,
    service_definition dbms_cloud_oci_service_manager_proxy_service_definition_t,
    console_url varchar2,
    service_environment_endpoints dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unqiue identifier for the entitlement related to the environment. **Note:** Not an OCID.

subscription_id

(required) The unique subscription ID associated with the service environment ID. **Note:** Not an OCID.

status

(required) Status of the entitlement registration for the service.

Allowed values are: 'INITIALIZED', 'BEGIN_ACTIVATION', 'ACTIVE', 'BEGIN_SOFT_TERMINATION', 'SOFT_TERMINATED', 'BEGIN_TERMINATION', 'CANCELED', 'TERMINATED', 'BEGIN_DISABLING', 'BEGIN_ENABLING', 'BEGIN_MIGRATION', 'DISABLED', 'BEGIN_SUSPENSION', 'BEGIN_RESUMPTION', 'SUSPENDED', 'BEGIN_LOCK_RELOCATION', 'LOCKED_RELOCATION', 'BEGIN_RELOCATION', 'RELOCATED', 'BEGIN_UNLOCK_RELOCATION', 'UNLOCKED_RELOCATION', 'FAILED_LOCK_RELOCATION', 'FAILED_ACTIVATION', 'FAILED_MIGRATION', 'ACCESS_DISABLED', 'BEGIN_DISABLING_ACCESS', 'BEGIN_ENABLING_ACCESS', 'TRA_UNKNOWN'

compartment_id

(required) The OCID for the compartment.

service_definition

(required)

console_url

(optional) The URL for the console.

service_environment_endpoints

(optional) Array of service environment end points.

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_SUMMARY_T Type

Summary of service environment details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_service_manager_proxy_service_environment_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  subscription_id varchar2(32767),
  status varchar2(32767),
  compartment_id varchar2(32767),
  service_definition dbms_cloud_oci_service_manager_proxy_service_definition_t,
  console_url varchar2(32767),
  service_environment_endpoints dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_tbl,
  defined_tags json_element_t,
  freeform_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_service_manager_proxy_service_environment_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_service_manager_proxy_service_environment_summary_t (
    id varchar2,
    subscription_id varchar2,
    status varchar2,
    compartment_id varchar2,
    service_definition dbms_cloud_oci_service_manager_proxy_service_definition_t,
    console_url varchar2,
    service_environment_endpoints dbms_cloud_oci_service_manager_proxy_service_environment_end_point_overview_tbl,
    defined_tags json_element_t,
    freeform_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unqiue identifier for the entitlement related to the environment. **Note:** Not an OCID.

subscription_id

(required) The unique subscription ID associated with the service environment ID. **Note:** Not an OCID.

status

(required) Status of the entitlement registration for the service.

Allowed values are: 'INITIALIZED', 'BEGIN_ACTIVATION', 'ACTIVE', 'BEGIN_SOFT_TERMINATION', 'SOFT_TERMINATED', 'BEGIN_TERMINATION', 'CANCELED', 'TERMINATED', 'BEGIN_DISABLING', 'BEGIN_ENABLING', 'BEGIN_MIGRATION', 'DISABLED', 'BEGIN_SUSPENSION', 'BEGIN_RESUMPTION', 'SUSPENDED', 'BEGIN_LOCK_RELOCATION', 'LOCKED_RELOCATION', 'BEGIN_RELOCATION', 'RELOCATED', 'BEGIN_UNLOCK_RELOCATION', 'UNLOCKED_RELOCATION', 'FAILED_LOCK_RELOCATION', 'FAILED_ACTIVATION', 'FAILED_MIGRATION', 'ACCESS_DISABLED', 'BEGIN_DISABLING_ACCESS', 'BEGIN_ENABLING_ACCESS', 'TRA_UNKNOWN'

compartment_id

(required) The OCID for the compartment.

service_definition

(required)

console_url

(optional) The URL for the console.

service_environment_endpoints

(optional) Array of service environment end points.

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

freeform_tags

(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"CostCenter\": \"42\"}`

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_service_manager_proxy_service_environment_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_service_manager_proxy_service_environment_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_service_manager_proxy_service_environment_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_SERVICE_MANAGER_PROXY_SERVICE_ENVIRONMENT_COLLECTION_T Type

Collection of service environments. **Note:** Service URL formats may vary from the provided example.

Syntax

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

Fields

Field Description

items

(required) Collection of items.