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 RoverNodeAsync
Async 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 Summary
Nested Classes Modifier and Type Class Description static class
RoverNodeAsyncClient.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 RoverNode.
-
Constructor Summary
Constructors Constructor Description RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
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.RoverNodeAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
RoverNodeAsyncClient
@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
RoverNodeAsyncClient
@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
RoverNodeAsyncClient
@Deprecated public RoverNodeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeRoverNodeAsyncClient.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 RoverNodeAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:RoverNodeAsync
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 interfaceRoverNodeAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:RoverNodeAsync
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceRoverNodeAsync
- Parameters:
regionId
- The public region ID.
-
changeRoverNodeCompartment
public Future<ChangeRoverNodeCompartmentResponse> changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request, AsyncHandler<ChangeRoverNodeCompartmentRequest,ChangeRoverNodeCompartmentResponse> handler)
Description copied from interface:RoverNodeAsync
Moves a rover node into a different compartment.- Specified by:
changeRoverNodeCompartment
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createRoverNode
public Future<CreateRoverNodeResponse> createRoverNode(CreateRoverNodeRequest request, AsyncHandler<CreateRoverNodeRequest,CreateRoverNodeResponse> handler)
Description copied from interface:RoverNodeAsync
Creates a new RoverNode.- Specified by:
createRoverNode
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteRoverNode
public Future<DeleteRoverNodeResponse> deleteRoverNode(DeleteRoverNodeRequest request, AsyncHandler<DeleteRoverNodeRequest,DeleteRoverNodeResponse> handler)
Description copied from interface:RoverNodeAsync
Deletes a RoverNode resource by identifier- Specified by:
deleteRoverNode
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getRoverNode
public Future<GetRoverNodeResponse> getRoverNode(GetRoverNodeRequest request, AsyncHandler<GetRoverNodeRequest,GetRoverNodeResponse> handler)
Description copied from interface:RoverNodeAsync
Gets a RoverNode by identifier.- Specified by:
getRoverNode
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getRoverNodeCertificate
public Future<GetRoverNodeCertificateResponse> getRoverNodeCertificate(GetRoverNodeCertificateRequest request, AsyncHandler<GetRoverNodeCertificateRequest,GetRoverNodeCertificateResponse> handler)
Description copied from interface:RoverNodeAsync
Get the certificate for a rover node- Specified by:
getRoverNodeCertificate
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getRoverNodeEncryptionKey
public Future<GetRoverNodeEncryptionKeyResponse> getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request, AsyncHandler<GetRoverNodeEncryptionKeyRequest,GetRoverNodeEncryptionKeyResponse> handler)
Description copied from interface:RoverNodeAsync
Get the data encryption key for a rover node.- Specified by:
getRoverNodeEncryptionKey
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getRoverNodeGetRpt
public Future<GetRoverNodeGetRptResponse> getRoverNodeGetRpt(GetRoverNodeGetRptRequest request, AsyncHandler<GetRoverNodeGetRptRequest,GetRoverNodeGetRptResponse> handler)
Description copied from interface:RoverNodeAsync
Get the resource principal token for a rover node- Specified by:
getRoverNodeGetRpt
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listRoverNodes
public Future<ListRoverNodesResponse> listRoverNodes(ListRoverNodesRequest request, AsyncHandler<ListRoverNodesRequest,ListRoverNodesResponse> handler)
Description copied from interface:RoverNodeAsync
Returns a list of RoverNodes.- Specified by:
listRoverNodes
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeActionRetrieveCaBundle
public Future<RoverNodeActionRetrieveCaBundleResponse> roverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request, AsyncHandler<RoverNodeActionRetrieveCaBundleRequest,RoverNodeActionRetrieveCaBundleResponse> handler)
Description copied from interface:RoverNodeAsync
Retrieve Ca Bundle for a rover node- Specified by:
roverNodeActionRetrieveCaBundle
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeActionSetKey
public Future<RoverNodeActionSetKeyResponse> roverNodeActionSetKey(RoverNodeActionSetKeyRequest request, AsyncHandler<RoverNodeActionSetKeyRequest,RoverNodeActionSetKeyResponse> handler)
Description copied from interface:RoverNodeAsync
Get the resource principal public key for a rover node- Specified by:
roverNodeActionSetKey
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeGenerateCertificate
public Future<RoverNodeGenerateCertificateResponse> roverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request, AsyncHandler<RoverNodeGenerateCertificateRequest,RoverNodeGenerateCertificateResponse> handler)
Description copied from interface:RoverNodeAsync
Request to generate certificate for a roverNode.- Specified by:
roverNodeGenerateCertificate
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeRenewCertificate
public Future<RoverNodeRenewCertificateResponse> roverNodeRenewCertificate(RoverNodeRenewCertificateRequest request, AsyncHandler<RoverNodeRenewCertificateRequest,RoverNodeRenewCertificateResponse> handler)
Description copied from interface:RoverNodeAsync
Request to renew certificate for a roverNode.- Specified by:
roverNodeRenewCertificate
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeReplaceCertificateAuthority
public Future<RoverNodeReplaceCertificateAuthorityResponse> roverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request, AsyncHandler<RoverNodeReplaceCertificateAuthorityRequest,RoverNodeReplaceCertificateAuthorityResponse> handler)
Description copied from interface:RoverNodeAsync
Request to replace certificate authority for a roverNode.- Specified by:
roverNodeReplaceCertificateAuthority
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
roverNodeRetrieveLeafCertificate
public Future<RoverNodeRetrieveLeafCertificateResponse> roverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request, AsyncHandler<RoverNodeRetrieveLeafCertificateRequest,RoverNodeRetrieveLeafCertificateResponse> handler)
Description copied from interface:RoverNodeAsync
Retrieve the leaf certificate info for a rover node- Specified by:
roverNodeRetrieveLeafCertificate
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateRoverNode
public Future<UpdateRoverNodeResponse> updateRoverNode(UpdateRoverNodeRequest request, AsyncHandler<UpdateRoverNodeRequest,UpdateRoverNodeResponse> handler)
Description copied from interface:RoverNodeAsync
Updates the RoverNode- Specified by:
updateRoverNode
in interfaceRoverNodeAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
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)
-
-