Oracle Cloud Infrastructure Documentation

Analytics Common Types

DBMS_CLOUD_OCI_ANALYTICS_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_ANALYTICS_CAPACITY_T Type

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

Syntax

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

Fields

Field Description

capacity_type

(required) The capacity model to use.

Allowed values are: 'OLPU_COUNT', 'USER_COUNT'

capacity_value

(required) The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

DBMS_CLOUD_OCI_ANALYTICS_NETWORK_ENDPOINT_DETAILS_T Type

Base representation of a network endpoint.

Syntax

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

Fields

Field Description

network_endpoint_type

(required) The type of network endpoint.

Allowed values are: 'PUBLIC', 'PRIVATE'

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_SOURCE_DNS_ZONE_T Type

Private source DNS Zone model.

Syntax

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

Fields

Field Description

dns_zone

(required) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.

description

(optional) Description of private source dns zone.

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_SOURCE_SCAN_HOST_T Type

Private source Scan Hostname model.

Syntax

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

Fields

Field Description

scan_hostname

(required) Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.

scan_port

(required) Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).

description

(optional) Description of private source scan host zone.

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_SOURCE_DNS_ZONE_TBL Type

Nested table type of dbms_cloud_oci_analytics_private_source_dns_zone_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_private_source_dns_zone_tbl FORCE IS TABLE OF (dbms_cloud_oci_analytics_private_source_dns_zone_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_SOURCE_SCAN_HOST_TBL Type

Nested table type of dbms_cloud_oci_analytics_private_source_scan_host_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_private_source_scan_host_tbl FORCE IS TABLE OF (dbms_cloud_oci_analytics_private_source_scan_host_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_ACCESS_CHANNEL_T Type

Analytics Instance Private Access Channel model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_private_access_channel_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  display_name varchar2(32767),
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  ip_address varchar2(32767),
  egress_source_ip_addresses dbms_cloud_oci_analytics_varchar2_tbl,
  private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
  private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
  network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_private_access_channel_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_private_access_channel_t (
    key varchar2,
    display_name varchar2,
    vcn_id varchar2,
    subnet_id varchar2,
    ip_address varchar2,
    egress_source_ip_addresses dbms_cloud_oci_analytics_varchar2_tbl,
    private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
    private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
    network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(required) Private Access Channel unique identifier key.

display_name

(required) Display Name of the Private Access Channel.

vcn_id

(required) OCID of the customer VCN peered with private access channel.

subnet_id

(required) OCID of the customer subnet connected to private access channel.

ip_address

(required) IP Address of the Private Access channel.

egress_source_ip_addresses

(required) The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.

private_source_dns_zones

(optional) List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.

private_source_scan_hosts

(optional) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.

network_security_group_ids

(optional) Network Security Group OCIDs for an Analytics instance.

DBMS_CLOUD_OCI_ANALYTICS_VANITY_URL_DETAILS_T Type

Vanity url configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_vanity_url_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  description varchar2(32767),
  urls dbms_cloud_oci_analytics_varchar2_tbl,
  hosts dbms_cloud_oci_analytics_varchar2_tbl,
  public_certificate varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_vanity_url_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_vanity_url_details_t (
    key varchar2,
    description varchar2,
    urls dbms_cloud_oci_analytics_varchar2_tbl,
    hosts dbms_cloud_oci_analytics_varchar2_tbl,
    public_certificate varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) The vanity url unique identifier key.

description

(optional) Description of the vanity url.

urls

(optional) List of urls supported by this vanity URL definition (max of 3).

hosts

(optional) List of fully qualified hostnames supported by this vanity URL definition (max of 3).

public_certificate

(optional) PEM certificate for HTTPS connections.

DBMS_CLOUD_OCI_ANALYTICS_ANALYTICS_INSTANCE_T Type

Analytics Instance metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_analytics_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  feature_set varchar2(32767),
  l_capacity dbms_cloud_oci_analytics_capacity_t,
  license_type varchar2(32767),
  email_notification varchar2(32767),
  network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
  private_access_channels json_element_t,
  vanity_url_details json_element_t,
  service_url varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  kms_key_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_analytics_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_analytics_instance_t (
    id varchar2,
    name varchar2,
    description varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    feature_set varchar2,
    l_capacity dbms_cloud_oci_analytics_capacity_t,
    license_type varchar2,
    email_notification varchar2,
    network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
    private_access_channels json_element_t,
    vanity_url_details json_element_t,
    service_url varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t,
    kms_key_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The resource OCID.

name

(required) The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

description

(optional) Optional description.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of an instance.

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

feature_set

(required) Analytics feature set.

Allowed values are: 'SELF_SERVICE_ANALYTICS', 'ENTERPRISE_ANALYTICS'

l_capacity

(required)

license_type

(optional) The license used for the service.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

email_notification

(optional) Email address receiving notifications.

network_endpoint_details

(required)

private_access_channels

(optional) Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.

vanity_url_details

(optional) Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

service_url

(optional) URL of the Analytics service.

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: `{\"Department\": \"Finance\"}`

kms_key_id

(optional) The OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.

time_created

(required) The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_updated

(optional) The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.

DBMS_CLOUD_OCI_ANALYTICS_ANALYTICS_INSTANCE_SUMMARY_T Type

Analytics Instance metadata (summary view).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_analytics_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  feature_set varchar2(32767),
  l_capacity dbms_cloud_oci_analytics_capacity_t,
  license_type varchar2(32767),
  email_notification varchar2(32767),
  network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
  service_url varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_analytics_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_analytics_instance_summary_t (
    id varchar2,
    name varchar2,
    description varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    feature_set varchar2,
    l_capacity dbms_cloud_oci_analytics_capacity_t,
    license_type varchar2,
    email_notification varchar2,
    network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
    service_url varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The resource OCID.

name

(required) The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

description

(optional) Optional description.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of an instance.

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

feature_set

(required) Analytics feature set.

Allowed values are: 'SELF_SERVICE_ANALYTICS', 'ENTERPRISE_ANALYTICS'

l_capacity

(required)

license_type

(optional) The license used for the service.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

email_notification

(optional) Email address receiving notifications.

network_endpoint_details

(required)

service_url

(optional) URL of the Analytics service.

time_created

(required) The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_updated

(optional) The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.

DBMS_CLOUD_OCI_ANALYTICS_CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT_DETAILS_T Type

Input payload to update an Analytics instance endpoint details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_change_analytics_instance_network_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_change_analytics_instance_network_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_change_analytics_instance_network_endpoint_details_t (
    network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

network_endpoint_details

(required)

DBMS_CLOUD_OCI_ANALYTICS_CHANGE_COMPARTMENT_DETAILS_T Type

Input payload to change a resource's compartment.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the new compartment.

DBMS_CLOUD_OCI_ANALYTICS_CREATE_ANALYTICS_INSTANCE_DETAILS_T Type

Input payload to create an Anaytics instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_create_analytics_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  feature_set varchar2(32767),
  l_capacity dbms_cloud_oci_analytics_capacity_t,
  license_type varchar2(32767),
  email_notification varchar2(32767),
  network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
  idcs_access_token varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  kms_key_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_analytics_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_analytics_instance_details_t (
    name varchar2,
    description varchar2,
    compartment_id varchar2,
    feature_set varchar2,
    l_capacity dbms_cloud_oci_analytics_capacity_t,
    license_type varchar2,
    email_notification varchar2,
    network_endpoint_details dbms_cloud_oci_analytics_network_endpoint_details_t,
    idcs_access_token varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t,
    kms_key_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

description

(optional) Optional description.

compartment_id

(required) The OCID of the compartment.

feature_set

(required) Analytics feature set.

Allowed values are: 'SELF_SERVICE_ANALYTICS', 'ENTERPRISE_ANALYTICS'

l_capacity

(required)

license_type

(required) The license used for the service.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

email_notification

(optional) Email address receiving notifications.

network_endpoint_details

(optional)

idcs_access_token

(optional) IDCS access token identifying a stripe and service administrator user.

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: `{\"Department\": \"Finance\"}`

kms_key_id

(optional) The OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.

DBMS_CLOUD_OCI_ANALYTICS_CREATE_PRIVATE_ACCESS_CHANNEL_DETAILS_T Type

Input payload to create a Private Access Channel.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_create_private_access_channel_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
  private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
  network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_private_access_channel_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_private_access_channel_details_t (
    display_name varchar2,
    vcn_id varchar2,
    subnet_id varchar2,
    private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
    private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
    network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Display Name of the Private Access Channel.

vcn_id

(required) OCID of the customer VCN peered with private access channel.

subnet_id

(required) OCID of the customer subnet connected to private access channel.

private_source_dns_zones

(required) List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.

private_source_scan_hosts

(optional) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.

network_security_group_ids

(optional) Network Security Group OCIDs for an Analytics instance.

DBMS_CLOUD_OCI_ANALYTICS_CREATE_VANITY_URL_DETAILS_T Type

Input payload to create a vanity url.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_create_vanity_url_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  hosts dbms_cloud_oci_analytics_varchar2_tbl,
  passphrase varchar2(32767),
  private_key varchar2(32767),
  public_certificate varchar2(32767),
  ca_certificate varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_vanity_url_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_create_vanity_url_details_t (
    description varchar2,
    hosts dbms_cloud_oci_analytics_varchar2_tbl,
    passphrase varchar2,
    private_key varchar2,
    public_certificate varchar2,
    ca_certificate varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) Optional description.

hosts

(required) List of fully qualified hostnames supported by this vanity URL definition (max of 3).

passphrase

(optional) Passphrase for the PEM Private key (if any).

private_key

(required) PEM Private key for HTTPS connections.

public_certificate

(required) PEM certificate for HTTPS connections.

ca_certificate

(required) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.

DBMS_CLOUD_OCI_ANALYTICS_ERROR_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_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. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_ANALYTICS_PRIVATE_ENDPOINT_DETAILS_T Type

Private endpoint configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_private_endpoint_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_analytics_network_endpoint_details_t (
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_private_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_private_endpoint_details_t (
    network_endpoint_type varchar2,
    vcn_id varchar2,
    subnet_id varchar2,
    network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_analytics_private_endpoint_details_t is a subtype of the dbms_cloud_oci_analytics_network_endpoint_details_t type.

Fields

Field Description

vcn_id

(required) The VCN OCID for the private endpoint.

subnet_id

(required) The subnet OCID for the private endpoint.

network_security_group_ids

(optional) Network Security Group OCIDs for an Analytics instance.

DBMS_CLOUD_OCI_ANALYTICS_VIRTUAL_CLOUD_NETWORK_T Type

Virtual Cloud Network definition.

Syntax

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

Fields

Field Description

id

(required) The Virtual Cloud Network OCID.

whitelisted_ips

(optional) Source IP addresses or IP address ranges in ingress rules.

DBMS_CLOUD_OCI_ANALYTICS_VIRTUAL_CLOUD_NETWORK_TBL Type

Nested table type of dbms_cloud_oci_analytics_virtual_cloud_network_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_virtual_cloud_network_tbl FORCE IS TABLE OF (dbms_cloud_oci_analytics_virtual_cloud_network_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_ANALYTICS_PUBLIC_ENDPOINT_DETAILS_T Type

Public endpoint configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_public_endpoint_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_analytics_network_endpoint_details_t (
  whitelisted_ips dbms_cloud_oci_analytics_varchar2_tbl,
  whitelisted_vcns dbms_cloud_oci_analytics_virtual_cloud_network_tbl,
  whitelisted_services dbms_cloud_oci_analytics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_public_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_public_endpoint_details_t (
    network_endpoint_type varchar2,
    whitelisted_ips dbms_cloud_oci_analytics_varchar2_tbl,
    whitelisted_vcns dbms_cloud_oci_analytics_virtual_cloud_network_tbl,
    whitelisted_services dbms_cloud_oci_analytics_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_analytics_public_endpoint_details_t is a subtype of the dbms_cloud_oci_analytics_network_endpoint_details_t type.

Fields

Field Description

whitelisted_ips

(optional) Source IP addresses or IP address ranges in ingress rules.

whitelisted_vcns

(optional) Virtual Cloud Networks allowed to access this network endpoint.

whitelisted_services

(optional) Oracle Cloud Services that are allowed to access this Analytics instance.

Allowed values are: 'ALL'

DBMS_CLOUD_OCI_ANALYTICS_SCALE_ANALYTICS_INSTANCE_DETAILS_T Type

Input payload to scale an Analytics instance up or down.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_scale_analytics_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_capacity dbms_cloud_oci_analytics_capacity_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_scale_analytics_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_scale_analytics_instance_details_t (
    l_capacity dbms_cloud_oci_analytics_capacity_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_capacity

(required)

DBMS_CLOUD_OCI_ANALYTICS_SET_KMS_KEY_DETAILS_T Type

Input payload to reset the OCI Vault encryption key.

Syntax

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

Fields

Field Description

kms_key_id

(required) OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API).

DBMS_CLOUD_OCI_ANALYTICS_UPDATE_ANALYTICS_INSTANCE_DETAILS_T Type

Input payload to update an Analytics instance. Fields that are not provided will not be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_update_analytics_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  email_notification varchar2(32767),
  license_type varchar2(32767),
  defined_tags json_element_t,
  freeform_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_analytics_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_analytics_instance_details_t (
    description varchar2,
    email_notification varchar2,
    license_type varchar2,
    defined_tags json_element_t,
    freeform_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) Optional description.

email_notification

(optional) Email address receiving notifications.

license_type

(optional) The license used for the service.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

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: `{\"Department\": \"Finance\"}`

DBMS_CLOUD_OCI_ANALYTICS_UPDATE_PRIVATE_ACCESS_CHANNEL_DETAILS_T Type

Input payload to update a Private Access Channel.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_update_private_access_channel_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  vcn_id varchar2(32767),
  subnet_id varchar2(32767),
  private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
  private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
  network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_private_access_channel_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_private_access_channel_details_t (
    display_name varchar2,
    vcn_id varchar2,
    subnet_id varchar2,
    private_source_dns_zones dbms_cloud_oci_analytics_private_source_dns_zone_tbl,
    private_source_scan_hosts dbms_cloud_oci_analytics_private_source_scan_host_tbl,
    network_security_group_ids dbms_cloud_oci_analytics_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Display Name of the Private Access Channel.

vcn_id

(optional) OCID of the customer VCN peered with private access channel.

subnet_id

(optional) OCID of the customer subnet connected to private access channel.

private_source_dns_zones

(optional) List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.

private_source_scan_hosts

(optional) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.

network_security_group_ids

(optional) Network Security Group OCIDs for an Analytics instance.

DBMS_CLOUD_OCI_ANALYTICS_UPDATE_VANITY_URL_DETAILS_T Type

Input payload to update a vanity url.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_update_vanity_url_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  passphrase varchar2(32767),
  private_key varchar2(32767),
  public_certificate varchar2(32767),
  ca_certificate varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_vanity_url_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_update_vanity_url_details_t (
    passphrase varchar2,
    private_key varchar2,
    public_certificate varchar2,
    ca_certificate varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

passphrase

(optional) Passphrase for the PEM Private key (if any).

private_key

(required) PEM Private key for HTTPS connections.

public_certificate

(required) PEM certificate for HTTPS connections.

ca_certificate

(required) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_RESOURCE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action_result varchar2(32767),
  resource_type varchar2(32767),
  identifier varchar2(32767),
  resource_uri varchar2(32767),
  metadata json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_work_request_resource_t (
    action_result varchar2,
    resource_type varchar2,
    identifier varchar2,
    resource_uri varchar2,
    metadata json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action_result

(required) The way in which this resource was affected by this work request.

Allowed values are: 'COMPARTMENT_CHANGED', 'CREATED', 'DELETED', 'STARTED', 'STOPPED', 'SCALED', 'NETWORK_ENDPOINT_CHANGED', 'VANITY_URL_CREATED', 'VANITY_URL_UPDATED', 'VANITY_URL_DELETED', 'PRIVATE_ACCESS_CHANNEL_CREATED', 'PRIVATE_ACCESS_CHANNEL_UPDATED', 'PRIVATE_ACCESS_CHANNEL_DELETED', 'NONE'

resource_type

(required) The type of the resource the work request is affecting.

Allowed values are: 'ANALYTICS_INSTANCE'

identifier

(required) The OCID of the resource the work request is affecting.

resource_uri

(required) The URI of the affected resource.

metadata

(optional) Additional metadata of the resource.

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_analytics_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_analytics_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_T Type

An asynchronous work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_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_analytics_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_analytics_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_work_request_t (
    id varchar2,
    operation_type varchar2,
    status varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_analytics_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

id

(required) The resource OCID.

operation_type

(required) The operation performed by the work request.

Allowed values are: 'CREATE_ANALYTICS_INSTANCE', 'DELETE_ANALYTICS_INSTANCE', 'START_ANALYTICS_INSTANCE', 'STOP_ANALYTICS_INSTANCE', 'SCALE_ANALYTICS_INSTANCE', 'CHANGE_ANALYTICS_INSTANCE_COMPARTMENT', 'CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT', 'CREATE_VANITY_URL', 'UPDATE_VANITY_URL', 'DELETE_VANITY_URL', 'CREATE_PRIVATE_ACCESS_CHANNEL', 'UPDATE_PRIVATE_ACCESS_CHANNEL', 'DELETE_PRIVATE_ACCESS_CHANNEL', 'UPDATE_INSTANCE_ENCRYPTION_KEY'

status

(required) The current status of the work request.

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

compartment_id

(required) The compartment OCID of this work request.

resources

(required) The resources this work request affects.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The time the work request was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_started

(optional) The time the work request was started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_finished

(optional) The time the work request was finished, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_ERROR_T Type

Error encountered during the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_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_analytics_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_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) Error message.

l_timestamp

(required) The date and time the error occured, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_LOG_T Type

Log entries related to a specific work request.

Syntax

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

Fields

Field Description

message

(required) The description of the event that occurred.

l_timestamp

(required) The date and time the log entry occured, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

DBMS_CLOUD_OCI_ANALYTICS_WORK_REQUEST_SUMMARY_T Type

An asynchronous work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_analytics_work_request_summary_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_analytics_work_request_resource_tbl,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_analytics_work_request_summary_t (
    id varchar2,
    operation_type varchar2,
    status varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_analytics_work_request_resource_tbl,
    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

id

(required) The resource OCID.

operation_type

(required) The operation performed by the work request.

Allowed values are: 'CREATE_ANALYTICS_INSTANCE', 'DELETE_ANALYTICS_INSTANCE', 'START_ANALYTICS_INSTANCE', 'STOP_ANALYTICS_INSTANCE', 'SCALE_ANALYTICS_INSTANCE', 'CHANGE_ANALYTICS_INSTANCE_COMPARTMENT', 'CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT', 'CREATE_VANITY_URL', 'UPDATE_VANITY_URL', 'DELETE_VANITY_URL', 'CREATE_PRIVATE_ACCESS_CHANNEL', 'UPDATE_PRIVATE_ACCESS_CHANNEL', 'DELETE_PRIVATE_ACCESS_CHANNEL', 'UPDATE_INSTANCE_ENCRYPTION_KEY'

status

(required) The current status of the work request.

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

compartment_id

(required) The compartment OCID of this work request.

resources

(required) The resources this work request affects.

time_accepted

(required) The time the work request was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_started

(optional) The time the work request was started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

time_finished

(optional) The time the work request was finished, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`