Class ComputeCloudAtCustomerAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.computecloudatcustomer.ComputeCloudAtCustomerAsyncClient
-
- All Implemented Interfaces:
ComputeCloudAtCustomerAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20221208") public class ComputeCloudAtCustomerAsyncClient extends BaseAsyncClient implements ComputeCloudAtCustomerAsync
Async client implementation for ComputeCloudAtCustomer 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
ComputeCloudAtCustomerAsyncClient.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 ComputeCloudAtCustomer.
-
Constructor Summary
Constructors Constructor Description ComputeCloudAtCustomerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ComputeCloudAtCustomerAsyncClient(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.computecloudatcustomer.ComputeCloudAtCustomerAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeCloudAtCustomerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeCloudAtCustomerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeCloudAtCustomerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeCloudAtCustomerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(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 (seeComputeCloudAtCustomerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(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 (seeComputeCloudAtCustomerAsyncClient.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)
-
ComputeCloudAtCustomerAsyncClient
@Deprecated public ComputeCloudAtCustomerAsyncClient(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 (seeComputeCloudAtCustomerAsyncClient.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 ComputeCloudAtCustomerAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ComputeCloudAtCustomerAsync
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 interfaceComputeCloudAtCustomerAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ComputeCloudAtCustomerAsync
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 interfaceComputeCloudAtCustomerAsync
- Parameters:
regionId
- The public region ID.
-
changeCccInfrastructureCompartment
public Future<ChangeCccInfrastructureCompartmentResponse> changeCccInfrastructureCompartment(ChangeCccInfrastructureCompartmentRequest request, AsyncHandler<ChangeCccInfrastructureCompartmentRequest,ChangeCccInfrastructureCompartmentResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.- Specified by:
changeCccInfrastructureCompartment
in interfaceComputeCloudAtCustomerAsync
- 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.
-
changeCccUpgradeScheduleCompartment
public Future<ChangeCccUpgradeScheduleCompartmentResponse> changeCccUpgradeScheduleCompartment(ChangeCccUpgradeScheduleCompartmentRequest request, AsyncHandler<ChangeCccUpgradeScheduleCompartmentRequest,ChangeCccUpgradeScheduleCompartmentResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified OCID.- Specified by:
changeCccUpgradeScheduleCompartment
in interfaceComputeCloudAtCustomerAsync
- 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.
-
createCccInfrastructure
public Future<CreateCccInfrastructureResponse> createCccInfrastructure(CreateCccInfrastructureRequest request, AsyncHandler<CreateCccInfrastructureRequest,CreateCccInfrastructureResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Creates a Compute Cloud@Customer infrastructure.Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource.
- Specified by:
createCccInfrastructure
in interfaceComputeCloudAtCustomerAsync
- 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.
-
createCccUpgradeSchedule
public Future<CreateCccUpgradeScheduleResponse> createCccUpgradeSchedule(CreateCccUpgradeScheduleRequest request, AsyncHandler<CreateCccUpgradeScheduleRequest,CreateCccUpgradeScheduleResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Creates a new Compute Cloud@Customer upgrade schedule.- Specified by:
createCccUpgradeSchedule
in interfaceComputeCloudAtCustomerAsync
- 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.
-
deleteCccInfrastructure
public Future<DeleteCccInfrastructureResponse> deleteCccInfrastructure(DeleteCccInfrastructureRequest request, AsyncHandler<DeleteCccInfrastructureRequest,DeleteCccInfrastructureResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Deletes a Compute Cloud@Customer infrastructure resource specified by the resource OCID.- Specified by:
deleteCccInfrastructure
in interfaceComputeCloudAtCustomerAsync
- 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.
-
deleteCccUpgradeSchedule
public Future<DeleteCccUpgradeScheduleResponse> deleteCccUpgradeSchedule(DeleteCccUpgradeScheduleRequest request, AsyncHandler<DeleteCccUpgradeScheduleRequest,DeleteCccUpgradeScheduleResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Deletes a Compute Cloud@Customer upgrade schedule by the specified OCID.- Specified by:
deleteCccUpgradeSchedule
in interfaceComputeCloudAtCustomerAsync
- 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.
-
getCccInfrastructure
public Future<GetCccInfrastructureResponse> getCccInfrastructure(GetCccInfrastructureRequest request, AsyncHandler<GetCccInfrastructureRequest,GetCccInfrastructureResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Gets a Compute Cloud@Customer infrastructure using the infrastructure OCID.- Specified by:
getCccInfrastructure
in interfaceComputeCloudAtCustomerAsync
- 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.
-
getCccUpgradeSchedule
public Future<GetCccUpgradeScheduleResponse> getCccUpgradeSchedule(GetCccUpgradeScheduleRequest request, AsyncHandler<GetCccUpgradeScheduleRequest,GetCccUpgradeScheduleResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Gets a Compute Cloud@Customer upgrade schedule by the specified OCID.- Specified by:
getCccUpgradeSchedule
in interfaceComputeCloudAtCustomerAsync
- 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.
-
listCccInfrastructures
public Future<ListCccInfrastructuresResponse> listCccInfrastructures(ListCccInfrastructuresRequest request, AsyncHandler<ListCccInfrastructuresRequest,ListCccInfrastructuresResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Returns a list of Compute Cloud@Customer infrastructures.- Specified by:
listCccInfrastructures
in interfaceComputeCloudAtCustomerAsync
- 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.
-
listCccUpgradeSchedules
public Future<ListCccUpgradeSchedulesResponse> listCccUpgradeSchedules(ListCccUpgradeSchedulesRequest request, AsyncHandler<ListCccUpgradeSchedulesRequest,ListCccUpgradeSchedulesResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Returns a list of Compute Cloud@Customer upgrade schedules.- Specified by:
listCccUpgradeSchedules
in interfaceComputeCloudAtCustomerAsync
- 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.
-
updateCccInfrastructure
public Future<UpdateCccInfrastructureResponse> updateCccInfrastructure(UpdateCccInfrastructureRequest request, AsyncHandler<UpdateCccInfrastructureRequest,UpdateCccInfrastructureResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Updates Compute Cloud@Customer infrastructure resource.- Specified by:
updateCccInfrastructure
in interfaceComputeCloudAtCustomerAsync
- 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.
-
updateCccUpgradeSchedule
public Future<UpdateCccUpgradeScheduleResponse> updateCccUpgradeSchedule(UpdateCccUpgradeScheduleRequest request, AsyncHandler<UpdateCccUpgradeScheduleRequest,UpdateCccUpgradeScheduleResponse> handler)
Description copied from interface:ComputeCloudAtCustomerAsync
Updates the Compute Cloud@Customer upgrade schedule.- Specified by:
updateCccUpgradeSchedule
in interfaceComputeCloudAtCustomerAsync
- 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)
-
-