Class BaseinfraAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.datacc.BaseinfraAsyncClient
-
- All Implemented Interfaces:
BaseinfraAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20251101") public class BaseinfraAsyncClient extends BaseAsyncClient implements BaseinfraAsyncAsync client implementation for Baseinfra 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 classBaseinfraAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields 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 Baseinfra.
-
Constructor Summary
Constructors Constructor Description BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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.datacc.BaseinfraAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(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 (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
BaseinfraAsyncClient
@Deprecated public BaseinfraAsyncClient(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 (seeBaseinfraAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static BaseinfraAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:BaseinfraAsyncSets 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 interfaceBaseinfraAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:BaseinfraAsyncSets 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 interfaceBaseinfraAsync- Parameters:
regionId- The public region ID.
-
activateInfrastructure
public Future<ActivateInfrastructureResponse> activateInfrastructure(ActivateInfrastructureRequest request, AsyncHandler<ActivateInfrastructureRequest,ActivateInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncActivate an Database Infrastructure using the specified details.- Specified by:
activateInfrastructurein interfaceBaseinfraAsync- 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.
-
changeInfrastructureCompartment
public Future<ChangeInfrastructureCompartmentResponse> changeInfrastructureCompartment(ChangeInfrastructureCompartmentRequest request, AsyncHandler<ChangeInfrastructureCompartmentRequest,ChangeInfrastructureCompartmentResponse> handler)
Description copied from interface:BaseinfraAsyncChange the Database Infrastructure Cloud@Customer Compartment to the specified OCID.- Specified by:
changeInfrastructureCompartmentin interfaceBaseinfraAsync- 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.
-
changeVmClusterNetworkCompartment
public Future<ChangeVmClusterNetworkCompartmentResponse> changeVmClusterNetworkCompartment(ChangeVmClusterNetworkCompartmentRequest request, AsyncHandler<ChangeVmClusterNetworkCompartmentRequest,ChangeVmClusterNetworkCompartmentResponse> handler)
Description copied from interface:BaseinfraAsyncChange the VM cluster network Compartment to the specified OCID.- Specified by:
changeVmClusterNetworkCompartmentin interfaceBaseinfraAsync- 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.
-
changeVmInstanceCompartment
public Future<ChangeVmInstanceCompartmentResponse> changeVmInstanceCompartment(ChangeVmInstanceCompartmentRequest request, AsyncHandler<ChangeVmInstanceCompartmentRequest,ChangeVmInstanceCompartmentResponse> handler)
Description copied from interface:BaseinfraAsyncChange the VM instance on Database Infrastructure Compartment to the specified OCID.- Specified by:
changeVmInstanceCompartmentin interfaceBaseinfraAsync- 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.
-
createInfrastructure
public Future<CreateInfrastructureResponse> createInfrastructure(CreateInfrastructureRequest request, AsyncHandler<CreateInfrastructureRequest,CreateInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncCreate a Database Infrastructure using the specified details.- Specified by:
createInfrastructurein interfaceBaseinfraAsync- 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.
-
createVmClusterNetwork
public Future<CreateVmClusterNetworkResponse> createVmClusterNetwork(CreateVmClusterNetworkRequest request, AsyncHandler<CreateVmClusterNetworkRequest,CreateVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncCreate an VM cluster on Database Infrastructure network using the specified details.- Specified by:
createVmClusterNetworkin interfaceBaseinfraAsync- 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.
-
createVmInstance
public Future<CreateVmInstanceResponse> createVmInstance(CreateVmInstanceRequest request, AsyncHandler<CreateVmInstanceRequest,CreateVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncCreate an VM instance on Database Infrastructure using the specified details.- Specified by:
createVmInstancein interfaceBaseinfraAsync- 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.
-
deleteInfrastructure
public Future<DeleteInfrastructureResponse> deleteInfrastructure(DeleteInfrastructureRequest request, AsyncHandler<DeleteInfrastructureRequest,DeleteInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncDelete the Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteInfrastructurein interfaceBaseinfraAsync- 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.
-
deleteVmClusterNetwork
public Future<DeleteVmClusterNetworkResponse> deleteVmClusterNetwork(DeleteVmClusterNetworkRequest request, AsyncHandler<DeleteVmClusterNetworkRequest,DeleteVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncDelete the VM cluster network on Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteVmClusterNetworkin interfaceBaseinfraAsync- 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.
-
deleteVmInstance
public Future<DeleteVmInstanceResponse> deleteVmInstance(DeleteVmInstanceRequest request, AsyncHandler<DeleteVmInstanceRequest,DeleteVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncDelete the VM instance on Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteVmInstancein interfaceBaseinfraAsync- 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.
-
downloadInfrastructureConfigFile
public Future<DownloadInfrastructureConfigFileResponse> downloadInfrastructureConfigFile(DownloadInfrastructureConfigFileRequest request, AsyncHandler<DownloadInfrastructureConfigFileRequest,DownloadInfrastructureConfigFileResponse> handler)
Description copied from interface:BaseinfraAsyncDownloads the configuration file for the specified Database Infrastructure Cloud@Customer.- Specified by:
downloadInfrastructureConfigFilein interfaceBaseinfraAsync- 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.
-
downloadInfrastructureValidationScript
public Future<DownloadInfrastructureValidationScriptResponse> downloadInfrastructureValidationScript(DownloadInfrastructureValidationScriptRequest request, AsyncHandler<DownloadInfrastructureValidationScriptRequest,DownloadInfrastructureValidationScriptResponse> handler)
Description copied from interface:BaseinfraAsyncDownloads the validation script for the specified Database Infrastructure Cloud@Customer.- Specified by:
downloadInfrastructureValidationScriptin interfaceBaseinfraAsync- 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.
-
generateRecommendedVmClusterNetwork
public Future<GenerateRecommendedVmClusterNetworkResponse> generateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request, AsyncHandler<GenerateRecommendedVmClusterNetworkRequest,GenerateRecommendedVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncGenerates an VM cluster network configuration using the specified details.- Specified by:
generateRecommendedVmClusterNetworkin interfaceBaseinfraAsync- 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.
-
getInfrastructure
public Future<GetInfrastructureResponse> getInfrastructure(GetInfrastructureRequest request, AsyncHandler<GetInfrastructureRequest,GetInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncObtain the Database Infrastructure that has the specified OCID.- Specified by:
getInfrastructurein interfaceBaseinfraAsync- 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.
-
getInfrastructureScaleOption
public Future<GetInfrastructureScaleOptionResponse> getInfrastructureScaleOption(GetInfrastructureScaleOptionRequest request, AsyncHandler<GetInfrastructureScaleOptionRequest,GetInfrastructureScaleOptionResponse> handler)
Description copied from interface:BaseinfraAsyncGet the available scale options for the infrastructure that has the specified OCID.- Specified by:
getInfrastructureScaleOptionin interfaceBaseinfraAsync- 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.
-
getMaintenanceExecution
public Future<GetMaintenanceExecutionResponse> getMaintenanceExecution(GetMaintenanceExecutionRequest request, AsyncHandler<GetMaintenanceExecutionRequest,GetMaintenanceExecutionResponse> handler)
Description copied from interface:BaseinfraAsyncGets information about the specified OCID.- Specified by:
getMaintenanceExecutionin interfaceBaseinfraAsync- 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.
-
getMaintenanceRun
public Future<GetMaintenanceRunResponse> getMaintenanceRun(GetMaintenanceRunRequest request, AsyncHandler<GetMaintenanceRunRequest,GetMaintenanceRunResponse> handler)
Description copied from interface:BaseinfraAsyncGets information about the specified OCID.- Specified by:
getMaintenanceRunin interfaceBaseinfraAsync- 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.
-
getVmClusterNetwork
public Future<GetVmClusterNetworkResponse> getVmClusterNetwork(GetVmClusterNetworkRequest request, AsyncHandler<GetVmClusterNetworkRequest,GetVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncObtain the VM cluster network on Database Infrastructure that has the specified OCID.- Specified by:
getVmClusterNetworkin interfaceBaseinfraAsync- 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.
-
getVmInstance
public Future<GetVmInstanceResponse> getVmInstance(GetVmInstanceRequest request, AsyncHandler<GetVmInstanceRequest,GetVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncObtain the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
getVmInstancein interfaceBaseinfraAsync- 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.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:BaseinfraAsyncGet the status of the work request having the specified work request OCID.- Specified by:
getWorkRequestin interfaceBaseinfraAsync- 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.
-
listInfrastructures
public Future<ListInfrastructuresResponse> listInfrastructures(ListInfrastructuresRequest request, AsyncHandler<ListInfrastructuresRequest,ListInfrastructuresResponse> handler)
Description copied from interface:BaseinfraAsyncObtain a list of Database Infrastructures.- Specified by:
listInfrastructuresin interfaceBaseinfraAsync- 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.
-
listMaintenanceExecutions
public Future<ListMaintenanceExecutionsResponse> listMaintenanceExecutions(ListMaintenanceExecutionsRequest request, AsyncHandler<ListMaintenanceExecutionsRequest,ListMaintenanceExecutionsResponse> handler)
Description copied from interface:BaseinfraAsyncGets a list of the maintenance executions in the specified compartment.- Specified by:
listMaintenanceExecutionsin interfaceBaseinfraAsync- 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.
-
listMaintenanceRuns
public Future<ListMaintenanceRunsResponse> listMaintenanceRuns(ListMaintenanceRunsRequest request, AsyncHandler<ListMaintenanceRunsRequest,ListMaintenanceRunsResponse> handler)
Description copied from interface:BaseinfraAsyncGets a list of the maintenance runs in the specified compartment.- Specified by:
listMaintenanceRunsin interfaceBaseinfraAsync- 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.
-
listVmClusterNetworks
public Future<ListVmClusterNetworksResponse> listVmClusterNetworks(ListVmClusterNetworksRequest request, AsyncHandler<ListVmClusterNetworksRequest,ListVmClusterNetworksResponse> handler)
Description copied from interface:BaseinfraAsyncObtain a list of VM cluster networks on Database Infrastructure.- Specified by:
listVmClusterNetworksin interfaceBaseinfraAsync- 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.
-
listVmInstances
public Future<ListVmInstancesResponse> listVmInstances(ListVmInstancesRequest request, AsyncHandler<ListVmInstancesRequest,ListVmInstancesResponse> handler)
Description copied from interface:BaseinfraAsyncObtain a list of VM instances.- Specified by:
listVmInstancesin interfaceBaseinfraAsync- 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.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:BaseinfraAsyncView the list of errors for the work request that have the specified work request OCID.- Specified by:
listWorkRequestErrorsin interfaceBaseinfraAsync- 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.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:BaseinfraAsyncView the log entries for the work request that have the specified work request OCID.- Specified by:
listWorkRequestLogsin interfaceBaseinfraAsync- 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.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:BaseinfraAsyncView a list of work request details in the specified compartment.- Specified by:
listWorkRequestsin interfaceBaseinfraAsync- 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.
-
migrateVmInstance
public Future<MigrateVmInstanceResponse> migrateVmInstance(MigrateVmInstanceRequest request, AsyncHandler<MigrateVmInstanceRequest,MigrateVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncMigrate the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
migrateVmInstancein interfaceBaseinfraAsync- 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.
-
rescheduleMaintenanceRun
public Future<RescheduleMaintenanceRunResponse> rescheduleMaintenanceRun(RescheduleMaintenanceRunRequest request, AsyncHandler<RescheduleMaintenanceRunRequest,RescheduleMaintenanceRunResponse> handler)
Description copied from interface:BaseinfraAsyncReschedules the specified maintenance run by providing a newtimeScheduledvalue.Only maintenance runs in eligible states may be rescheduled.
- Specified by:
rescheduleMaintenanceRunin interfaceBaseinfraAsync- 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.
-
restartVmInstance
public Future<RestartVmInstanceResponse> restartVmInstance(RestartVmInstanceRequest request, AsyncHandler<RestartVmInstanceRequest,RestartVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncRestart the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
restartVmInstancein interfaceBaseinfraAsync- 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.
-
scaleInfrastructureStorage
public Future<ScaleInfrastructureStorageResponse> scaleInfrastructureStorage(ScaleInfrastructureStorageRequest request, AsyncHandler<ScaleInfrastructureStorageRequest,ScaleInfrastructureStorageResponse> handler)
Description copied from interface:BaseinfraAsyncScale storage for the specified infrastructure using the specified details.- Specified by:
scaleInfrastructureStoragein interfaceBaseinfraAsync- 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.
-
scaleVmInstance
public Future<ScaleVmInstanceResponse> scaleVmInstance(ScaleVmInstanceRequest request, AsyncHandler<ScaleVmInstanceRequest,ScaleVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncScale the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
scaleVmInstancein interfaceBaseinfraAsync- 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.
-
startVmInstance
public Future<StartVmInstanceResponse> startVmInstance(StartVmInstanceRequest request, AsyncHandler<StartVmInstanceRequest,StartVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncStart the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
startVmInstancein interfaceBaseinfraAsync- 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.
-
stopVmInstance
public Future<StopVmInstanceResponse> stopVmInstance(StopVmInstanceRequest request, AsyncHandler<StopVmInstanceRequest,StopVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncStop the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
stopVmInstancein interfaceBaseinfraAsync- 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.
-
updateInfrastructure
public Future<UpdateInfrastructureResponse> updateInfrastructure(UpdateInfrastructureRequest request, AsyncHandler<UpdateInfrastructureRequest,UpdateInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncUpdate the Database Infrastructure that has the specified OCID.- Specified by:
updateInfrastructurein interfaceBaseinfraAsync- 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.
-
updateMaintenanceRun
public Future<UpdateMaintenanceRunResponse> updateMaintenanceRun(UpdateMaintenanceRunRequest request, AsyncHandler<UpdateMaintenanceRunRequest,UpdateMaintenanceRunResponse> handler)
Description copied from interface:BaseinfraAsyncUpdate maintenance run attributes.- Specified by:
updateMaintenanceRunin interfaceBaseinfraAsync- 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.
-
updateVmClusterNetwork
public Future<UpdateVmClusterNetworkResponse> updateVmClusterNetwork(UpdateVmClusterNetworkRequest request, AsyncHandler<UpdateVmClusterNetworkRequest,UpdateVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncUpdate the VM cluster network on Database Infrastructure that has the specified OCID.- Specified by:
updateVmClusterNetworkin interfaceBaseinfraAsync- 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.
-
updateVmInstance
public Future<UpdateVmInstanceResponse> updateVmInstance(UpdateVmInstanceRequest request, AsyncHandler<UpdateVmInstanceRequest,UpdateVmInstanceResponse> handler)
Description copied from interface:BaseinfraAsyncUpdate the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
updateVmInstancein interfaceBaseinfraAsync- 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.
-
validateInfrastructure
public Future<ValidateInfrastructureResponse> validateInfrastructure(ValidateInfrastructureRequest request, AsyncHandler<ValidateInfrastructureRequest,ValidateInfrastructureResponse> handler)
Description copied from interface:BaseinfraAsyncValidate an Database Infrastructure using the specified details.- Specified by:
validateInfrastructurein interfaceBaseinfraAsync- 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.
-
validateVmClusterNetwork
public Future<ValidateVmClusterNetworkResponse> validateVmClusterNetwork(ValidateVmClusterNetworkRequest request, AsyncHandler<ValidateVmClusterNetworkRequest,ValidateVmClusterNetworkResponse> handler)
Description copied from interface:BaseinfraAsyncValidates an VM cluster network on Database Infrastructure.- Specified by:
validateVmClusterNetworkin interfaceBaseinfraAsync- 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein 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)
-
-