Class StreamAdminClient

Service client instance for StreamAdmin.

Inheritance

object

ClientBase

RegionalClientBase

StreamAdminClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StreamingService

Assembly: OCI.DotNetSDK.Streaming.dll

Syntax

public class StreamAdminClient : RegionalClientBase, IDisposable

Constructors

StreamAdminClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public StreamAdminClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public StreamAdminPaginators Paginators { get; }

Property Value

Type	Description
StreamAdminPaginators

Waiters

Declaration

public StreamAdminWaiters Waiters { get; }

Property Value

Type	Description
StreamAdminWaiters

Methods

ChangeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ChangeConnectHarnessCompartmentResponse> ChangeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeConnectHarnessCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeConnectHarnessCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeStreamCompartment(ChangeStreamCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeStreamCompartmentResponse> ChangeStreamCompartment(ChangeStreamCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeStreamCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeStreamCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ChangeStreamPoolCompartmentResponse> ChangeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeStreamPoolCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeStreamPoolCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateConnectHarness(CreateConnectHarnessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CreateConnectHarnessResponse> CreateConnectHarness(CreateConnectHarnessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConnectHarnessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConnectHarnessResponse>	A response object containing details about the completed operation

Examples

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

CreateStream(CreateStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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 {@link #getStream(GetStreamRequest) getStream}. In the response, the lifecycleState parameter of the {@link Stream} object tells you its current state.

Declaration

public Task<CreateStreamResponse> CreateStream(CreateStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateStreamRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateStreamResponse>	A response object containing details about the completed operation

Examples

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

CreateStreamPool(CreateStreamPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<CreateStreamPoolResponse> CreateStreamPool(CreateStreamPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateStreamPoolRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateStreamPoolResponse>	A response object containing details about the completed operation

Examples

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

DeleteConnectHarness(DeleteConnectHarnessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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 {@link #getConnectHarness(GetConnectHarnessRequest) getConnectHarness} 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.

Declaration

public Task<DeleteConnectHarnessResponse> DeleteConnectHarness(DeleteConnectHarnessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConnectHarnessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConnectHarnessResponse>	A response object containing details about the completed operation

Examples

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

DeleteStream(DeleteStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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 {@link #getStream(GetStreamRequest) getStream} 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.

Declaration

public Task<DeleteStreamResponse> DeleteStream(DeleteStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteStreamRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteStreamResponse>	A response object containing details about the completed operation

Examples

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

DeleteStreamPool(DeleteStreamPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeleteStreamPoolResponse> DeleteStreamPool(DeleteStreamPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteStreamPoolRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteStreamPoolResponse>	A response object containing details about the completed operation

Examples

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

GetConnectHarness(GetConnectHarnessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets detailed information about a connect harness.

Declaration

public Task<GetConnectHarnessResponse> GetConnectHarness(GetConnectHarnessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectHarnessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConnectHarnessResponse>	A response object containing details about the completed operation

Examples

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

GetStream(GetStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetStreamResponse> GetStream(GetStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetStreamRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetStreamResponse>	A response object containing details about the completed operation

Examples

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

GetStreamPool(GetStreamPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetStreamPoolResponse> GetStreamPool(GetStreamPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetStreamPoolRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetStreamPoolResponse>	A response object containing details about the completed operation

Examples

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

ListConnectHarnesses(ListConnectHarnessesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the connectharness.

Declaration

public Task<ListConnectHarnessesResponse> ListConnectHarnesses(ListConnectHarnessesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConnectHarnessesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConnectHarnessesResponse>	A response object containing details about the completed operation

Examples

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

ListStreamPools(ListStreamPoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the stream pools for a given compartment ID.

Declaration

public Task<ListStreamPoolsResponse> ListStreamPools(ListStreamPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListStreamPoolsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListStreamPoolsResponse>	A response object containing details about the completed operation

Examples

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

ListStreams(ListStreamsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListStreamsResponse> ListStreams(ListStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListStreamsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListStreamsResponse>	A response object containing details about the completed operation

Examples

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

UpdateConnectHarness(UpdateConnectHarnessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the tags applied to the connect harness.

Declaration

public Task<UpdateConnectHarnessResponse> UpdateConnectHarness(UpdateConnectHarnessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConnectHarnessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateConnectHarnessResponse>	A response object containing details about the completed operation

Examples

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

UpdateStream(UpdateStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the stream. Only specified values will be updated.

Declaration

public Task<UpdateStreamResponse> UpdateStream(UpdateStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateStreamRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateStreamResponse>	A response object containing details about the completed operation

Examples

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

UpdateStreamPool(UpdateStreamPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified stream pool.

Declaration

public Task<UpdateStreamPoolResponse> UpdateStreamPool(UpdateStreamPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateStreamPoolRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateStreamPoolResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable