@Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public class OcbAgentSvcAsyncClient extends BaseAsyncClient implements OcbAgentSvcAsync
Async client implementation for OcbAgentSvc 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 |
OcbAgentSvcAsyncClient.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 OcbAgentSvc.
|
Constructor and Description |
---|
OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for OcbAgentSvc.
public final String clientCommonLibraryVersion
@Deprecated public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public OcbAgentSvcAsyncClient(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 OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public OcbAgentSvcAsyncClient(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 OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
public static OcbAgentSvcAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
OcbAgentSvcAsync
Sets 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 OcbAgentSvcAsync
region
- The region of the service.public void setRegion(String regionId)
OcbAgentSvcAsync
Sets 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 OcbAgentSvcAsync
regionId
- The public region ID.public Future<AddAgentDependencyResponse> addAgentDependency(AddAgentDependencyRequest request, AsyncHandler<AddAgentDependencyRequest,AddAgentDependencyResponse> handler)
OcbAgentSvcAsync
Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource.
addAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeAgentCompartmentResponse> changeAgentCompartment(ChangeAgentCompartmentRequest request, AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler)
OcbAgentSvcAsync
Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeAgentCompartment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeAgentDependencyCompartmentResponse> changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request, AsyncHandler<ChangeAgentDependencyCompartmentRequest,ChangeAgentDependencyCompartmentResponse> handler)
OcbAgentSvcAsync
Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeAgentDependencyCompartment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeEnvironmentCompartmentResponse> changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request, AsyncHandler<ChangeEnvironmentCompartmentRequest,ChangeEnvironmentCompartmentResponse> handler)
OcbAgentSvcAsync
Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeEnvironmentCompartment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateAgentResponse> createAgent(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler)
OcbAgentSvcAsync
Creates an Agent.
createAgent
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateAgentDependencyResponse> createAgentDependency(CreateAgentDependencyRequest request, AsyncHandler<CreateAgentDependencyRequest,CreateAgentDependencyResponse> handler)
OcbAgentSvcAsync
Creates an AgentDependency.
createAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest request, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResponse> handler)
OcbAgentSvcAsync
Creates a source environment.
createEnvironment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler)
OcbAgentSvcAsync
Deletes an Agent resource identified by an identifier.
deleteAgent
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteAgentDependencyResponse> deleteAgentDependency(DeleteAgentDependencyRequest request, AsyncHandler<DeleteAgentDependencyRequest,DeleteAgentDependencyResponse> handler)
OcbAgentSvcAsync
Deletes the AgentDependency resource based on an identifier.
deleteAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest request, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResponse> handler)
OcbAgentSvcAsync
Deletes a the source environment resource identified by an identifier.
deleteEnvironment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetAgentResponse> getAgent(GetAgentRequest request, AsyncHandler<GetAgentRequest,GetAgentResponse> handler)
OcbAgentSvcAsync
Gets an Agent by identifier.
getAgent
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetAgentDependencyResponse> getAgentDependency(GetAgentDependencyRequest request, AsyncHandler<GetAgentDependencyRequest,GetAgentDependencyResponse> handler)
OcbAgentSvcAsync
Gets an AgentDependency by identifier.
getAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest request, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResponse> handler)
OcbAgentSvcAsync
Gets a source environment by identifier.
getEnvironment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetPluginResponse> getPlugin(GetPluginRequest request, AsyncHandler<GetPluginRequest,GetPluginResponse> handler)
OcbAgentSvcAsync
Gets a plugin by identifier.
getPlugin
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAgentDependenciesResponse> listAgentDependencies(ListAgentDependenciesRequest request, AsyncHandler<ListAgentDependenciesRequest,ListAgentDependenciesResponse> handler)
OcbAgentSvcAsync
Returns a list of AgentDependencies such as AgentDependencyCollection.
listAgentDependencies
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAgentsResponse> listAgents(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler)
OcbAgentSvcAsync
Returns a list of Agents.
listAgents
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListApplianceImagesResponse> listApplianceImages(ListApplianceImagesRequest request, AsyncHandler<ListApplianceImagesRequest,ListApplianceImagesResponse> handler)
OcbAgentSvcAsync
Returns a list of Appliance Images.
listApplianceImages
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResponse> handler)
OcbAgentSvcAsync
Returns a list of source environments.
listEnvironments
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveAgentDependencyResponse> removeAgentDependency(RemoveAgentDependencyRequest request, AsyncHandler<RemoveAgentDependencyRequest,RemoveAgentDependencyResponse> handler)
OcbAgentSvcAsync
Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource.
removeAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateAgentResponse> updateAgent(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler)
OcbAgentSvcAsync
Updates the Agent.
updateAgent
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateAgentDependencyResponse> updateAgentDependency(UpdateAgentDependencyRequest request, AsyncHandler<UpdateAgentDependencyRequest,UpdateAgentDependencyResponse> handler)
OcbAgentSvcAsync
Updates the AgentDependency.
updateAgentDependency
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest request, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResponse> handler)
OcbAgentSvcAsync
Updates the source environment.
updateEnvironment
in interface OcbAgentSvcAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdatePluginResponse> updatePlugin(UpdatePluginRequest request, AsyncHandler<UpdatePluginRequest,UpdatePluginResponse> handler)
OcbAgentSvcAsync
Updates the plugin.
updatePlugin
in interface OcbAgentSvcAsync
request
- 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 ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public 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.