@Generated(value="OracleSDKGenerator", comments="API Version: 20180418") public class StreamAdminAsyncClient extends Object implements StreamAdminAsync
Async client implementation for StreamAdmin service.
There are two ways to use async client:
InputStream, like
getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else,
because the stream will be closed right after the AsyncHandler is invoked. | Modifier and Type | Class and Description |
|---|---|
static class |
StreamAdminAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for StreamAdmin.
|
| Constructor and Description |
|---|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for StreamAdmin.
public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static StreamAdminAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
StreamAdminAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface StreamAdminAsyncendpoint - The endpoint of the serice.public String getEndpoint()
StreamAdminAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface StreamAdminAsyncpublic void setRegion(Region region)
StreamAdminAsyncSets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
setRegion in interface StreamAdminAsyncregion - The region of the service.public void setRegion(String regionId)
StreamAdminAsyncSets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint.
setRegion in interface StreamAdminAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<ChangeConnectHarnessCompartmentResponse> changeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request, AsyncHandler<ChangeConnectHarnessCompartmentRequest,ChangeConnectHarnessCompartmentResponse> handler)
StreamAdminAsyncMoves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeConnectHarnessCompartment in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeStreamCompartmentResponse> changeStreamCompartment(ChangeStreamCompartmentRequest request, AsyncHandler<ChangeStreamCompartmentRequest,ChangeStreamCompartmentResponse> handler)
StreamAdminAsyncMoves 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.
changeStreamCompartment in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeStreamPoolCompartmentResponse> changeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request, AsyncHandler<ChangeStreamPoolCompartmentRequest,ChangeStreamPoolCompartmentResponse> handler)
StreamAdminAsyncMoves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeStreamPoolCompartment in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateConnectHarnessResponse> createConnectHarness(CreateConnectHarnessRequest request, AsyncHandler<CreateConnectHarnessRequest,CreateConnectHarnessResponse> handler)
StreamAdminAsyncStarts 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.
createConnectHarness in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateStreamResponse> createStream(CreateStreamRequest request, AsyncHandler<CreateStreamRequest,CreateStreamResponse> handler)
StreamAdminAsyncStarts 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 getStream.
In the response, the lifecycleState parameter of the Stream object tells you its current state.
createStream in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateStreamPoolResponse> createStreamPool(CreateStreamPoolRequest request, AsyncHandler<CreateStreamPoolRequest,CreateStreamPoolResponse> handler)
StreamAdminAsyncStarts 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.
createStreamPool in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteConnectHarnessResponse> deleteConnectHarness(DeleteConnectHarnessRequest request, AsyncHandler<DeleteConnectHarnessRequest,DeleteConnectHarnessResponse> handler)
StreamAdminAsyncDeletes 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 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.
deleteConnectHarness in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteStreamResponse> deleteStream(DeleteStreamRequest request, AsyncHandler<DeleteStreamRequest,DeleteStreamResponse> handler)
StreamAdminAsyncDeletes 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 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.
deleteStream in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteStreamPoolResponse> deleteStreamPool(DeleteStreamPoolRequest request, AsyncHandler<DeleteStreamPoolRequest,DeleteStreamPoolResponse> handler)
StreamAdminAsyncDeletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.
deleteStreamPool in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetConnectHarnessResponse> getConnectHarness(GetConnectHarnessRequest request, AsyncHandler<GetConnectHarnessRequest,GetConnectHarnessResponse> handler)
StreamAdminAsyncGets detailed information about a connect harness.
getConnectHarness in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetStreamResponse> getStream(GetStreamRequest request, AsyncHandler<GetStreamRequest,GetStreamResponse> handler)
StreamAdminAsyncGets detailed information about a stream, including the number of partitions.
getStream in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetStreamPoolResponse> getStreamPool(GetStreamPoolRequest request, AsyncHandler<GetStreamPoolRequest,GetStreamPoolResponse> handler)
StreamAdminAsyncGets detailed information about the stream pool, such as Kafka settings.
getStreamPool in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListConnectHarnessesResponse> listConnectHarnesses(ListConnectHarnessesRequest request, AsyncHandler<ListConnectHarnessesRequest,ListConnectHarnessesResponse> handler)
StreamAdminAsyncLists the connectharness.
listConnectHarnesses in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListStreamPoolsResponse> listStreamPools(ListStreamPoolsRequest request, AsyncHandler<ListStreamPoolsRequest,ListStreamPoolsResponse> handler)
StreamAdminAsyncList the stream pools for a given compartment ID.
listStreamPools in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListStreamsResponse> listStreams(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResponse> handler)
StreamAdminAsyncLists 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.
listStreams in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateConnectHarnessResponse> updateConnectHarness(UpdateConnectHarnessRequest request, AsyncHandler<UpdateConnectHarnessRequest,UpdateConnectHarnessResponse> handler)
StreamAdminAsyncUpdates the tags applied to the connect harness.
updateConnectHarness in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateStreamResponse> updateStream(UpdateStreamRequest request, AsyncHandler<UpdateStreamRequest,UpdateStreamResponse> handler)
StreamAdminAsyncUpdates the stream. Only specified values will be updated.
updateStream in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateStreamPoolResponse> updateStreamPool(UpdateStreamPoolRequest request, AsyncHandler<UpdateStreamPoolRequest,UpdateStreamPoolResponse> handler)
StreamAdminAsyncUpdates the specified stream pool.
updateStreamPool in interface StreamAdminAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.