StreamAdminClient

class oci.streaming.StreamAdminClient(config, **kwargs)

Use the Streaming API to produce and consume messages, create streams and stream pools, and manage related items. For more information, see [Streaming](/Content/Streaming/Concepts/streamingoverview.htm).

Methods

__init__(config, **kwargs) Creates a new service client
change_connect_harness_compartment(…) Moves a resource into a different compartment.
change_stream_compartment(stream_id, …) Moves a resource into a different compartment.
change_stream_pool_compartment(…) Moves a resource into a different compartment.
create_connect_harness(…) Starts the provisioning of a new connect harness.
create_stream(create_stream_details, **kwargs) Starts the provisioning of a new stream.
create_stream_pool(…) Starts the provisioning of a new stream pool.
delete_connect_harness(connect_harness_id, …) Deletes a connect harness and its content.
delete_stream(stream_id, **kwargs) Deletes a stream and its content.
delete_stream_pool(stream_pool_id, **kwargs) Deletes a stream pool.
get_connect_harness(connect_harness_id, **kwargs) Gets detailed information about a connect harness.
get_stream(stream_id, **kwargs) Gets detailed information about a stream, including the number of partitions.
get_stream_pool(stream_pool_id, **kwargs) Gets detailed information about the stream pool, such as Kafka settings.
list_connect_harnesses(compartment_id, **kwargs) Lists the connectharness.
list_stream_pools(compartment_id, **kwargs) List the stream pools for a given compartment ID.
list_streams(**kwargs) Lists the streams in the given compartment id.
update_connect_harness(connect_harness_id, …) Updates the tags applied to the connect harness.
update_stream(stream_id, …) Updates the stream.
update_stream_pool(stream_pool_id, …) Updates the specified stream pool.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
change_connect_harness_compartment(connect_harness_id, change_connect_harness_compartment_details, **kwargs)

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

Parameters:
  • connect_harness_id (str) – (required) The OCID of the connect harness.
  • change_connect_harness_compartment_details (oci.streaming.models.ChangeConnectHarnessCompartmentDetails) – (required) The connect harness will be moved into the compartment specified within this entity.
  • if_match (str) – (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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_connect_harness_compartment API.

change_stream_compartment(stream_id, change_stream_compartment_details, **kwargs)

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.

Parameters:
  • stream_id (str) – (required) The OCID of the stream.
  • change_stream_compartment_details (oci.streaming.models.ChangeStreamCompartmentDetails) – (required) The stream will be moved into the compartment specified within this entity.
  • if_match (str) – (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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_stream_compartment API.

change_stream_pool_compartment(stream_pool_id, change_stream_pool_compartment_details, **kwargs)

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

Parameters:
  • stream_pool_id (str) – (required) The OCID of the stream pool.
  • change_stream_pool_compartment_details (oci.streaming.models.ChangeStreamPoolCompartmentDetails) – (required) The stream pool will be moved into the compartment specified within this entity.
  • if_match (str) – (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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_stream_pool_compartment API.

create_connect_harness(create_connect_harness_details, **kwargs)

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

Parameters:
  • create_connect_harness_details (oci.streaming.models.CreateConnectHarnessDetails) – (required) The connect harness to create.
  • opc_request_id (str) – (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 (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ConnectHarness
Return type:

Response
Example:

Click here to see an example of how to use create_connect_harness API.

create_stream(create_stream_details, **kwargs)

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(). In the response, the lifecycleState parameter of the Stream object tells you its current state.

Parameters:
  • create_stream_details (oci.streaming.models.CreateStreamDetails) – (required) The stream to create.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Stream
Return type:

Response
Example:

Click here to see an example of how to use create_stream API.

create_stream_pool(create_stream_pool_details, **kwargs)

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.

Parameters:
  • create_stream_pool_details (oci.streaming.models.CreateStreamPoolDetails) – (required) The stream pool to create.
  • opc_request_id (str) – (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 (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type StreamPool
Return type:

Response
Example:

Click here to see an example of how to use create_stream_pool API.

delete_connect_harness(connect_harness_id, **kwargs)

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() 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.

Parameters:
  • connect_harness_id (str) – (required) The OCID of the connect harness.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_connect_harness API.

delete_stream(stream_id, **kwargs)

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() 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.

Parameters:
  • stream_id (str) – (required) The OCID of the stream.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_stream API.

delete_stream_pool(stream_pool_id, **kwargs)

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

Parameters:
  • stream_pool_id (str) – (required) The OCID of the stream pool.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_stream_pool API.

get_connect_harness(connect_harness_id, **kwargs)

Gets detailed information about a connect harness.

Parameters:
  • connect_harness_id (str) – (required) The OCID of the connect harness.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ConnectHarness
Return type:

Response
Example:

Click here to see an example of how to use get_connect_harness API.

get_stream(stream_id, **kwargs)

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

Parameters:
  • stream_id (str) – (required) The OCID of the stream.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Stream
Return type:

Response
Example:

Click here to see an example of how to use get_stream API.

get_stream_pool(stream_pool_id, **kwargs)

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

Parameters:
  • stream_pool_id (str) – (required) The OCID of the stream pool.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type StreamPool
Return type:

Response
Example:

Click here to see an example of how to use get_stream_pool API.

list_connect_harnesses(compartment_id, **kwargs)

Lists the connectharness.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • id (str) – (optional) A filter to return only resources that match the given ID exactly.
  • name (str) – (optional) A filter to return only resources that match the given name exactly.
  • limit (int) – (optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
  • page (str) – (optional) The page at which to start retrieving results.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of ConnectHarnessSummary
Return type:

Response
Example:

Click here to see an example of how to use list_connect_harnesses API.

list_stream_pools(compartment_id, **kwargs)

List the stream pools for a given compartment ID.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • id (str) – (optional) A filter to return only resources that match the given ID exactly.
  • name (str) – (optional) A filter to return only resources that match the given name exactly.
  • limit (int) – (optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
  • page (str) – (optional) The page at which to start retrieving results.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of StreamPoolSummary
Return type:

Response
Example:

Click here to see an example of how to use list_stream_pools API.

list_streams(**kwargs)

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.

Parameters:
  • compartment_id (str) – (optional) The OCID of the compartment. Is exclusive with the streamPoolId parameter. One of them is required.
  • stream_pool_id (str) – (optional) The OCID of the stream pool. Is exclusive with the compartmentId parameter. One of them is required.
  • id (str) – (optional) A filter to return only resources that match the given ID exactly.
  • name (str) – (optional) A filter to return only resources that match the given name exactly.
  • limit (int) – (optional) The maximum number of items to return. The value must be between 1 and 50. The default is 10.
  • page (str) – (optional) The page at which to start retrieving results.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of StreamSummary
Return type:

Response
Example:

Click here to see an example of how to use list_streams API.

update_connect_harness(connect_harness_id, update_connect_harness_details, **kwargs)

Updates the tags applied to the connect harness.

Parameters:
  • connect_harness_id (str) – (required) The OCID of the connect harness.
  • update_connect_harness_details (oci.streaming.models.UpdateConnectHarnessDetails) – (required) The connect harness is updated with the tags provided.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ConnectHarness
Return type:

Response
Example:

Click here to see an example of how to use update_connect_harness API.

update_stream(stream_id, update_stream_details, **kwargs)

Updates the stream. Only specified values will be updated.

Parameters:
  • stream_id (str) – (required) The OCID of the stream.
  • update_stream_details (oci.streaming.models.UpdateStreamDetails) – (required) The stream is updated with the values provided.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Stream
Return type:

Response
Example:

Click here to see an example of how to use update_stream API.

update_stream_pool(stream_pool_id, update_stream_pool_details, **kwargs)

Updates the specified stream pool.

Parameters:
  • stream_pool_id (str) – (required) The OCID of the stream pool.
  • update_stream_pool_details (oci.streaming.models.UpdateStreamPoolDetails) – (required) The pool is updated with the provided fields.
  • opc_request_id (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type StreamPool
Return type:

Response
Example:

Click here to see an example of how to use update_stream_pool API.