Class RoverNodeAsyncClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseAsyncClient
- 
- com.oracle.bmc.rover.RoverNodeAsyncClient
 
 
- 
- All Implemented Interfaces:
- RoverNodeAsync,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20201210") public class RoverNodeAsyncClient extends BaseAsyncClient implements RoverNodeAsyncAsync client implementation for RoverNode service.
 There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, 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 SummaryNested Classes Modifier and Type Class Description static classRoverNodeAsyncClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for RoverNode.
 - 
Constructor SummaryConstructors Constructor Description RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method Summary- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.rover.RoverNodeAsyncgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.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)
 
 - 
RoverNodeAsyncClient@Deprecated public RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- RoverNodeAsyncClient.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- 
builderpublic static RoverNodeAsyncClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:RoverNodeAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
- setRegionin interface- RoverNodeAsync
- Parameters:
- region- The region of the service.
 
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:RoverNodeAsyncSets 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 callsetEndpoint.- Specified by:
- setRegionin interface- RoverNodeAsync
- Parameters:
- regionId- The public region ID.
 
 - 
changeRoverNodeCompartmentpublic Future<ChangeRoverNodeCompartmentResponse> changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request, AsyncHandler<ChangeRoverNodeCompartmentRequest,ChangeRoverNodeCompartmentResponse> handler) Description copied from interface:RoverNodeAsyncMoves a rover node into a different compartment.- Specified by:
- changeRoverNodeCompartmentin interface- RoverNodeAsync
- 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.
 
 - 
createRoverNodepublic Future<CreateRoverNodeResponse> createRoverNode(CreateRoverNodeRequest request, AsyncHandler<CreateRoverNodeRequest,CreateRoverNodeResponse> handler) Description copied from interface:RoverNodeAsyncCreates a new RoverNode.- Specified by:
- createRoverNodein interface- RoverNodeAsync
- 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.
 
 - 
deleteRoverNodepublic Future<DeleteRoverNodeResponse> deleteRoverNode(DeleteRoverNodeRequest request, AsyncHandler<DeleteRoverNodeRequest,DeleteRoverNodeResponse> handler) Description copied from interface:RoverNodeAsyncDeletes a RoverNode resource by identifier- Specified by:
- deleteRoverNodein interface- RoverNodeAsync
- 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.
 
 - 
getRoverNodepublic Future<GetRoverNodeResponse> getRoverNode(GetRoverNodeRequest request, AsyncHandler<GetRoverNodeRequest,GetRoverNodeResponse> handler) Description copied from interface:RoverNodeAsyncGets a RoverNode by identifier.- Specified by:
- getRoverNodein interface- RoverNodeAsync
- 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.
 
 - 
getRoverNodeCertificatepublic Future<GetRoverNodeCertificateResponse> getRoverNodeCertificate(GetRoverNodeCertificateRequest request, AsyncHandler<GetRoverNodeCertificateRequest,GetRoverNodeCertificateResponse> handler) Description copied from interface:RoverNodeAsyncGet the certificate for a rover node- Specified by:
- getRoverNodeCertificatein interface- RoverNodeAsync
- 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.
 
 - 
getRoverNodeEncryptionKeypublic Future<GetRoverNodeEncryptionKeyResponse> getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request, AsyncHandler<GetRoverNodeEncryptionKeyRequest,GetRoverNodeEncryptionKeyResponse> handler) Description copied from interface:RoverNodeAsyncGet the data encryption key for a rover node.- Specified by:
- getRoverNodeEncryptionKeyin interface- RoverNodeAsync
- 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.
 
 - 
getRoverNodeGetRptpublic Future<GetRoverNodeGetRptResponse> getRoverNodeGetRpt(GetRoverNodeGetRptRequest request, AsyncHandler<GetRoverNodeGetRptRequest,GetRoverNodeGetRptResponse> handler) Description copied from interface:RoverNodeAsyncGet the resource principal token for a rover node- Specified by:
- getRoverNodeGetRptin interface- RoverNodeAsync
- 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.
 
 - 
listRoverNodespublic Future<ListRoverNodesResponse> listRoverNodes(ListRoverNodesRequest request, AsyncHandler<ListRoverNodesRequest,ListRoverNodesResponse> handler) Description copied from interface:RoverNodeAsyncReturns a list of RoverNodes.- Specified by:
- listRoverNodesin interface- RoverNodeAsync
- 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.
 
 - 
roverNodeActionRetrieveCaBundlepublic Future<RoverNodeActionRetrieveCaBundleResponse> roverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request, AsyncHandler<RoverNodeActionRetrieveCaBundleRequest,RoverNodeActionRetrieveCaBundleResponse> handler) Description copied from interface:RoverNodeAsyncRetrieve Ca Bundle for a rover node- Specified by:
- roverNodeActionRetrieveCaBundlein interface- RoverNodeAsync
- 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.
 
 - 
roverNodeActionSetKeypublic Future<RoverNodeActionSetKeyResponse> roverNodeActionSetKey(RoverNodeActionSetKeyRequest request, AsyncHandler<RoverNodeActionSetKeyRequest,RoverNodeActionSetKeyResponse> handler) Description copied from interface:RoverNodeAsyncGet the resource principal public key for a rover node- Specified by:
- roverNodeActionSetKeyin interface- RoverNodeAsync
- 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.
 
 - 
roverNodeGenerateCertificatepublic Future<RoverNodeGenerateCertificateResponse> roverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request, AsyncHandler<RoverNodeGenerateCertificateRequest,RoverNodeGenerateCertificateResponse> handler) Description copied from interface:RoverNodeAsyncRequest to generate certificate for a roverNode.- Specified by:
- roverNodeGenerateCertificatein interface- RoverNodeAsync
- 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.
 
 - 
roverNodeRenewCertificatepublic Future<RoverNodeRenewCertificateResponse> roverNodeRenewCertificate(RoverNodeRenewCertificateRequest request, AsyncHandler<RoverNodeRenewCertificateRequest,RoverNodeRenewCertificateResponse> handler) Description copied from interface:RoverNodeAsyncRequest to renew certificate for a roverNode.- Specified by:
- roverNodeRenewCertificatein interface- RoverNodeAsync
- 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.
 
 - 
roverNodeReplaceCertificateAuthoritypublic Future<RoverNodeReplaceCertificateAuthorityResponse> roverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request, AsyncHandler<RoverNodeReplaceCertificateAuthorityRequest,RoverNodeReplaceCertificateAuthorityResponse> handler) Description copied from interface:RoverNodeAsyncRequest to replace certificate authority for a roverNode.- Specified by:
- roverNodeReplaceCertificateAuthorityin interface- RoverNodeAsync
- 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.
 
 - 
roverNodeRetrieveLeafCertificatepublic Future<RoverNodeRetrieveLeafCertificateResponse> roverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request, AsyncHandler<RoverNodeRetrieveLeafCertificateRequest,RoverNodeRetrieveLeafCertificateResponse> handler) Description copied from interface:RoverNodeAsyncRetrieve the leaf certificate info for a rover node- Specified by:
- roverNodeRetrieveLeafCertificatein interface- RoverNodeAsync
- 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.
 
 - 
updateRoverNodepublic Future<UpdateRoverNodeResponse> updateRoverNode(UpdateRoverNodeRequest request, AsyncHandler<UpdateRoverNodeRequest,UpdateRoverNodeResponse> handler) Description copied from interface:RoverNodeAsyncUpdates the RoverNode- Specified by:
- updateRoverNodein interface- RoverNodeAsync
- 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.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic 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
 
 - 
populateServiceParametersInEndpointpublic 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
 
 - 
updateBaseEndpointpublic 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
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 - 
getMinimumClientCommonLibraryVersionFromClientpublic Optional<String> getMinimumClientCommonLibraryVersionFromClient() 
 - 
clientCallprotected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder) 
 
- 
 
-