Package com.oracle.bmc.rover

Class RoverBundleAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.rover.RoverBundleAsyncClient

All Implemented Interfaces:

RoverBundleAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public class RoverBundleAsyncClient
extends BaseAsyncClient
implements RoverBundleAsync

Async client implementation for RoverBundle 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	Description
static class	RoverBundleAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 RoverBundle.

Constructor Summary

Constructors

Constructor	Description
RoverBundleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
RoverBundleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static RoverBundleAsyncClient.Builder	builder()	Create a builder for this client.
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()
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListRoverClusterRoverBundleRequestsResponse>	listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request, AsyncHandler<ListRoverClusterRoverBundleRequestsRequest,ListRoverClusterRoverBundleRequestsResponse> handler)	List all the roverBundleRequests for a given roverClusterId.
Future<ListRoverNodeRoverBundleRequestsResponse>	listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request, AsyncHandler<ListRoverNodeRoverBundleRequestsRequest,ListRoverNodeRoverBundleRequestsResponse> handler)	List all the roverBundleRequests for a given roverNodeId.
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<RequestBundleRoverClusterResponse>	requestBundleRoverCluster(RequestBundleRoverClusterRequest request, AsyncHandler<RequestBundleRoverClusterRequest,RequestBundleRoverClusterResponse> handler)	Request to get rover bundle to the bucket in customer’s tenancy.
Future<RequestBundleRoverNodeResponse>	requestBundleRoverNode(RequestBundleRoverNodeRequest request, AsyncHandler<RequestBundleRoverNodeRequest,RequestBundleRoverNodeResponse> handler)	Request to get rover bundle to the bucket in customer’s tenancy.
Future<RetrieveAvailableBundleVersionsRoverClusterResponse>	retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request, AsyncHandler<RetrieveAvailableBundleVersionsRoverClusterRequest,RetrieveAvailableBundleVersionsRoverClusterResponse> handler)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Future<RetrieveAvailableBundleVersionsRoverNodeResponse>	retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request, AsyncHandler<RetrieveAvailableBundleVersionsRoverNodeRequest,RetrieveAvailableBundleVersionsRoverNodeResponse> handler)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Future<RetrieveBundleStatusRoverClusterResponse>	retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request, AsyncHandler<RetrieveBundleStatusRoverClusterRequest,RetrieveBundleStatusRoverClusterResponse> handler)	Retrieve the status and progress of a rover bundle copy request.
Future<RetrieveBundleStatusRoverNodeResponse>	retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request, AsyncHandler<RetrieveBundleStatusRoverNodeRequest,RetrieveBundleStatusRoverNodeResponse> handler)	Retrieve the status and progress of a rover bundle copy request.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.rover.RoverBundleAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for RoverBundle.

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

RoverBundleAsyncClient

@Deprecated
public RoverBundleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

RoverBundleAsyncClient

@Deprecated
public RoverBundleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

RoverBundleAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

RoverBundleAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RoverBundleAsyncClient

@Deprecated
public RoverBundleAsyncClient(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 RoverBundleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RoverBundleAsyncClient

@Deprecated
public RoverBundleAsyncClient(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 RoverBundleAsyncClient.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)

RoverBundleAsyncClient

@Deprecated
public RoverBundleAsyncClient(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 RoverBundleAsyncClient.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 RoverBundleAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: RoverBundleAsync

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 RoverBundleAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RoverBundleAsync

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 RoverBundleAsync

Parameters:

regionId - The public region ID.

listRoverClusterRoverBundleRequests

public Future<ListRoverClusterRoverBundleRequestsResponse> listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request,
                                                                                               AsyncHandler<ListRoverClusterRoverBundleRequestsRequest,ListRoverClusterRoverBundleRequestsResponse> handler)

Description copied from interface: RoverBundleAsync

List all the roverBundleRequests for a given roverClusterId.

Specified by:

listRoverClusterRoverBundleRequests in interface RoverBundleAsync

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.

listRoverNodeRoverBundleRequests

public Future<ListRoverNodeRoverBundleRequestsResponse> listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request,
                                                                                         AsyncHandler<ListRoverNodeRoverBundleRequestsRequest,ListRoverNodeRoverBundleRequestsResponse> handler)

Description copied from interface: RoverBundleAsync

List all the roverBundleRequests for a given roverNodeId.

Specified by:

listRoverNodeRoverBundleRequests in interface RoverBundleAsync

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.

requestBundleRoverCluster

public Future<RequestBundleRoverClusterResponse> requestBundleRoverCluster(RequestBundleRoverClusterRequest request,
                                                                           AsyncHandler<RequestBundleRoverClusterRequest,RequestBundleRoverClusterResponse> handler)

Description copied from interface: RoverBundleAsync

Request to get rover bundle to the bucket in customer’s tenancy.

Specified by:

requestBundleRoverCluster in interface RoverBundleAsync

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.

requestBundleRoverNode

public Future<RequestBundleRoverNodeResponse> requestBundleRoverNode(RequestBundleRoverNodeRequest request,
                                                                     AsyncHandler<RequestBundleRoverNodeRequest,RequestBundleRoverNodeResponse> handler)

Description copied from interface: RoverBundleAsync

Request to get rover bundle to the bucket in customer’s tenancy.

Specified by:

requestBundleRoverNode in interface RoverBundleAsync

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.

retrieveAvailableBundleVersionsRoverCluster

public Future<RetrieveAvailableBundleVersionsRoverClusterResponse> retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request,
                                                                                                               AsyncHandler<RetrieveAvailableBundleVersionsRoverClusterRequest,RetrieveAvailableBundleVersionsRoverClusterResponse> handler)

Description copied from interface: RoverBundleAsync

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Specified by:

retrieveAvailableBundleVersionsRoverCluster in interface RoverBundleAsync

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.

retrieveAvailableBundleVersionsRoverNode

public Future<RetrieveAvailableBundleVersionsRoverNodeResponse> retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request,
                                                                                                         AsyncHandler<RetrieveAvailableBundleVersionsRoverNodeRequest,RetrieveAvailableBundleVersionsRoverNodeResponse> handler)

Description copied from interface: RoverBundleAsync

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Specified by:

retrieveAvailableBundleVersionsRoverNode in interface RoverBundleAsync

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.

retrieveBundleStatusRoverCluster

public Future<RetrieveBundleStatusRoverClusterResponse> retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request,
                                                                                         AsyncHandler<RetrieveBundleStatusRoverClusterRequest,RetrieveBundleStatusRoverClusterResponse> handler)

Description copied from interface: RoverBundleAsync

Retrieve the status and progress of a rover bundle copy request.

Specified by:

retrieveBundleStatusRoverCluster in interface RoverBundleAsync

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.

retrieveBundleStatusRoverNode

public Future<RetrieveBundleStatusRoverNodeResponse> retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request,
                                                                                   AsyncHandler<RetrieveBundleStatusRoverNodeRequest,RetrieveBundleStatusRoverNodeResponse> handler)

Description copied from interface: RoverBundleAsync

Retrieve the status and progress of a rover bundle copy request.

Specified by:

retrieveBundleStatusRoverNode in interface RoverBundleAsync

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)