Streaming Common Types

DBMS_CLOUD_OCI_STREAMING_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_STREAMING_CHANGE_CONNECT_HARNESS_COMPARTMENT_DETAILS_T Type

Detailed representation of a change connect harness compartment operation.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_STREAMING_CHANGE_STREAM_COMPARTMENT_DETAILS_T Type

Detailed representation of a change stream compartment operation.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_STREAMING_CHANGE_STREAM_POOL_COMPARTMENT_DETAILS_T Type

Detailed representation of a change stream pool compartment operation.

Syntax

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

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_STREAMING_CONNECT_HARNESS_T Type

Detailed representation of a connect harness.

Syntax

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

Fields

Field Description

name

(required) The name of the connect harness. Avoid entering confidential information. Example: `JDBCConnector`

id

(required) The OCID of the connect harness.

compartment_id

(required) The OCID of the compartment that contains the connect harness.

lifecycle_state

(required) The current state of the connect harness.

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

lifecycle_state_details

(optional) Any additional details about the current state of the connect harness.

time_created

(required) The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

freeform_tags

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

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\"}}'

DBMS_CLOUD_OCI_STREAMING_CONNECT_HARNESS_SUMMARY_T Type

Summary representation of a ConnectHarness.

Syntax

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

Fields

Field Description

name

(required) The name of the connect harness. Example: `TelemetryEvents`

id

(required) The OCID of the connect harness.

compartment_id

(required) The OCID of the compartment that contains the connect harness.

lifecycle_state

(required) The current state of the connect harness.

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

time_created

(required) The date and time the connect harness was created, expressed in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_CREATE_CONNECT_HARNESS_DETAILS_T Type

Object used to create a connect harness.

Syntax

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

Fields

Field Description

name

(required) The name of the connect harness. Avoid entering confidential information. Example: `JDBCConnector`

compartment_id

(required) The OCID of the compartment that contains the connect harness.

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_CREATE_CURSOR_DETAILS_T Type

Object used to create a cursor to consume messages in a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_create_cursor_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  partition varchar2(32767),
  l_type varchar2(32767),
  offset number,
  time timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_cursor_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_cursor_details_t (
    partition varchar2,
    l_type varchar2,
    offset number,
    time timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

partition

(required) The partition to get messages from.

l_type

(required) The type of cursor, which determines the starting point from which the stream will be consumed: - `AFTER_OFFSET:` The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.) - `AT_OFFSET:` The exact partition position indicated by the offset you specify. - `AT_TIME:` A specific point in time. - `LATEST:` The most recent message in the partition that was added after the cursor was created. - `TRIM_HORIZON:` The oldest message in the partition that is within the retention period window.

Allowed values are: 'AFTER_OFFSET', 'AT_OFFSET', 'AT_TIME', 'LATEST', 'TRIM_HORIZON'

offset

(optional) The offset to consume from if the cursor type is `AT_OFFSET` or `AFTER_OFFSET`.

time

(optional) The time to consume from if the cursor type is `AT_TIME`, expressed in RFC 3339 timestamp format.

DBMS_CLOUD_OCI_STREAMING_CREATE_GROUP_CURSOR_DETAILS_T Type

Object used to create a group cursor.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_create_group_cursor_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  time timestamp with time zone,
  group_name varchar2(32767),
  instance_name varchar2(32767),
  timeout_in_ms number,
  commit_on_get number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_group_cursor_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_group_cursor_details_t (
    l_type varchar2,
    time timestamp with time zone,
    group_name varchar2,
    instance_name varchar2,
    timeout_in_ms number,
    commit_on_get number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_type

(required) The type of the cursor. This value is only used when the group is created.

Allowed values are: 'AT_TIME', 'LATEST', 'TRIM_HORIZON'

time

(optional) The time to consume from if type is AT_TIME.

group_name

(required) Name of the consumer group.

instance_name

(optional) A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used.

timeout_in_ms

(optional) The amount of a consumer instance inactivity time, before partition reservations are released.

commit_on_get

(optional) When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false. If disabled, a consumer must manually commit their cursors.

DBMS_CLOUD_OCI_STREAMING_CREATE_STREAM_DETAILS_T Type

Object used to create a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_create_stream_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  partitions number,
  compartment_id varchar2(32767),
  stream_pool_id varchar2(32767),
  retention_in_hours number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_stream_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_stream_details_t (
    name varchar2,
    partitions number,
    compartment_id varchar2,
    stream_pool_id varchar2,
    retention_in_hours number,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the stream. Avoid entering confidential information. Example: `TelemetryEvents`

partitions

(required) The number of partitions in the stream.

compartment_id

(optional) The OCID of the compartment that contains the stream.

stream_pool_id

(optional) The OCID of the stream pool that contains the stream.

retention_in_hours

(optional) The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_KAFKA_SETTINGS_T Type

Settings for the Kafka compatibility layer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_kafka_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  bootstrap_servers varchar2(32767),
  auto_create_topics_enable number,
  log_retention_hours number,
  num_partitions number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_kafka_settings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_kafka_settings_t (
    bootstrap_servers varchar2,
    auto_create_topics_enable number,
    log_retention_hours number,
    num_partitions number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

bootstrap_servers

(optional) Bootstrap servers.

auto_create_topics_enable

(optional) Enable auto creation of topic on the server.

log_retention_hours

(optional) The number of hours to keep a log file before deleting it (in hours).

num_partitions

(optional) The default number of log partitions per topic.

DBMS_CLOUD_OCI_STREAMING_CUSTOM_ENCRYPTION_KEY_DETAILS_T Type

The OCID of the custom encryption key to be used or deleted if currently being used.

Syntax

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

Fields

Field Description

kms_key_id

(required) Custom Encryption Key (Master Key) ocid.

DBMS_CLOUD_OCI_STREAMING_PRIVATE_ENDPOINT_DETAILS_T Type

Optional parameters if a private stream pool is requested.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_private_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  private_endpoint_ip varchar2(32767),
  nsg_ids dbms_cloud_oci_streaming_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_private_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_private_endpoint_details_t (
    subnet_id varchar2,
    private_endpoint_ip varchar2,
    nsg_ids dbms_cloud_oci_streaming_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subnet_id

(optional) If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

private_endpoint_ip

(optional) The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.

nsg_ids

(optional) The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.

DBMS_CLOUD_OCI_STREAMING_CREATE_STREAM_POOL_DETAILS_T Type

Object used to create a stream pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_create_stream_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  name varchar2(32767),
  kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
  custom_encryption_key_details dbms_cloud_oci_streaming_custom_encryption_key_details_t,
  private_endpoint_details dbms_cloud_oci_streaming_private_endpoint_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_stream_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_create_stream_pool_details_t (
    compartment_id varchar2,
    name varchar2,
    kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
    custom_encryption_key_details dbms_cloud_oci_streaming_custom_encryption_key_details_t,
    private_endpoint_details dbms_cloud_oci_streaming_private_endpoint_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment that contains the stream.

name

(required) The name of the stream pool. Avoid entering confidential information. Example: `MyStreamPool`

kafka_settings

(optional)

custom_encryption_key_details

(optional)

private_endpoint_details

(optional)

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_CURSOR_T Type

A cursor that indicates the position in the stream from which you want to begin consuming messages and which is required by the GET_MESSAGES Function operation.

Syntax

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

Fields

Field Description

value

(required) The cursor to pass to the `GetMessages` operation.

DBMS_CLOUD_OCI_STREAMING_CUSTOM_ENCRYPTION_KEY_T Type

Custom Encryption Key which will be used for encryption by all the streams in the pool.

Syntax

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

Fields

Field Description

kms_key_id

(optional) Custom Encryption Key (Master Key) ocid.

key_state

(optional) Life cycle State of the custom key

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

DBMS_CLOUD_OCI_STREAMING_ERROR_T Type

The representation of an error.

Syntax

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

Represents the state of a single partition reservation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_partition_reservation_t FORCE AUTHID CURRENT_USER IS OBJECT (
  partition varchar2(32767),
  committed_offset number,
  reserved_instance varchar2(32767),
  time_reserved_until timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_partition_reservation_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_partition_reservation_t (
    partition varchar2,
    committed_offset number,
    reserved_instance varchar2,
    time_reserved_until timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

partition

(optional) The partition for which the reservation applies.

committed_offset

(optional) The latest offset which has been committed for this partition.

reserved_instance

(optional) The consumer instance which currently has the partition reserved.

time_reserved_until

(optional) A timestamp when the current reservation expires.

DBMS_CLOUD_OCI_STREAMING_PARTITION_RESERVATION_TBL Type

Nested table type of dbms_cloud_oci_streaming_partition_reservation_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_partition_reservation_tbl FORCE IS TABLE OF (dbms_cloud_oci_streaming_partition_reservation_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STREAMING_GROUP_T Type

Represents the current state of a consumer group, including partition reservations and committed offsets.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_group_t FORCE AUTHID CURRENT_USER IS OBJECT (
  stream_id varchar2(32767),
  group_name varchar2(32767),
  reservations dbms_cloud_oci_streaming_partition_reservation_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_group_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_group_t (
    stream_id varchar2,
    group_name varchar2,
    reservations dbms_cloud_oci_streaming_partition_reservation_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

stream_id

(required) The streamId for which the group exists.

group_name

(required) The name of the consumer group.

reservations

(optional) An array of the partition reservations of a group.

DBMS_CLOUD_OCI_STREAMING_MESSAGE_T Type

A message in a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_message_t FORCE AUTHID CURRENT_USER IS OBJECT (
  stream varchar2(32767),
  partition varchar2(32767),
  key clob,
  value clob,
  offset number,
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_message_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_message_t (
    stream varchar2,
    partition varchar2,
    key clob,
    value clob,
    offset number,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

stream

(required) The name of the stream that the message belongs to.

partition

(required) The ID of the partition where the message is stored.

key

(required) The key associated with the message, expressed as a byte array.

value

(required) The value associated with the message, expressed as a byte array.

offset

(required) The offset of the message, which uniquely identifies it within the partition.

l_timestamp

(required) The timestamp indicating when the server appended the message to the stream.

DBMS_CLOUD_OCI_STREAMING_PRIVATE_ENDPOINT_SETTINGS_T Type

Optional settings if the stream pool is private.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_private_endpoint_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  private_endpoint_ip varchar2(32767),
  nsg_ids dbms_cloud_oci_streaming_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_private_endpoint_settings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_private_endpoint_settings_t (
    subnet_id varchar2,
    private_endpoint_ip varchar2,
    nsg_ids dbms_cloud_oci_streaming_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subnet_id

(optional) The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.

private_endpoint_ip

(optional) The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.

nsg_ids

(optional) The optional list of network security groups that are associated with the private endpoint of the stream pool.

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_DETAILS_ENTRY_T Type

Object that represents a message to emit to a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_details_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key clob,
  value clob,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_details_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_details_entry_t (
    key clob,
    value clob
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) The key of the message, expressed as a byte array up to 256 bytes in size. Messages with the same key are stored in the same partition.

value

(required) The message, expressed as a byte array up to 1 MiB in size.

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_DETAILS_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_streaming_put_messages_details_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_details_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_streaming_put_messages_details_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_DETAILS_T Type

Object that represents an array of messages to emit to a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  messages dbms_cloud_oci_streaming_put_messages_details_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_details_t (
    messages dbms_cloud_oci_streaming_put_messages_details_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

messages

(required) The array of messages to put into a stream.

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_RESULT_ENTRY_T Type

Represents the result of a PUT_MESSAGES Function request, whether it was successful or not. If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. If the message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_result_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  partition varchar2(32767),
  offset number,
  l_timestamp timestamp with time zone,
  error varchar2(32767),
  error_message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_result_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_result_entry_t (
    partition varchar2,
    offset number,
    l_timestamp timestamp with time zone,
    error varchar2,
    error_message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

partition

(optional) The ID of the partition where the message was stored.

offset

(optional) The offset of the message in the partition.

l_timestamp

(optional) The timestamp indicating when the server appended the message to the stream.

error

(optional) The error code, in case the message was not successfully appended to the stream.

error_message

(optional) A human-readable error message associated with the error code.

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_RESULT_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_streaming_put_messages_result_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_result_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_streaming_put_messages_result_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_STREAMING_PUT_MESSAGES_RESULT_T Type

The response to a PUT_MESSAGES Function request. It indicates the number of failed messages as well as an array of results for successful and failed messages.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_put_messages_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  failures number,
  entries dbms_cloud_oci_streaming_put_messages_result_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_put_messages_result_t (
    failures number,
    entries dbms_cloud_oci_streaming_put_messages_result_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

failures

(required) The number of messages that failed to be added to the stream.

entries

(required) An array of items representing the result of each message. The order is guaranteed to be the same as in the `PutMessagesDetails` object. If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. If a message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.

DBMS_CLOUD_OCI_STREAMING_STREAM_T Type

Detailed representation of a stream, including all its partitions.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_stream_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  partitions number,
  retention_in_hours number,
  compartment_id varchar2(32767),
  stream_pool_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_state_details varchar2(32767),
  time_created timestamp with time zone,
  messages_endpoint varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_t (
    name varchar2,
    id varchar2,
    partitions number,
    retention_in_hours number,
    compartment_id varchar2,
    stream_pool_id varchar2,
    lifecycle_state varchar2,
    lifecycle_state_details varchar2,
    time_created timestamp with time zone,
    messages_endpoint varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the stream. Avoid entering confidential information. Example: `TelemetryEvents`

id

(required) The OCID of the stream.

partitions

(required) The number of partitions in the stream.

retention_in_hours

(required) The retention period of the stream, in hours. This property is read-only.

compartment_id

(required) The OCID of the stream.

stream_pool_id

(required) The OCID of the stream pool that contains the stream.

lifecycle_state

(required) The current state of the stream.

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

lifecycle_state_details

(optional) Any additional details about the current state of the stream.

time_created

(required) The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

messages_endpoint

(required) The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.

freeform_tags

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

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\"}}'

DBMS_CLOUD_OCI_STREAMING_STREAM_POOL_T Type

The details of a stream pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_stream_pool_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_state_details varchar2(32767),
  time_created timestamp with time zone,
  kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
  custom_encryption_key dbms_cloud_oci_streaming_custom_encryption_key_t,
  is_private number,
  endpoint_fqdn varchar2(32767),
  private_endpoint_settings dbms_cloud_oci_streaming_private_endpoint_settings_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_pool_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_pool_t (
    id varchar2,
    compartment_id varchar2,
    name varchar2,
    lifecycle_state varchar2,
    lifecycle_state_details varchar2,
    time_created timestamp with time zone,
    kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
    custom_encryption_key dbms_cloud_oci_streaming_custom_encryption_key_t,
    is_private number,
    endpoint_fqdn varchar2,
    private_endpoint_settings dbms_cloud_oci_streaming_private_endpoint_settings_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the stream pool.

compartment_id

(required) Compartment OCID that the pool belongs to.

name

(required) The name of the stream pool.

lifecycle_state

(required) The current state of the stream pool.

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

lifecycle_state_details

(optional) Any additional details about the current state of the stream.

time_created

(required) The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

kafka_settings

(required)

custom_encryption_key

(required)

is_private

(optional) True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

endpoint_fqdn

(optional) The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a STREAM Type object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.

private_endpoint_settings

(optional)

freeform_tags

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

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\"}}'

DBMS_CLOUD_OCI_STREAMING_STREAM_POOL_SUMMARY_T Type

The summary representation of a stream pool.

Syntax

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

Fields

Field Description

id

(required) The OCID of the stream pool.

compartment_id

(required) Compartment OCID that the pool belongs to.

name

(required) The name of the stream pool.

lifecycle_state

(required) The current state of the stream pool.

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

time_created

(required) The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

is_private

(optional) True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GET_STREAM_POOL Function API.

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_STREAM_SUMMARY_T Type

Summary representation of a stream.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_stream_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  id varchar2(32767),
  partitions number,
  compartment_id varchar2(32767),
  stream_pool_id varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  messages_endpoint varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_stream_summary_t (
    name varchar2,
    id varchar2,
    partitions number,
    compartment_id varchar2,
    stream_pool_id varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    messages_endpoint varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the stream. Example: `TelemetryEvents`

id

(required) The OCID of the stream.

partitions

(required) The number of partitions in the stream.

compartment_id

(required) The OCID of the compartment that contains the stream.

stream_pool_id

(required) The OCID of the stream pool that contains the stream.

lifecycle_state

(required) The current state of the stream.

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

time_created

(required) The date and time the stream was created, expressed in RFC 3339 timestamp format. Example: `2018-04-20T00:00:07.405Z`

messages_endpoint

(required) The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_UPDATE_CONNECT_HARNESS_DETAILS_T Type

Object used to update a connect harness.

Syntax

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

Fields

Field Description

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_UPDATE_GROUP_DETAILS_T Type

Request body for operationally managing a group.

Syntax

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

Fields

Field Description

l_type

(optional) The type of the cursor.

Allowed values are: 'AT_TIME', 'LATEST', 'TRIM_HORIZON'

time

(optional) The time to consume from if type is AT_TIME.

DBMS_CLOUD_OCI_STREAMING_UPDATE_STREAM_DETAILS_T Type

Object used to update a stream.

Syntax

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

Fields

Field Description

stream_pool_id

(optional) The OCID of the stream pool where the stream should be moved.

freeform_tags

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

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\"}}`

DBMS_CLOUD_OCI_STREAMING_UPDATE_STREAM_POOL_DETAILS_T Type

Object used to update the stream pool's details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_streaming_update_stream_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
  custom_encryption_key_details dbms_cloud_oci_streaming_custom_encryption_key_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_update_stream_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_streaming_update_stream_pool_details_t (
    name varchar2,
    kafka_settings dbms_cloud_oci_streaming_kafka_settings_t,
    custom_encryption_key_details dbms_cloud_oci_streaming_custom_encryption_key_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional)

kafka_settings

(optional)

custom_encryption_key_details

(optional)

freeform_tags

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

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\"}}`