@Generated(value="OracleSDKGenerator",
comments="API Version: 20180418")
public class StreamAdminAsyncClient
extends BaseAsyncClient
implements StreamAdminAsync
Async client implementation for StreamAdmin service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an 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.
2. Use Java Future: using Java Future, developers need to close the stream after they are done
with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or
the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
whether or not the request was completed via Future.isDone/isCancelled.
Please refer to
https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
| Modifier and Type | Class and Description |
|---|---|
static class |
StreamAdminAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for StreamAdmin.
|
| Constructor and Description |
|---|
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplateclosepublic static final Service SERVICE
Service instance for StreamAdmin.
public final String clientCommonLibraryVersion
@Deprecated public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))@Deprecated public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configuration@Deprecated public StreamAdminAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)@Deprecated public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory@Deprecated public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators@Deprecated public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators - ClientBuilderBase.additionalClientConfiguratorsendpoint - ClientBuilderBase.endpoint(java.lang.String)@Deprecated public StreamAdminAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see StreamAdminAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators - ClientBuilderBase.additionalClientConfiguratorsendpoint - ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactoriespublic static StreamAdminAsyncClient.Builder builder()
Create a builder for this client.
public 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 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.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint - The endpoint template in userequiredParametersMap - Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint - The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient. This will call ClientConfigurators again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close in interface AutoCloseablepublic String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
Copyright © 2016–2024. All rights reserved.