Oracle Cloud Infrastructure Documentation
Try Free Tier

Visual Builder Common Types

DBMS_CLOUD_OCI_VISUAL_BUILDER_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_VISUAL_BUILDER_APPLICATION_SUMMARY_T Type

Summary of the Vb Instance's applications.

Syntax

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

Fields

Field Description

id

(required) Unique identifier of the application.

project_id

(required) Project identifier.

version

(required) Version of deployed application.

state

(required) Represents the deployment state of the application.

Allowed values are: 'STAGE', 'LIVE'

DBMS_CLOUD_OCI_VISUAL_BUILDER_APPLICATION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_application_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_application_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_application_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_APPLICATION_SUMMARY_COLLECTION_T Type

Result of listing VbInstance's applications. Contains ApplicationSummary items.

Syntax

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

Fields

Field Description

items

(required) The collection of ApplicationSummary objects.

DBMS_CLOUD_OCI_VISUAL_BUILDER_ATTACHMENT_DETAILS_T Type

Description of an attachments for this instance

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_role varchar2(32767),
  is_implicit number,
  target_id varchar2(32767),
  target_instance_url varchar2(32767),
  target_service_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_attachment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_attachment_details_t (
    target_role varchar2,
    is_implicit number,
    target_id varchar2,
    target_instance_url varchar2,
    target_service_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_role

(required) The role of the target attachment. * `PARENT` - The target instance is the parent of this attachment. * `CHILD` - The target instance is the child of this attachment.

Allowed values are: 'PARENT', 'CHILD'

is_implicit

(required) * If role == `PARENT`, the attached instance was created by this service instance * If role == `CHILD`, this instance was created from attached instance on behalf of a user

target_id

(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.

target_instance_url

(required) The dataplane instance URL of the attached instance

target_service_type

(required) The type of the target instance, such as \"FUSION\".

DBMS_CLOUD_OCI_VISUAL_BUILDER_CHANGE_VB_INSTANCE_COMPARTMENT_DETAILS_T Type

Compartment the VbInstance will be moved to

Syntax

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

Fields

Field Description

compartment_id

(required) Compartment Identifier.

DBMS_CLOUD_OCI_VISUAL_BUILDER_CREATE_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the vb instance (update).

Syntax

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

Fields

Field Description

hostname

(required) A custom hostname to be used for the vb instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate.

DBMS_CLOUD_OCI_VISUAL_BUILDER_CREATE_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_create_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_create_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_create_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_CREATE_VB_INSTANCE_DETAILS_T Type

The information about new VbInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_create_vb_instance_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,
  idcs_open_id varchar2(32767),
  node_count number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_visual_builder_create_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_visual_builder_create_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_create_vb_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_create_vb_instance_details_t (
    display_name varchar2,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    idcs_open_id varchar2,
    node_count number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_visual_builder_create_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_visual_builder_create_custom_endpoint_details_tbl,
    consumption_model varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Vb Instance Identifier.

compartment_id

(required) Compartment Identifier.

freeform_tags

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

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

idcs_open_id

(optional) Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter

node_count

(required) The number of Nodes

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints to be used for the vb instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).

consumption_model

(optional) Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.

Allowed values are: 'UCM', 'GOV', 'VB4SAAS'

DBMS_CLOUD_OCI_VISUAL_BUILDER_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the vb instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_custom_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  certificate_secret_id varchar2(32767),
  certificate_secret_version number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_custom_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_custom_endpoint_details_t (
    hostname varchar2,
    certificate_secret_id varchar2,
    certificate_secret_version number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) A custom hostname to be used for the vb instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

certificate_secret_version

(optional) The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

DBMS_CLOUD_OCI_VISUAL_BUILDER_ERROR_T Type

Error Information.

Syntax

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

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_VISUAL_BUILDER_IDCS_INFO_DETAILS_T Type

Information for IDCS access

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_idcs_info_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  idcs_app_location_url varchar2(32767),
  idcs_app_display_name varchar2(32767),
  idcs_app_id varchar2(32767),
  idcs_app_name varchar2(32767),
  instance_primary_audience_url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_idcs_info_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_idcs_info_details_t (
    idcs_app_location_url varchar2,
    idcs_app_display_name varchar2,
    idcs_app_id varchar2,
    idcs_app_name varchar2,
    instance_primary_audience_url varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

idcs_app_location_url

(required) URL for the location of the IDCS Application (used by IDCS APIs)

idcs_app_display_name

(required) The IDCS application display name associated with the instance

idcs_app_id

(required) The IDCS application ID associated with the instance

idcs_app_name

(required) The IDCS application name associated with the instance

instance_primary_audience_url

(required) The URL used as the primary audience for visual builder flows in this instance type: string

DBMS_CLOUD_OCI_VISUAL_BUILDER_REQUEST_SUMMARIZED_APPLICATIONS_DETAILS_T Type

The information to summarize the applications.

Syntax

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

Fields

Field Description

idcs_open_id

(optional) Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter

DBMS_CLOUD_OCI_VISUAL_BUILDER_UPDATE_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the vb instance (update).

Syntax

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

Fields

Field Description

hostname

(required) A custom hostname to be used for the vb instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret. Note the update will fail if this is not a valid certificate.

DBMS_CLOUD_OCI_VISUAL_BUILDER_UPDATE_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_update_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_update_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_update_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_UPDATE_VB_INSTANCE_DETAILS_T Type

Information about updating a VbInstance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_update_vb_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  idcs_open_id varchar2(32767),
  node_count number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_visual_builder_update_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_visual_builder_update_custom_endpoint_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_update_vb_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_update_vb_instance_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    idcs_open_id varchar2,
    node_count number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_visual_builder_update_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_visual_builder_update_custom_endpoint_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Vb Instance Identifier.

freeform_tags

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

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

idcs_open_id

(optional) Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter

node_count

(optional) The number of Nodes

is_visual_builder_enabled

(optional) Enable Visual Builder. If Visual Builder is enabled alredy, then it cannot be disabled.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints to be used for the vb instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).

DBMS_CLOUD_OCI_VISUAL_BUILDER_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_ATTACHMENT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_attachment_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_attachment_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_attachment_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_VB_INSTANCE_T Type

Description of Vb Instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_vb_instance_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),
  state_message varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  instance_url varchar2(32767),
  node_count number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_visual_builder_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_visual_builder_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  idcs_info dbms_cloud_oci_visual_builder_idcs_info_details_t,
  attachments dbms_cloud_oci_visual_builder_attachment_details_tbl,
  service_nat_gateway_ip varchar2(32767),
  management_nat_gateway_ip varchar2(32767),
  service_vcn_id varchar2(32767),
  management_vcn_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_vb_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_vb_instance_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    state_message varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    instance_url varchar2,
    node_count number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_visual_builder_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_visual_builder_custom_endpoint_details_tbl,
    consumption_model varchar2,
    idcs_info dbms_cloud_oci_visual_builder_idcs_info_details_t,
    attachments dbms_cloud_oci_visual_builder_attachment_details_tbl,
    service_nat_gateway_ip varchar2,
    management_nat_gateway_ip varchar2,
    service_vcn_id varchar2,
    management_vcn_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

display_name

(required) Vb Instance Identifier, can be renamed.

compartment_id

(required) Compartment Identifier.

time_created

(optional) The time the the VbInstance was created. An RFC3339 formatted datetime string.

time_updated

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

lifecycle_state

(required) The current state of the vb instance.

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

state_message

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

freeform_tags

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

defined_tags

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

system_tags

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

instance_url

(required) The Vb Instance URL.

node_count

(required) The number of Nodes

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints used for the vb instance URL.

consumption_model

(optional) The entitlement used for billing purposes.

Allowed values are: 'UCM', 'GOV', 'VB4SAAS'

idcs_info

(optional)

attachments

(optional) A list of associated attachments to other services

service_nat_gateway_ip

(optional) The NAT gateway IP address for the VB service VCN

management_nat_gateway_ip

(optional) The NAT gateway IP address for the VB management VCN

service_vcn_id

(optional) The Oracle Cloud ID (OCID) of the Visual Builder service VCN

management_vcn_id

(optional) The Oracle Cloud ID (OCID) of the Visual Builder management VCN

DBMS_CLOUD_OCI_VISUAL_BUILDER_VB_INSTANCE_SUMMARY_T Type

Summary of the Vb Instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_vb_instance_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),
  state_message varchar2(32767),
  instance_url varchar2(32767),
  node_count number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_visual_builder_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_visual_builder_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_vb_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_visual_builder_vb_instance_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,
    state_message varchar2,
    instance_url varchar2,
    node_count number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_visual_builder_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_visual_builder_custom_endpoint_details_tbl,
    consumption_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

display_name

(required) Vb Instance Identifier, can be renamed.

compartment_id

(required) Compartment Identifier.

time_created

(optional) The time the the Vb Instance was created. An RFC3339 formatted datetime string.

time_updated

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

lifecycle_state

(required) The current state of the Vb Instance.

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

state_message

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

instance_url

(required) The Vb Instance URL.

node_count

(required) The number of Nodes

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints used for the vb instance URL.

consumption_model

(optional) The entitlement used for billing purposes.

Allowed values are: 'UCM', 'GOV', 'VB4SAAS'

freeform_tags

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

defined_tags

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

system_tags

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

DBMS_CLOUD_OCI_VISUAL_BUILDER_VB_INSTANCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_vb_instance_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_vb_instance_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_vb_instance_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_VB_INSTANCE_SUMMARY_COLLECTION_T Type

Result of a VbInstance Summary request. Contains VbInstanceSummary items.

Syntax

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

Fields

Field Description

items

(required) The collection of VbInstanceSummary objects.

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

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

Fields

Field Description

entity_type

(required) The resource type the work request is affects.

action_type

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

Allowed values are: 'CREATED', 'UPDATED', 'STOPPED', 'STARTED', 'DELETED', 'IN_PROGRESS'

identifier

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

entity_uri

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

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_T Type

A description of work request status.

Syntax

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

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_VB_INSTANCE', 'UPDATE_VB_INSTANCE', 'STOP_VB_INSTANCE', 'START_VB_INSTANCE', 'DELETE_VB_INSTANCE'

status

(required) Status of current work request.

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

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

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

time_started

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

time_finished

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

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_ERROR_T Type

Errors related to a specific work request.

Syntax

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

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing

message

(required) A human-readable error string.

l_timestamp

(required) The date and time the error occurred.

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_ERROR_COLLECTION_T Type

Result of a WorkRequest Error request. Contains list of WorkRequestError items.

Syntax

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

Fields

Field Description

items

(required) List of objects containing errors related to a specific work request..

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_LOG_ENTRY_T Type

Log entries related to a specific work request.

Syntax

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

Fields

Field Description

message

(required) The description of an action that occurred.

l_timestamp

(required) The date and time the log entry occurred.

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Result of a WorkRequest Log request. Contains list of WorkRequestLog items.

Syntax

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

Fields

Field Description

items

(required) List of objects containing logs related to a specific work request..

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_SUMMARY_T Type

A description of work request status.

Syntax

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

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_VB_INSTANCE', 'UPDATE_VB_INSTANCE', 'STOP_VB_INSTANCE', 'START_VB_INSTANCE', 'DELETE_VB_INSTANCE'

status

(required) Status of current work request.

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

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

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

time_started

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

time_finished

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

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_visual_builder_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_visual_builder_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_visual_builder_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_VISUAL_BUILDER_WORK_REQUEST_SUMMARY_COLLECTION_T Type

Result of a WorkRequest Summary request. Contains WorkRequestSummary items.

Syntax

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

Fields

Field Description

items

(required) The collection of WorkRequestSummary objects.

Was this article helpful?