com.oracle.bmc.cloudbridge

Class OcbAgentSvcAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.cloudbridge.OcbAgentSvcAsyncClient

All Implemented Interfaces:

OcbAgentSvcAsync, AutoCloseable

@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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OcbAgentSvcAsyncClient.Builder Builder class for this client.

Field Summary

Fields

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 Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
Future<AddAgentDependencyResponse>	addAgentDependency(AddAgentDependencyRequest request, AsyncHandler<AddAgentDependencyRequest,AddAgentDependencyResponse> handler) Add a dependency to the environment.
static OcbAgentSvcAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeAgentCompartmentResponse>	changeAgentCompartment(ChangeAgentCompartmentRequest request, AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler) Moves an Agent resource from one compartment identifier to another.
Future<ChangeAgentDependencyCompartmentResponse>	changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request, AsyncHandler<ChangeAgentDependencyCompartmentRequest,ChangeAgentDependencyCompartmentResponse> handler) Moves a AgentDependency resource from one compartment identifier to another.
Future<ChangeEnvironmentCompartmentResponse>	changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request, AsyncHandler<ChangeEnvironmentCompartmentRequest,ChangeEnvironmentCompartmentResponse> handler) Moves a source environment resource from one compartment identifier to another.
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)
void	close()
Future<CreateAgentResponse>	createAgent(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler) Creates an Agent.
Future<CreateAgentDependencyResponse>	createAgentDependency(CreateAgentDependencyRequest request, AsyncHandler<CreateAgentDependencyRequest,CreateAgentDependencyResponse> handler) Creates an AgentDependency.
Future<CreateEnvironmentResponse>	createEnvironment(CreateEnvironmentRequest request, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResponse> handler) Creates a source environment.
Future<DeleteAgentResponse>	deleteAgent(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler) Deletes an Agent resource identified by an identifier.
Future<DeleteAgentDependencyResponse>	deleteAgentDependency(DeleteAgentDependencyRequest request, AsyncHandler<DeleteAgentDependencyRequest,DeleteAgentDependencyResponse> handler) Deletes the AgentDependency resource based on an identifier.
Future<DeleteEnvironmentResponse>	deleteEnvironment(DeleteEnvironmentRequest request, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResponse> handler) Deletes a the source environment resource identified by an identifier.
Future<GetAgentResponse>	getAgent(GetAgentRequest request, AsyncHandler<GetAgentRequest,GetAgentResponse> handler) Gets an Agent by identifier.
Future<GetAgentDependencyResponse>	getAgentDependency(GetAgentDependencyRequest request, AsyncHandler<GetAgentDependencyRequest,GetAgentDependencyResponse> handler) Gets an AgentDependency by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetEnvironmentResponse>	getEnvironment(GetEnvironmentRequest request, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResponse> handler) Gets a source environment by identifier.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPluginResponse>	getPlugin(GetPluginRequest request, AsyncHandler<GetPluginRequest,GetPluginResponse> handler) Gets a plugin by identifier.
Future<ListAgentDependenciesResponse>	listAgentDependencies(ListAgentDependenciesRequest request, AsyncHandler<ListAgentDependenciesRequest,ListAgentDependenciesResponse> handler) Returns a list of AgentDependencies such as AgentDependencyCollection.
Future<ListAgentsResponse>	listAgents(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler) Returns a list of Agents.
Future<ListApplianceImagesResponse>	listApplianceImages(ListApplianceImagesRequest request, AsyncHandler<ListApplianceImagesRequest,ListApplianceImagesResponse> handler) Returns a list of Appliance Images.
Future<ListEnvironmentsResponse>	listEnvironments(ListEnvironmentsRequest request, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResponse> handler) Returns a list of source environments.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
Future<RemoveAgentDependencyResponse>	removeAgentDependency(RemoveAgentDependencyRequest request, AsyncHandler<RemoveAgentDependencyRequest,RemoveAgentDependencyResponse> handler) Adds a dependency to the source environment.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateAgentResponse>	updateAgent(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler) Updates the Agent.
Future<UpdateAgentDependencyResponse>	updateAgentDependency(UpdateAgentDependencyRequest request, AsyncHandler<UpdateAgentDependencyRequest,UpdateAgentDependencyResponse> handler) Updates the AgentDependency.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateEnvironmentResponse>	updateEnvironment(UpdateEnvironmentRequest request, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResponse> handler) Updates the source environment.
Future<UpdatePluginResponse>	updatePlugin(UpdatePluginRequest request, AsyncHandler<UpdatePluginRequest,UpdatePluginResponse> handler) Updates the plugin.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.cloudbridge.OcbAgentSvcAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OcbAgentSvc.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OcbAgentSvcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          List<ClientConfigurator> additionalClientConfigurators,
                                          String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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)

OcbAgentSvcAsyncClient

@Deprecated
public OcbAgentSvcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                          List<ClientConfigurator> additionalClientConfigurators,
                                          String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

Method Detail

builder

public static OcbAgentSvcAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface OcbAgentSvcAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface OcbAgentSvcAsync

Parameters:

regionId - The public region ID.

addAgentDependency

public Future<AddAgentDependencyResponse> addAgentDependency(AddAgentDependencyRequest request,
                                                             AsyncHandler<AddAgentDependencyRequest,AddAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

addAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeAgentCompartment

public Future<ChangeAgentCompartmentResponse> changeAgentCompartment(ChangeAgentCompartmentRequest request,
                                                                     AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAgentCompartment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeAgentDependencyCompartment

public Future<ChangeAgentDependencyCompartmentResponse> changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request,
                                                                                         AsyncHandler<ChangeAgentDependencyCompartmentRequest,ChangeAgentDependencyCompartmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAgentDependencyCompartment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeEnvironmentCompartment

public Future<ChangeEnvironmentCompartmentResponse> changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request,
                                                                                 AsyncHandler<ChangeEnvironmentCompartmentRequest,ChangeEnvironmentCompartmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeEnvironmentCompartment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createAgent

public Future<CreateAgentResponse> createAgent(CreateAgentRequest request,
                                               AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Creates an Agent.

Specified by:

createAgent in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createAgentDependency

public Future<CreateAgentDependencyResponse> createAgentDependency(CreateAgentDependencyRequest request,
                                                                   AsyncHandler<CreateAgentDependencyRequest,CreateAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Creates an AgentDependency.

Specified by:

createAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createEnvironment

public Future<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest request,
                                                           AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Creates a source environment.

Specified by:

createEnvironment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAgent

public Future<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request,
                                               AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Deletes an Agent resource identified by an identifier.

Specified by:

deleteAgent in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAgentDependency

public Future<DeleteAgentDependencyResponse> deleteAgentDependency(DeleteAgentDependencyRequest request,
                                                                   AsyncHandler<DeleteAgentDependencyRequest,DeleteAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Deletes the AgentDependency resource based on an identifier.

Specified by:

deleteAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteEnvironment

public Future<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest request,
                                                           AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Deletes a the source environment resource identified by an identifier.

Specified by:

deleteEnvironment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAgent

public Future<GetAgentResponse> getAgent(GetAgentRequest request,
                                         AsyncHandler<GetAgentRequest,GetAgentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Gets an Agent by identifier.

Specified by:

getAgent in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAgentDependency

public Future<GetAgentDependencyResponse> getAgentDependency(GetAgentDependencyRequest request,
                                                             AsyncHandler<GetAgentDependencyRequest,GetAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Gets an AgentDependency by identifier.

Specified by:

getAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getEnvironment

public Future<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest request,
                                                     AsyncHandler<GetEnvironmentRequest,GetEnvironmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Gets a source environment by identifier.

Specified by:

getEnvironment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPlugin

public Future<GetPluginResponse> getPlugin(GetPluginRequest request,
                                           AsyncHandler<GetPluginRequest,GetPluginResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Gets a plugin by identifier.

Specified by:

getPlugin in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAgentDependencies

public Future<ListAgentDependenciesResponse> listAgentDependencies(ListAgentDependenciesRequest request,
                                                                   AsyncHandler<ListAgentDependenciesRequest,ListAgentDependenciesResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Returns a list of AgentDependencies such as AgentDependencyCollection.

Specified by:

listAgentDependencies in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAgents

public Future<ListAgentsResponse> listAgents(ListAgentsRequest request,
                                             AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Returns a list of Agents.

Specified by:

listAgents in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listApplianceImages

public Future<ListApplianceImagesResponse> listApplianceImages(ListApplianceImagesRequest request,
                                                               AsyncHandler<ListApplianceImagesRequest,ListApplianceImagesResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Returns a list of Appliance Images.

Specified by:

listApplianceImages in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listEnvironments

public Future<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request,
                                                         AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Returns a list of source environments.

Specified by:

listEnvironments in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeAgentDependency

public Future<RemoveAgentDependencyResponse> removeAgentDependency(RemoveAgentDependencyRequest request,
                                                                   AsyncHandler<RemoveAgentDependencyRequest,RemoveAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

removeAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAgent

public Future<UpdateAgentResponse> updateAgent(UpdateAgentRequest request,
                                               AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Updates the Agent.

Specified by:

updateAgent in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAgentDependency

public Future<UpdateAgentDependencyResponse> updateAgentDependency(UpdateAgentDependencyRequest request,
                                                                   AsyncHandler<UpdateAgentDependencyRequest,UpdateAgentDependencyResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Updates the AgentDependency.

Specified by:

updateAgentDependency in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateEnvironment

public Future<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest request,
                                                           AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Updates the source environment.

Specified by:

updateEnvironment in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updatePlugin

public Future<UpdatePluginResponse> updatePlugin(UpdatePluginRequest request,
                                                 AsyncHandler<UpdatePluginRequest,UpdatePluginResponse> handler)

Description copied from interface: OcbAgentSvcAsync

Updates the plugin.

Specified by:

updatePlugin in interface OcbAgentSvcAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

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)