Streaming Admin Functions

Package: DBMS_CLOUD_OCI_ST_STREAM_ADMIN

CHANGE_CONNECT_HARNESS_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_connect_harness_compartment (
  connect_harness_id varchar2,
  change_connect_harness_compartment_details dbms_cloud_oci_streaming_change_connect_harness_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_change_connect_harness_compartment_response_t;

Parameters

Parameter	Description
`connect_harness_id`	(required) The OCID of the connect harness.
`change_connect_harness_compartment_details`	(required) The connect harness will be moved into the compartment specified within this entity.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_STREAM_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. The stream will also be moved into the default stream pool in the destination compartment.

Syntax

FUNCTION change_stream_compartment (
  stream_id varchar2,
  change_stream_compartment_details dbms_cloud_oci_streaming_change_stream_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_change_stream_compartment_response_t;

Parameters

Parameter	Description
`stream_id`	(required) The OCID of the stream.
`change_stream_compartment_details`	(required) The stream will be moved into the compartment specified within this entity.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_STREAM_POOL_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_stream_pool_compartment (
  stream_pool_id varchar2,
  change_stream_pool_compartment_details dbms_cloud_oci_streaming_change_stream_pool_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_change_stream_pool_compartment_response_t;

Parameters

Parameter	Description
`stream_pool_id`	(required) The OCID of the stream pool.
`change_stream_pool_compartment_details`	(required) The stream pool will be moved into the compartment specified within this entity.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CONNECT_HARNESS Function

Starts the provisioning of a new connect harness. To track the progress of the provisioning, you can periodically call CONNECT_HARNESS Type object tells you its current state.

Syntax

FUNCTION create_connect_harness (
  create_connect_harness_details dbms_cloud_oci_streaming_create_connect_harness_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_create_connect_harness_response_t;

Parameters

Parameter	Description
`create_connect_harness_details`	(required) The connect harness to create.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STREAM Function

Starts the provisioning of a new stream. The stream will be created in the given compartment id or stream pool id, depending on which parameter is specified. Compartment id and stream pool id cannot be specified at the same time. To track the progress of the provisioning, you can periodically call GET_STREAM Function. In the response, the `lifecycleState` parameter of the STREAM Type object tells you its current state.

Syntax

FUNCTION create_stream (
  create_stream_details dbms_cloud_oci_streaming_create_stream_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_create_stream_response_t;

Parameters

Parameter	Description
`create_stream_details`	(required) The stream to create.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STREAM_POOL Function

Starts the provisioning of a new stream pool. To track the progress of the provisioning, you can periodically call GetStreamPool. In the response, the `lifecycleState` parameter of the object tells you its current state.

Syntax

FUNCTION create_stream_pool (
  create_stream_pool_details dbms_cloud_oci_streaming_create_stream_pool_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_create_stream_pool_response_t;

Parameters

Parameter	Description
`create_stream_pool_details`	(required) The stream pool to create.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CONNECT_HARNESS Function

Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion. The `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations. To verify that a connect harness has been deleted, make a GET_CONNECT_HARNESS Function request. If the call returns the connect harness's lifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the connect harness have been deleted.

Syntax

FUNCTION delete_connect_harness (
  connect_harness_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_delete_connect_harness_response_t;

Parameters

Parameter	Description
`connect_harness_id`	(required) The OCID of the connect harness.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STREAM Function

Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion. The `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations. To verify that a stream has been deleted, make a GET_STREAM Function request. If the call returns the stream's lifecycle state as `DELETED`, then the stream has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the stream have been deleted.

Syntax

FUNCTION delete_stream (
  stream_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_delete_stream_response_t;

Parameters

Parameter	Description
`stream_id`	(required) The OCID of the stream.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STREAM_POOL Function

Deletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.

Syntax

FUNCTION delete_stream_pool (
  stream_pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_delete_stream_pool_response_t;

Parameters

Parameter	Description
`stream_pool_id`	(required) The OCID of the stream pool.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CONNECT_HARNESS Function

Gets detailed information about a connect harness.

Syntax

FUNCTION get_connect_harness (
  connect_harness_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_get_connect_harness_response_t;

Parameters

Parameter	Description
`connect_harness_id`	(required) The OCID of the connect harness.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STREAM Function

Gets detailed information about a stream, including the number of partitions.

Syntax

FUNCTION get_stream (
  stream_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_get_stream_response_t;

Parameters

Parameter	Description
`stream_id`	(required) The OCID of the stream.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STREAM_POOL Function

Gets detailed information about the stream pool, such as Kafka settings.

Syntax

FUNCTION get_stream_pool (
  stream_pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_get_stream_pool_response_t;

Parameters

Parameter	Description
`stream_pool_id`	(required) The OCID of the stream pool.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONNECT_HARNESSES Function

Lists the connectharness.

Syntax

FUNCTION list_connect_harnesses (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_list_connect_harnesses_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`id`	(optional) A filter to return only resources that match the given ID exactly.
`name`	(optional) A filter to return only resources that match the given name exactly.
`limit`	(optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
`page`	(optional) The page at which to start retrieving results.
`sort_by`	(optional) The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order. Allowed values are: 'NAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STREAM_POOLS Function

List the stream pools for a given compartment ID.

Syntax

FUNCTION list_stream_pools (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_list_stream_pools_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`id`	(optional) A filter to return only resources that match the given ID exactly.
`name`	(optional) A filter to return only resources that match the given name exactly.
`limit`	(optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
`page`	(optional) The page at which to start retrieving results.
`sort_by`	(optional) The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order. Allowed values are: 'NAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STREAMS Function

Lists the streams in the given compartment id. If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool. If the stream pool id is specified, the action will be scoped to that stream pool. The compartment id and stream pool id cannot be specified at the same time.

Syntax

FUNCTION list_streams (
  compartment_id varchar2 DEFAULT NULL,
  stream_pool_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_list_streams_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.
`stream_pool_id`	(optional) The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required.
`id`	(optional) A filter to return only resources that match the given ID exactly.
`name`	(optional) A filter to return only resources that match the given name exactly.
`limit`	(optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
`page`	(optional) The page at which to start retrieving results.
`sort_by`	(optional) The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order. Allowed values are: 'NAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CONNECT_HARNESS Function

Updates the tags applied to the connect harness.

Syntax

FUNCTION update_connect_harness (
  connect_harness_id varchar2,
  update_connect_harness_details dbms_cloud_oci_streaming_update_connect_harness_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_update_connect_harness_response_t;

Parameters

Parameter	Description
`connect_harness_id`	(required) The OCID of the connect harness.
`update_connect_harness_details`	(required) The connect harness is updated with the tags provided.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_STREAM Function

Updates the stream. Only specified values will be updated.

Syntax

FUNCTION update_stream (
  stream_id varchar2,
  update_stream_details dbms_cloud_oci_streaming_update_stream_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_update_stream_response_t;

Parameters

Parameter	Description
`stream_id`	(required) The OCID of the stream.
`update_stream_details`	(required) The stream is updated with the values provided.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_STREAM_POOL Function

Updates the specified stream pool.

Syntax

FUNCTION update_stream_pool (
  stream_pool_id varchar2,
  update_stream_pool_details dbms_cloud_oci_streaming_update_stream_pool_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_st_stream_admin_update_stream_pool_response_t;

Parameters

Parameter	Description
`stream_pool_id`	(required) The OCID of the stream pool.
`update_stream_pool_details`	(required) The pool is updated with the provided fields.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://streaming.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_CONNECT_HARNESS_COMPARTMENT Function 🔗

CHANGE_STREAM_COMPARTMENT Function 🔗

CHANGE_STREAM_POOL_COMPARTMENT Function 🔗

CREATE_CONNECT_HARNESS Function 🔗

CREATE_STREAM Function 🔗

CREATE_STREAM_POOL Function 🔗

DELETE_CONNECT_HARNESS Function 🔗

DELETE_STREAM Function 🔗

DELETE_STREAM_POOL Function 🔗

GET_CONNECT_HARNESS Function 🔗

GET_STREAM Function 🔗

GET_STREAM_POOL Function 🔗

LIST_CONNECT_HARNESSES Function 🔗

LIST_STREAM_POOLS Function 🔗

LIST_STREAMS Function 🔗

UPDATE_CONNECT_HARNESS Function 🔗

UPDATE_STREAM Function 🔗

UPDATE_STREAM_POOL Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_CONNECT_HARNESS_COMPARTMENT Function

CHANGE_STREAM_COMPARTMENT Function

CHANGE_STREAM_POOL_COMPARTMENT Function

CREATE_CONNECT_HARNESS Function

CREATE_STREAM Function

CREATE_STREAM_POOL Function

DELETE_CONNECT_HARNESS Function

DELETE_STREAM Function

DELETE_STREAM_POOL Function

GET_CONNECT_HARNESS Function

GET_STREAM Function

GET_STREAM_POOL Function

LIST_CONNECT_HARNESSES Function

LIST_STREAM_POOLS Function

LIST_STREAMS Function

UPDATE_CONNECT_HARNESS Function

UPDATE_STREAM Function

UPDATE_STREAM_POOL Function