Class ComputeAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.core.ComputeAsyncClient
-
- All Implemented Interfaces:
ComputeAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeAsyncClient extends BaseAsyncClient implements ComputeAsyncAsync client implementation for Compute 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 classComputeAsyncClient.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 Compute.
-
Constructor Summary
Constructors Constructor Description ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ComputeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ComputeAsyncClient(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.core.ComputeAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(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 (seeComputeAsyncClient.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)
-
ComputeAsyncClient
@Deprecated public ComputeAsyncClient(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 (seeComputeAsyncClient.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 ComputeAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ComputeAsyncSets 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 interfaceComputeAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ComputeAsyncSets 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 interfaceComputeAsync- Parameters:
regionId- The public region ID.
-
acceptShieldedIntegrityPolicy
public Future<AcceptShieldedIntegrityPolicyResponse> acceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest request, AsyncHandler<AcceptShieldedIntegrityPolicyRequest,AcceptShieldedIntegrityPolicyResponse> handler)
Description copied from interface:ComputeAsyncAccept the changes to the PCR values in the measured boot report.- Specified by:
acceptShieldedIntegrityPolicyin interfaceComputeAsync- 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.
-
addImageShapeCompatibilityEntry
public Future<AddImageShapeCompatibilityEntryResponse> addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request, AsyncHandler<AddImageShapeCompatibilityEntryRequest,AddImageShapeCompatibilityEntryResponse> handler)
Description copied from interface:ComputeAsyncAdds a shape to the compatible shapes list for the image.- Specified by:
addImageShapeCompatibilityEntryin interfaceComputeAsync- 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.
-
attachBootVolume
public Future<AttachBootVolumeResponse> attachBootVolume(AttachBootVolumeRequest request, AsyncHandler<AttachBootVolumeRequest,AttachBootVolumeResponse> handler)
Description copied from interface:ComputeAsyncAttaches the specified boot volume to the specified instance.- Specified by:
attachBootVolumein interfaceComputeAsync- 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.
-
attachComputeHostGroupHost
public Future<AttachComputeHostGroupHostResponse> attachComputeHostGroupHost(AttachComputeHostGroupHostRequest request, AsyncHandler<AttachComputeHostGroupHostRequest,AttachComputeHostGroupHostResponse> handler)
Description copied from interface:ComputeAsyncAttaches the Compute BM Host to a Host group- Specified by:
attachComputeHostGroupHostin interfaceComputeAsync- 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.
-
attachVnic
public Future<AttachVnicResponse> attachVnic(AttachVnicRequest request, AsyncHandler<AttachVnicRequest,AttachVnicResponse> handler)
Description copied from interface:ComputeAsyncCreates a secondary VNIC and attaches it to the specified instance.For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
- Specified by:
attachVnicin interfaceComputeAsync- 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.
-
attachVolume
public Future<AttachVolumeResponse> attachVolume(AttachVolumeRequest request, AsyncHandler<AttachVolumeRequest,AttachVolumeResponse> handler)
Description copied from interface:ComputeAsyncAttaches the specified storage volume to the specified instance.- Specified by:
attachVolumein interfaceComputeAsync- 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.
-
captureConsoleHistory
public Future<CaptureConsoleHistoryResponse> captureConsoleHistory(CaptureConsoleHistoryRequest request, AsyncHandler<CaptureConsoleHistoryRequest,CaptureConsoleHistoryResponse> handler)
Description copied from interface:ComputeAsyncCaptures the most recent serial console data (up to a megabyte) for the specified instance.The `CaptureConsoleHistory` operation works with the other console history operations as described below.
1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the most recent console history. This call returns a `ConsoleHistory` object. The object will have a state of REQUESTED. 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with the identifier of the console history metadata. The state of the `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the metadata). 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata and the console history data.
- Specified by:
captureConsoleHistoryin interfaceComputeAsync- 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.
-
changeComputeCapacityReservationCompartment
public Future<ChangeComputeCapacityReservationCompartmentResponse> changeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest request, AsyncHandler<ChangeComputeCapacityReservationCompartmentRequest,ChangeComputeCapacityReservationCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute capacity reservation into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeCapacityReservationCompartmentin interfaceComputeAsync- 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.
-
changeComputeCapacityTopologyCompartment
public Future<ChangeComputeCapacityTopologyCompartmentResponse> changeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest request, AsyncHandler<ChangeComputeCapacityTopologyCompartmentRequest,ChangeComputeCapacityTopologyCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute capacity topology into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeCapacityTopologyCompartmentin interfaceComputeAsync- 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.
-
changeComputeClusterCompartment
public Future<ChangeComputeClusterCompartmentResponse> changeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest request, AsyncHandler<ChangeComputeClusterCompartmentRequest,ChangeComputeClusterCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute cluster into a different compartment within the same tenancy.A compute cluster is a remote direct memory access (RDMA) network group.
For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
- Specified by:
changeComputeClusterCompartmentin interfaceComputeAsync- 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.
-
changeComputeGpuMemoryClusterCompartment
public Future<ChangeComputeGpuMemoryClusterCompartmentResponse> changeComputeGpuMemoryClusterCompartment(ChangeComputeGpuMemoryClusterCompartmentRequest request, AsyncHandler<ChangeComputeGpuMemoryClusterCompartmentRequest,ChangeComputeGpuMemoryClusterCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute GPU memory cluster into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeGpuMemoryClusterCompartmentin interfaceComputeAsync- 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.
-
changeComputeGpuMemoryFabricCompartment
public Future<ChangeComputeGpuMemoryFabricCompartmentResponse> changeComputeGpuMemoryFabricCompartment(ChangeComputeGpuMemoryFabricCompartmentRequest request, AsyncHandler<ChangeComputeGpuMemoryFabricCompartmentRequest,ChangeComputeGpuMemoryFabricCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute GPU memory fabric into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeGpuMemoryFabricCompartmentin interfaceComputeAsync- 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.
-
changeComputeHostCompartment
public Future<ChangeComputeHostCompartmentResponse> changeComputeHostCompartment(ChangeComputeHostCompartmentRequest request, AsyncHandler<ChangeComputeHostCompartmentRequest,ChangeComputeHostCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute host into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeHostCompartmentin interfaceComputeAsync- 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.
-
changeComputeHostGroupCompartment
public Future<ChangeComputeHostGroupCompartmentResponse> changeComputeHostGroupCompartment(ChangeComputeHostGroupCompartmentRequest request, AsyncHandler<ChangeComputeHostGroupCompartmentRequest,ChangeComputeHostGroupCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute host group into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeHostGroupCompartmentin interfaceComputeAsync- 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.
-
changeComputeImageCapabilitySchemaCompartment
public Future<ChangeComputeImageCapabilitySchemaCompartmentResponse> changeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest request, AsyncHandler<ChangeComputeImageCapabilitySchemaCompartmentRequest,ChangeComputeImageCapabilitySchemaCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a compute image capability schema into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeImageCapabilitySchemaCompartmentin interfaceComputeAsync- 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.
-
changeDedicatedVmHostCompartment
public Future<ChangeDedicatedVmHostCompartmentResponse> changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request, AsyncHandler<ChangeDedicatedVmHostCompartmentRequest,ChangeDedicatedVmHostCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves a dedicated virtual machine host from one compartment to another.- Specified by:
changeDedicatedVmHostCompartmentin interfaceComputeAsync- 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.
-
changeImageCompartment
public Future<ChangeImageCompartmentResponse> changeImageCompartment(ChangeImageCompartmentRequest request, AsyncHandler<ChangeImageCompartmentRequest,ChangeImageCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves an image into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeImageCompartmentin interfaceComputeAsync- 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.
-
changeInstanceCompartment
public Future<ChangeInstanceCompartmentResponse> changeInstanceCompartment(ChangeInstanceCompartmentRequest request, AsyncHandler<ChangeInstanceCompartmentRequest,ChangeInstanceCompartmentResponse> handler)
Description copied from interface:ComputeAsyncMoves an instance into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.
- Specified by:
changeInstanceCompartmentin interfaceComputeAsync- 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.
-
createAppCatalogSubscription
public Future<CreateAppCatalogSubscriptionResponse> createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request, AsyncHandler<CreateAppCatalogSubscriptionRequest,CreateAppCatalogSubscriptionResponse> handler)
Description copied from interface:ComputeAsyncCreate a subscription for listing resource version for a compartment.It will take some time to propagate to all regions.
- Specified by:
createAppCatalogSubscriptionin interfaceComputeAsync- 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.
-
createComputeCapacityReport
public Future<CreateComputeCapacityReportResponse> createComputeCapacityReport(CreateComputeCapacityReportRequest request, AsyncHandler<CreateComputeCapacityReportRequest,CreateComputeCapacityReportResponse> handler)
Description copied from interface:ComputeAsyncGenerates a report of the host capacity within an availability domain that is available for you to create compute instances.Host capacity is the physical infrastructure that resources such as compute instances run on.
Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.
- Specified by:
createComputeCapacityReportin interfaceComputeAsync- 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.
-
createComputeCapacityReservation
public Future<CreateComputeCapacityReservationResponse> createComputeCapacityReservation(CreateComputeCapacityReservationRequest request, AsyncHandler<CreateComputeCapacityReservationRequest,CreateComputeCapacityReservationResponse> handler)
Description copied from interface:ComputeAsyncCreates a new compute capacity reservation in the specified compartment and availability domain.Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won’t get out of capacity errors. For more information, see Reserved Capacity.
- Specified by:
createComputeCapacityReservationin interfaceComputeAsync- 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.
-
createComputeCapacityTopology
public Future<CreateComputeCapacityTopologyResponse> createComputeCapacityTopology(CreateComputeCapacityTopologyRequest request, AsyncHandler<CreateComputeCapacityTopologyRequest,CreateComputeCapacityTopologyResponse> handler)
Description copied from interface:ComputeAsyncCreates a new compute capacity topology in the specified compartment and availability domain.Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch instances on your bare metal hosts with targeted network locations.
Compute capacity topologies report the health status of your bare metal hosts.
- Specified by:
createComputeCapacityTopologyin interfaceComputeAsync- 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.
-
createComputeCluster
public Future<CreateComputeClusterResponse> createComputeCluster(CreateComputeClusterRequest request, AsyncHandler<CreateComputeClusterRequest,CreateComputeClusterResponse> handler)
Description copied from interface:ComputeAsyncCreates an empty compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
After the compute cluster is created, you can use the compute cluster's OCID with the
launchInstanceoperation to create instances in the compute cluster. The instances must be created in the same compartment and availability domain as the cluster.Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group.
If you want predictable capacity for a specific number of identical instances that are managed as a group, create a cluster network that uses instance pools by using the
createClusterNetworkoperation.- Specified by:
createComputeClusterin interfaceComputeAsync- 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.
-
createComputeGpuMemoryCluster
public Future<CreateComputeGpuMemoryClusterResponse> createComputeGpuMemoryCluster(CreateComputeGpuMemoryClusterRequest request, AsyncHandler<CreateComputeGpuMemoryClusterRequest,CreateComputeGpuMemoryClusterResponse> handler)
Description copied from interface:ComputeAsyncCreate a compute GPU memory cluster instance on a specific compute GPU memory fabric- Specified by:
createComputeGpuMemoryClusterin interfaceComputeAsync- 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.
-
createComputeHostGroup
public Future<CreateComputeHostGroupResponse> createComputeHostGroup(CreateComputeHostGroupRequest request, AsyncHandler<CreateComputeHostGroupRequest,CreateComputeHostGroupResponse> handler)
Description copied from interface:ComputeAsyncCreates a new compute host group in the specified compartment and availability domain.- Specified by:
createComputeHostGroupin interfaceComputeAsync- 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.
-
createComputeImageCapabilitySchema
public Future<CreateComputeImageCapabilitySchemaResponse> createComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest request, AsyncHandler<CreateComputeImageCapabilitySchemaRequest,CreateComputeImageCapabilitySchemaResponse> handler)
Description copied from interface:ComputeAsyncCreates compute image capability schema.- Specified by:
createComputeImageCapabilitySchemain interfaceComputeAsync- 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.
-
createDedicatedVmHost
public Future<CreateDedicatedVmHostResponse> createDedicatedVmHost(CreateDedicatedVmHostRequest request, AsyncHandler<CreateDedicatedVmHostRequest,CreateDedicatedVmHostResponse> handler)
Description copied from interface:ComputeAsyncCreates a new dedicated virtual machine host in the specified compartment and the specified availability domain.Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers that are a single tenant and not shared with other customers. For more information, see Dedicated Virtual Machine Hosts.
- Specified by:
createDedicatedVmHostin interfaceComputeAsync- 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.
-
createImage
public Future<CreateImageResponse> createImage(CreateImageRequest request, AsyncHandler<CreateImageRequest,CreateImageResponse> handler)
Description copied from interface:ComputeAsyncCreates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see [Managing Custom Images](https://docs.oracle.com/iaas/Content/Compute/Tasks/managingcustomimages.htm).
When importing an exported image from Object Storage, you specify the source information in
imageSourceDetails.When importing an image based on the namespace, bucket name, and object name, use
imageSourceViaObjectStorageTupleDetails.When importing an image based on the Object Storage URL, use
imageSourceViaObjectStorageUriDetails. See [Object Storage URLs](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.For more information about importing exported images, see [Image Import/Export](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm).
You may optionally specify a *display name* for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See
updateImage. Avoid entering confidential information.- Specified by:
createImagein interfaceComputeAsync- 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.
-
createInstanceConsoleConnection
public Future<CreateInstanceConsoleConnectionResponse> createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request, AsyncHandler<CreateInstanceConsoleConnectionRequest,CreateInstanceConsoleConnectionResponse> handler)
Description copied from interface:ComputeAsyncCreates a new console connection to the specified instance.After the console connection has been created and is available, you connect to the console using SSH.
For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
- Specified by:
createInstanceConsoleConnectionin interfaceComputeAsync- 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.
-
deleteAppCatalogSubscription
public Future<DeleteAppCatalogSubscriptionResponse> deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request, AsyncHandler<DeleteAppCatalogSubscriptionRequest,DeleteAppCatalogSubscriptionResponse> handler)
Description copied from interface:ComputeAsyncDelete a subscription for a listing resource version for a compartment.- Specified by:
deleteAppCatalogSubscriptionin interfaceComputeAsync- 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.
-
deleteComputeCapacityReservation
public Future<DeleteComputeCapacityReservationResponse> deleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest request, AsyncHandler<DeleteComputeCapacityReservationRequest,DeleteComputeCapacityReservationResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified compute capacity reservation.- Specified by:
deleteComputeCapacityReservationin interfaceComputeAsync- 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.
-
deleteComputeCapacityTopology
public Future<DeleteComputeCapacityTopologyResponse> deleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest request, AsyncHandler<DeleteComputeCapacityTopologyRequest,DeleteComputeCapacityTopologyResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified compute capacity topology.- Specified by:
deleteComputeCapacityTopologyin interfaceComputeAsync- 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.
-
deleteComputeCluster
public Future<DeleteComputeClusterResponse> deleteComputeCluster(DeleteComputeClusterRequest request, AsyncHandler<DeleteComputeClusterRequest,DeleteComputeClusterResponse> handler)
Description copied from interface:ComputeAsyncDeletes a compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
Before you delete a compute cluster, first delete all instances in the cluster by using the
terminateInstanceoperation.- Specified by:
deleteComputeClusterin interfaceComputeAsync- 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.
-
deleteComputeGpuMemoryCluster
public Future<DeleteComputeGpuMemoryClusterResponse> deleteComputeGpuMemoryCluster(DeleteComputeGpuMemoryClusterRequest request, AsyncHandler<DeleteComputeGpuMemoryClusterRequest,DeleteComputeGpuMemoryClusterResponse> handler)
Description copied from interface:ComputeAsyncTerminates and deletes the specified compute GPU memory cluster and underlying instances.- Specified by:
deleteComputeGpuMemoryClusterin interfaceComputeAsync- 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.
-
deleteComputeHostGroup
public Future<DeleteComputeHostGroupResponse> deleteComputeHostGroup(DeleteComputeHostGroupRequest request, AsyncHandler<DeleteComputeHostGroupRequest,DeleteComputeHostGroupResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified compute host group- Specified by:
deleteComputeHostGroupin interfaceComputeAsync- 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.
-
deleteComputeImageCapabilitySchema
public Future<DeleteComputeImageCapabilitySchemaResponse> deleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest request, AsyncHandler<DeleteComputeImageCapabilitySchemaRequest,DeleteComputeImageCapabilitySchemaResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified Compute Image Capability Schema- Specified by:
deleteComputeImageCapabilitySchemain interfaceComputeAsync- 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.
-
deleteConsoleHistory
public Future<DeleteConsoleHistoryResponse> deleteConsoleHistory(DeleteConsoleHistoryRequest request, AsyncHandler<DeleteConsoleHistoryRequest,DeleteConsoleHistoryResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified console history metadata and the console history data.- Specified by:
deleteConsoleHistoryin interfaceComputeAsync- 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.
-
deleteDedicatedVmHost
public Future<DeleteDedicatedVmHostResponse> deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request, AsyncHandler<DeleteDedicatedVmHostRequest,DeleteDedicatedVmHostResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified dedicated virtual machine host.If any VM instances are assigned to the dedicated virtual machine host, the delete operation will fail and the service will return a 409 response code.
- Specified by:
deleteDedicatedVmHostin interfaceComputeAsync- 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.
-
deleteImage
public Future<DeleteImageResponse> deleteImage(DeleteImageRequest request, AsyncHandler<DeleteImageRequest,DeleteImageResponse> handler)
Description copied from interface:ComputeAsyncDeletes an image.- Specified by:
deleteImagein interfaceComputeAsync- 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.
-
deleteInstanceConsoleConnection
public Future<DeleteInstanceConsoleConnectionResponse> deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request, AsyncHandler<DeleteInstanceConsoleConnectionRequest,DeleteInstanceConsoleConnectionResponse> handler)
Description copied from interface:ComputeAsyncDeletes the specified instance console connection.- Specified by:
deleteInstanceConsoleConnectionin interfaceComputeAsync- 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.
-
detachBootVolume
public Future<DetachBootVolumeResponse> detachBootVolume(DetachBootVolumeRequest request, AsyncHandler<DetachBootVolumeRequest,DetachBootVolumeResponse> handler)
Description copied from interface:ComputeAsyncDetaches a boot volume from an instance.You must specify the OCID of the boot volume attachment.
This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.
- Specified by:
detachBootVolumein interfaceComputeAsync- 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.
-
detachComputeHostGroupHost
public Future<DetachComputeHostGroupHostResponse> detachComputeHostGroupHost(DetachComputeHostGroupHostRequest request, AsyncHandler<DetachComputeHostGroupHostRequest,DetachComputeHostGroupHostResponse> handler)
Description copied from interface:ComputeAsyncDetaches the specified bare metal host from the compute host group- Specified by:
detachComputeHostGroupHostin interfaceComputeAsync- 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.
-
detachVnic
public Future<DetachVnicResponse> detachVnic(DetachVnicRequest request, AsyncHandler<DetachVnicRequest,DetachVnicResponse> handler)
Description copied from interface:ComputeAsyncDetaches and deletes the specified secondary VNIC.This operation cannot be used on the instance’s primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted.
*Important:** If the VNIC has a
PrivateIpthat is the [target of a route rule](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.- Specified by:
detachVnicin interfaceComputeAsync- 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.
-
detachVolume
public Future<DetachVolumeResponse> detachVolume(DetachVolumeRequest request, AsyncHandler<DetachVolumeRequest,DetachVolumeResponse> handler)
Description copied from interface:ComputeAsyncDetaches a storage volume from an instance.You must specify the OCID of the volume attachment.
This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.
- Specified by:
detachVolumein interfaceComputeAsync- 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.
-
exportImage
public Future<ExportImageResponse> exportImage(ExportImageRequest request, AsyncHandler<ExportImageRequest,ExportImageResponse> handler)
Description copied from interface:ComputeAsyncExports the specified image to the Oracle Cloud Infrastructure Object Storage service.You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to.
For more information about exporting images, see [Image Import/Export](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm).
To perform an image export, you need write access to the Object Storage bucket for the image, see [Let Users Write Objects to Object Storage Buckets](https://docs.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.
- Specified by:
exportImagein interfaceComputeAsync- 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.
-
getAppCatalogListing
public Future<GetAppCatalogListingResponse> getAppCatalogListing(GetAppCatalogListingRequest request, AsyncHandler<GetAppCatalogListingRequest,GetAppCatalogListingResponse> handler)
Description copied from interface:ComputeAsyncGets the specified listing.- Specified by:
getAppCatalogListingin interfaceComputeAsync- 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.
-
getAppCatalogListingAgreements
public Future<GetAppCatalogListingAgreementsResponse> getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request, AsyncHandler<GetAppCatalogListingAgreementsRequest,GetAppCatalogListingAgreementsResponse> handler)
Description copied from interface:ComputeAsyncRetrieves the agreements for a particular resource version of a listing.- Specified by:
getAppCatalogListingAgreementsin interfaceComputeAsync- 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.
-
getAppCatalogListingResourceVersion
public Future<GetAppCatalogListingResourceVersionResponse> getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request, AsyncHandler<GetAppCatalogListingResourceVersionRequest,GetAppCatalogListingResourceVersionResponse> handler)
Description copied from interface:ComputeAsyncGets the specified listing resource version.- Specified by:
getAppCatalogListingResourceVersionin interfaceComputeAsync- 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.
-
getBootVolumeAttachment
public Future<GetBootVolumeAttachmentResponse> getBootVolumeAttachment(GetBootVolumeAttachmentRequest request, AsyncHandler<GetBootVolumeAttachmentRequest,GetBootVolumeAttachmentResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified boot volume attachment.- Specified by:
getBootVolumeAttachmentin interfaceComputeAsync- 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.
-
getComputeCapacityReservation
public Future<GetComputeCapacityReservationResponse> getComputeCapacityReservation(GetComputeCapacityReservationRequest request, AsyncHandler<GetComputeCapacityReservationRequest,GetComputeCapacityReservationResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute capacity reservation.- Specified by:
getComputeCapacityReservationin interfaceComputeAsync- 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.
-
getComputeCapacityTopology
public Future<GetComputeCapacityTopologyResponse> getComputeCapacityTopology(GetComputeCapacityTopologyRequest request, AsyncHandler<GetComputeCapacityTopologyRequest,GetComputeCapacityTopologyResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute capacity topology.- Specified by:
getComputeCapacityTopologyin interfaceComputeAsync- 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.
-
getComputeCluster
public Future<GetComputeClusterResponse> getComputeCluster(GetComputeClusterRequest request, AsyncHandler<GetComputeClusterRequest,GetComputeClusterResponse> handler)
Description copied from interface:ComputeAsyncGets information about a compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
- Specified by:
getComputeClusterin interfaceComputeAsync- 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.
-
getComputeGlobalImageCapabilitySchema
public Future<GetComputeGlobalImageCapabilitySchemaResponse> getComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest request, AsyncHandler<GetComputeGlobalImageCapabilitySchemaRequest,GetComputeGlobalImageCapabilitySchemaResponse> handler)
Description copied from interface:ComputeAsyncGets the specified Compute Global Image Capability Schema- Specified by:
getComputeGlobalImageCapabilitySchemain interfaceComputeAsync- 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.
-
getComputeGlobalImageCapabilitySchemaVersion
public Future<GetComputeGlobalImageCapabilitySchemaVersionResponse> getComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest request, AsyncHandler<GetComputeGlobalImageCapabilitySchemaVersionRequest,GetComputeGlobalImageCapabilitySchemaVersionResponse> handler)
Description copied from interface:ComputeAsyncGets the specified Compute Global Image Capability Schema Version- Specified by:
getComputeGlobalImageCapabilitySchemaVersionin interfaceComputeAsync- 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.
-
getComputeGpuMemoryCluster
public Future<GetComputeGpuMemoryClusterResponse> getComputeGpuMemoryCluster(GetComputeGpuMemoryClusterRequest request, AsyncHandler<GetComputeGpuMemoryClusterRequest,GetComputeGpuMemoryClusterResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute GPU memory cluster- Specified by:
getComputeGpuMemoryClusterin interfaceComputeAsync- 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.
-
getComputeGpuMemoryFabric
public Future<GetComputeGpuMemoryFabricResponse> getComputeGpuMemoryFabric(GetComputeGpuMemoryFabricRequest request, AsyncHandler<GetComputeGpuMemoryFabricRequest,GetComputeGpuMemoryFabricResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute GPU memory fabric- Specified by:
getComputeGpuMemoryFabricin interfaceComputeAsync- 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.
-
getComputeHost
public Future<GetComputeHostResponse> getComputeHost(GetComputeHostRequest request, AsyncHandler<GetComputeHostRequest,GetComputeHostResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute host- Specified by:
getComputeHostin interfaceComputeAsync- 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.
-
getComputeHostGroup
public Future<GetComputeHostGroupResponse> getComputeHostGroup(GetComputeHostGroupRequest request, AsyncHandler<GetComputeHostGroupRequest,GetComputeHostGroupResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified compute host group- Specified by:
getComputeHostGroupin interfaceComputeAsync- 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.
-
getComputeImageCapabilitySchema
public Future<GetComputeImageCapabilitySchemaResponse> getComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest request, AsyncHandler<GetComputeImageCapabilitySchemaRequest,GetComputeImageCapabilitySchemaResponse> handler)
Description copied from interface:ComputeAsyncGets the specified Compute Image Capability Schema- Specified by:
getComputeImageCapabilitySchemain interfaceComputeAsync- 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.
-
getConsoleHistory
public Future<GetConsoleHistoryResponse> getConsoleHistory(GetConsoleHistoryRequest request, AsyncHandler<GetConsoleHistoryRequest,GetConsoleHistoryResponse> handler)
Description copied from interface:ComputeAsyncShows the metadata for the specified console history.See
captureConsoleHistoryfor details about using the console history operations.- Specified by:
getConsoleHistoryin interfaceComputeAsync- 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.
-
getConsoleHistoryContent
public Future<GetConsoleHistoryContentResponse> getConsoleHistoryContent(GetConsoleHistoryContentRequest request, AsyncHandler<GetConsoleHistoryContentRequest,GetConsoleHistoryContentResponse> handler)
Description copied from interface:ComputeAsyncGets the actual console history data (not the metadata).See
captureConsoleHistoryfor details about using the console history operations.- Specified by:
getConsoleHistoryContentin interfaceComputeAsync- 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.
-
getDedicatedVmHost
public Future<GetDedicatedVmHostResponse> getDedicatedVmHost(GetDedicatedVmHostRequest request, AsyncHandler<GetDedicatedVmHostRequest,GetDedicatedVmHostResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified dedicated virtual machine host.- Specified by:
getDedicatedVmHostin interfaceComputeAsync- 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.
-
getImage
public Future<GetImageResponse> getImage(GetImageRequest request, AsyncHandler<GetImageRequest,GetImageResponse> handler)
Description copied from interface:ComputeAsyncGets the specified image.- Specified by:
getImagein interfaceComputeAsync- 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.
-
getImageShapeCompatibilityEntry
public Future<GetImageShapeCompatibilityEntryResponse> getImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest request, AsyncHandler<GetImageShapeCompatibilityEntryRequest,GetImageShapeCompatibilityEntryResponse> handler)
Description copied from interface:ComputeAsyncRetrieves an image shape compatibility entry.- Specified by:
getImageShapeCompatibilityEntryin interfaceComputeAsync- 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.
-
getInstance
public Future<GetInstanceResponse> getInstance(GetInstanceRequest request, AsyncHandler<GetInstanceRequest,GetInstanceResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified instance.*Note:** To retrieve public and private IP addresses for an instance, use the
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.- Specified by:
getInstancein interfaceComputeAsync- 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.
-
getInstanceConsoleConnection
public Future<GetInstanceConsoleConnectionResponse> getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request, AsyncHandler<GetInstanceConsoleConnectionRequest,GetInstanceConsoleConnectionResponse> handler)
Description copied from interface:ComputeAsyncGets the specified instance console connection’s information.- Specified by:
getInstanceConsoleConnectionin interfaceComputeAsync- 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.
-
getInstanceMaintenanceEvent
public Future<GetInstanceMaintenanceEventResponse> getInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest request, AsyncHandler<GetInstanceMaintenanceEventRequest,GetInstanceMaintenanceEventResponse> handler)
Description copied from interface:ComputeAsyncGets the maintenance event for the given instance.- Specified by:
getInstanceMaintenanceEventin interfaceComputeAsync- 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.
-
getInstanceMaintenanceReboot
public Future<GetInstanceMaintenanceRebootResponse> getInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest request, AsyncHandler<GetInstanceMaintenanceRebootRequest,GetInstanceMaintenanceRebootResponse> handler)
Description copied from interface:ComputeAsyncGets the maximum possible date that a maintenance reboot can be extended.For more information, see Infrastructure Maintenance.
- Specified by:
getInstanceMaintenanceRebootin interfaceComputeAsync- 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.
-
getMeasuredBootReport
public Future<GetMeasuredBootReportResponse> getMeasuredBootReport(GetMeasuredBootReportRequest request, AsyncHandler<GetMeasuredBootReportRequest,GetMeasuredBootReportResponse> handler)
Description copied from interface:ComputeAsyncGets the measured boot report for this shielded instance.- Specified by:
getMeasuredBootReportin interfaceComputeAsync- 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.
-
getVnicAttachment
public Future<GetVnicAttachmentResponse> getVnicAttachment(GetVnicAttachmentRequest request, AsyncHandler<GetVnicAttachmentRequest,GetVnicAttachmentResponse> handler)
Description copied from interface:ComputeAsyncGets the information for the specified VNIC attachment.- Specified by:
getVnicAttachmentin interfaceComputeAsync- 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.
-
getVolumeAttachment
public Future<GetVolumeAttachmentResponse> getVolumeAttachment(GetVolumeAttachmentRequest request, AsyncHandler<GetVolumeAttachmentRequest,GetVolumeAttachmentResponse> handler)
Description copied from interface:ComputeAsyncGets information about the specified volume attachment.- Specified by:
getVolumeAttachmentin interfaceComputeAsync- 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.
-
getWindowsInstanceInitialCredentials
public Future<GetWindowsInstanceInitialCredentialsResponse> getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request, AsyncHandler<GetWindowsInstanceInitialCredentialsRequest,GetWindowsInstanceInitialCredentialsResponse> handler)
Description copied from interface:ComputeAsyncGets the generated credentials for the instance.Only works for instances that require a password to log in, such as Windows. For certain operating systems, users will be forced to change the initial credentials.
- Specified by:
getWindowsInstanceInitialCredentialsin interfaceComputeAsync- 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.
-
instanceAction
public Future<InstanceActionResponse> instanceAction(InstanceActionRequest request, AsyncHandler<InstanceActionRequest,InstanceActionResponse> handler)
Description copied from interface:ComputeAsyncPerforms one of the following power actions on the specified instance:- **START** - Powers on the instance.
- **STOP** - Powers off the instance.
- **RESET** - Powers off the instance and then powers it back on.
- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.
- **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.
- **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Caution: Sending a diagnostic interrupt to a live system can cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see [Sending a Diagnostic Interrupt](https://docs.oracle.com/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm).
- **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on. Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured correctly, and try other [troubleshooting steps](https://docs.oracle.com/iaas/Content/Compute/References/troubleshooting-compute-instances.htm). Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. For more information, see [Performing a Diagnostic Reboot](https://docs.oracle.com/iaas/Content/Compute/Tasks/diagnostic-reboot.htm).
- **REBOOTMIGRATE** - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see [Infrastructure Maintenance](https://docs.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm).
For more information about managing instance lifecycle states, see [Stopping and Starting an Instance](https://docs.oracle.com/iaas/Content/Compute/Tasks/restartinginstance.htm).
- Specified by:
instanceActionin interfaceComputeAsync- 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.
-
launchInstance
public Future<LaunchInstanceResponse> launchInstance(LaunchInstanceRequest request, AsyncHandler<LaunchInstanceRequest,LaunchInstanceResponse> handler)
Description copied from interface:ComputeAsyncCreates a new instance in the specified compartment and the specified availability domain.For general information about instances, see Overview of the Compute Service.
For information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
To launch an instance using an image or a boot volume use the `sourceDetails` parameter in
LaunchInstanceDetails.When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the *primary VNIC*. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.You can later add secondary VNICs to an instance. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the
getAppCatalogListingAgreementsoperation to get the signature for the terms of use agreement for the desired listing resource version. Then, callcreateAppCatalogSubscriptionwith the signature. To get the image ID for the LaunchInstance operation, callgetAppCatalogListingResourceVersion.When launching an instance, you may provide the `securityAttributes` parameter in
LaunchInstanceDetailsto manage security attributes via the instance, or in the embeddedCreateVnicDetailsto manage security attributes via the VNIC directly, but not both. Providing `securityAttributes` in both locations will return a 400 Bad Request response.To determine whether capacity is available for a specific shape before you create an instance, use the
createComputeCapacityReportoperation.- Specified by:
launchInstancein interfaceComputeAsync- 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.
-
listAppCatalogListingResourceVersions
public Future<ListAppCatalogListingResourceVersionsResponse> listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request, AsyncHandler<ListAppCatalogListingResourceVersionsRequest,ListAppCatalogListingResourceVersionsResponse> handler)
Description copied from interface:ComputeAsyncGets all resource versions for a particular listing.- Specified by:
listAppCatalogListingResourceVersionsin interfaceComputeAsync- 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.
-
listAppCatalogListings
public Future<ListAppCatalogListingsResponse> listAppCatalogListings(ListAppCatalogListingsRequest request, AsyncHandler<ListAppCatalogListingsRequest,ListAppCatalogListingsResponse> handler)
Description copied from interface:ComputeAsyncLists the published listings.- Specified by:
listAppCatalogListingsin interfaceComputeAsync- 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.
-
listAppCatalogSubscriptions
public Future<ListAppCatalogSubscriptionsResponse> listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request, AsyncHandler<ListAppCatalogSubscriptionsRequest,ListAppCatalogSubscriptionsResponse> handler)
Description copied from interface:ComputeAsyncLists subscriptions for a compartment.- Specified by:
listAppCatalogSubscriptionsin interfaceComputeAsync- 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.
-
listBootVolumeAttachments
public Future<ListBootVolumeAttachmentsResponse> listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request, AsyncHandler<ListBootVolumeAttachmentsRequest,ListBootVolumeAttachmentsResponse> handler)
Description copied from interface:ComputeAsyncLists the boot volume attachments in the specified compartment.You can filter the list by specifying an instance OCID, boot volume OCID, or both.
- Specified by:
listBootVolumeAttachmentsin interfaceComputeAsync- 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.
-
listComputeCapacityReservationInstanceShapes
public Future<ListComputeCapacityReservationInstanceShapesResponse> listComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest request, AsyncHandler<ListComputeCapacityReservationInstanceShapesRequest,ListComputeCapacityReservationInstanceShapesResponse> handler)
Description copied from interface:ComputeAsyncLists the shapes that can be reserved within the specified compartment.- Specified by:
listComputeCapacityReservationInstanceShapesin interfaceComputeAsync- 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.
-
listComputeCapacityReservationInstances
public Future<ListComputeCapacityReservationInstancesResponse> listComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest request, AsyncHandler<ListComputeCapacityReservationInstancesRequest,ListComputeCapacityReservationInstancesResponse> handler)
Description copied from interface:ComputeAsyncLists the instances launched under a capacity reservation.You can filter results by specifying criteria.
- Specified by:
listComputeCapacityReservationInstancesin interfaceComputeAsync- 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.
-
listComputeCapacityReservations
public Future<ListComputeCapacityReservationsResponse> listComputeCapacityReservations(ListComputeCapacityReservationsRequest request, AsyncHandler<ListComputeCapacityReservationsRequest,ListComputeCapacityReservationsResponse> handler)
Description copied from interface:ComputeAsyncLists the compute capacity reservations that match the specified criteria and compartment.You can limit the list by specifying a compute capacity reservation display name (the list will include all the identically-named compute capacity reservations in the compartment).
- Specified by:
listComputeCapacityReservationsin interfaceComputeAsync- 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.
-
listComputeCapacityTopologies
public Future<ListComputeCapacityTopologiesResponse> listComputeCapacityTopologies(ListComputeCapacityTopologiesRequest request, AsyncHandler<ListComputeCapacityTopologiesRequest,ListComputeCapacityTopologiesResponse> handler)
Description copied from interface:ComputeAsyncLists the compute capacity topologies in the specified compartment.You can filter the list by a compute capacity topology display name.
- Specified by:
listComputeCapacityTopologiesin interfaceComputeAsync- 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.
-
listComputeCapacityTopologyComputeBareMetalHosts
public Future<ListComputeCapacityTopologyComputeBareMetalHostsResponse> listComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest request, AsyncHandler<ListComputeCapacityTopologyComputeBareMetalHostsRequest,ListComputeCapacityTopologyComputeBareMetalHostsResponse> handler)
Description copied from interface:ComputeAsyncLists compute bare metal hosts in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeBareMetalHostsin interfaceComputeAsync- 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.
-
listComputeCapacityTopologyComputeHpcIslands
public Future<ListComputeCapacityTopologyComputeHpcIslandsResponse> listComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest request, AsyncHandler<ListComputeCapacityTopologyComputeHpcIslandsRequest,ListComputeCapacityTopologyComputeHpcIslandsResponse> handler)
Description copied from interface:ComputeAsyncLists compute HPC islands in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeHpcIslandsin interfaceComputeAsync- 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.
-
listComputeCapacityTopologyComputeNetworkBlocks
public Future<ListComputeCapacityTopologyComputeNetworkBlocksResponse> listComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest request, AsyncHandler<ListComputeCapacityTopologyComputeNetworkBlocksRequest,ListComputeCapacityTopologyComputeNetworkBlocksResponse> handler)
Description copied from interface:ComputeAsyncLists compute network blocks in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeNetworkBlocksin interfaceComputeAsync- 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.
-
listComputeClusters
public Future<ListComputeClustersResponse> listComputeClusters(ListComputeClustersRequest request, AsyncHandler<ListComputeClustersRequest,ListComputeClustersResponse> handler)
Description copied from interface:ComputeAsyncLists the compute clusters in the specified compartment.A compute cluster is a remote direct memory access (RDMA) network group.
- Specified by:
listComputeClustersin interfaceComputeAsync- 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.
-
listComputeGlobalImageCapabilitySchemaVersions
public Future<ListComputeGlobalImageCapabilitySchemaVersionsResponse> listComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest request, AsyncHandler<ListComputeGlobalImageCapabilitySchemaVersionsRequest,ListComputeGlobalImageCapabilitySchemaVersionsResponse> handler)
Description copied from interface:ComputeAsyncLists Compute Global Image Capability Schema versions in the specified compartment.- Specified by:
listComputeGlobalImageCapabilitySchemaVersionsin interfaceComputeAsync- 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.
-
listComputeGlobalImageCapabilitySchemas
public Future<ListComputeGlobalImageCapabilitySchemasResponse> listComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest request, AsyncHandler<ListComputeGlobalImageCapabilitySchemasRequest,ListComputeGlobalImageCapabilitySchemasResponse> handler)
Description copied from interface:ComputeAsyncLists Compute Global Image Capability Schema in the specified compartment.- Specified by:
listComputeGlobalImageCapabilitySchemasin interfaceComputeAsync- 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.
-
listComputeGpuMemoryClusterInstances
public Future<ListComputeGpuMemoryClusterInstancesResponse> listComputeGpuMemoryClusterInstances(ListComputeGpuMemoryClusterInstancesRequest request, AsyncHandler<ListComputeGpuMemoryClusterInstancesRequest,ListComputeGpuMemoryClusterInstancesResponse> handler)
Description copied from interface:ComputeAsyncList all of the GPU memory cluster instances.- Specified by:
listComputeGpuMemoryClusterInstancesin interfaceComputeAsync- 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.
-
listComputeGpuMemoryClusters
public Future<ListComputeGpuMemoryClustersResponse> listComputeGpuMemoryClusters(ListComputeGpuMemoryClustersRequest request, AsyncHandler<ListComputeGpuMemoryClustersRequest,ListComputeGpuMemoryClustersResponse> handler)
Description copied from interface:ComputeAsyncList all of the compute GPU memory clusters.- Specified by:
listComputeGpuMemoryClustersin interfaceComputeAsync- 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.
-
listComputeGpuMemoryFabrics
public Future<ListComputeGpuMemoryFabricsResponse> listComputeGpuMemoryFabrics(ListComputeGpuMemoryFabricsRequest request, AsyncHandler<ListComputeGpuMemoryFabricsRequest,ListComputeGpuMemoryFabricsResponse> handler)
Description copied from interface:ComputeAsyncLists the compute GPU memory fabrics that match the specified criteria and compartmentId.- Specified by:
listComputeGpuMemoryFabricsin interfaceComputeAsync- 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.
-
listComputeHostGroups
public Future<ListComputeHostGroupsResponse> listComputeHostGroups(ListComputeHostGroupsRequest request, AsyncHandler<ListComputeHostGroupsRequest,ListComputeHostGroupsResponse> handler)
Description copied from interface:ComputeAsyncLists the compute host groups that match the specified criteria and compartment.- Specified by:
listComputeHostGroupsin interfaceComputeAsync- 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.
-
listComputeHosts
public Future<ListComputeHostsResponse> listComputeHosts(ListComputeHostsRequest request, AsyncHandler<ListComputeHostsRequest,ListComputeHostsResponse> handler)
Description copied from interface:ComputeAsyncGenerates a list of summary host details- Specified by:
listComputeHostsin interfaceComputeAsync- 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.
-
listComputeImageCapabilitySchemas
public Future<ListComputeImageCapabilitySchemasResponse> listComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest request, AsyncHandler<ListComputeImageCapabilitySchemasRequest,ListComputeImageCapabilitySchemasResponse> handler)
Description copied from interface:ComputeAsyncLists Compute Image Capability Schema in the specified compartment.You can also query by a specific imageId.
- Specified by:
listComputeImageCapabilitySchemasin interfaceComputeAsync- 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.
-
listConsoleHistories
public Future<ListConsoleHistoriesResponse> listConsoleHistories(ListConsoleHistoriesRequest request, AsyncHandler<ListConsoleHistoriesRequest,ListConsoleHistoriesResponse> handler)
Description copied from interface:ComputeAsyncLists the console history metadata for the specified compartment or instance.- Specified by:
listConsoleHistoriesin interfaceComputeAsync- 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.
-
listDedicatedVmHostInstanceShapes
public Future<ListDedicatedVmHostInstanceShapesResponse> listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request, AsyncHandler<ListDedicatedVmHostInstanceShapesRequest,ListDedicatedVmHostInstanceShapesResponse> handler)
Description copied from interface:ComputeAsyncLists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.You can filter the list by compatibility with a specific dedicated virtual machine host shape.
- Specified by:
listDedicatedVmHostInstanceShapesin interfaceComputeAsync- 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.
-
listDedicatedVmHostInstances
public Future<ListDedicatedVmHostInstancesResponse> listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request, AsyncHandler<ListDedicatedVmHostInstancesRequest,ListDedicatedVmHostInstancesResponse> handler)
Description copied from interface:ComputeAsyncReturns the list of instances on the dedicated virtual machine hosts that match the specified criteria.- Specified by:
listDedicatedVmHostInstancesin interfaceComputeAsync- 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.
-
listDedicatedVmHostShapes
public Future<ListDedicatedVmHostShapesResponse> listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request, AsyncHandler<ListDedicatedVmHostShapesRequest,ListDedicatedVmHostShapesResponse> handler)
Description copied from interface:ComputeAsyncLists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.- Specified by:
listDedicatedVmHostShapesin interfaceComputeAsync- 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.
-
listDedicatedVmHosts
public Future<ListDedicatedVmHostsResponse> listDedicatedVmHosts(ListDedicatedVmHostsRequest request, AsyncHandler<ListDedicatedVmHostsRequest,ListDedicatedVmHostsResponse> handler)
Description copied from interface:ComputeAsyncReturns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.
- Specified by:
listDedicatedVmHostsin interfaceComputeAsync- 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.
-
listImageShapeCompatibilityEntries
public Future<ListImageShapeCompatibilityEntriesResponse> listImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest request, AsyncHandler<ListImageShapeCompatibilityEntriesRequest,ListImageShapeCompatibilityEntriesResponse> handler)
Description copied from interface:ComputeAsyncLists the compatible shapes for the specified image.- Specified by:
listImageShapeCompatibilityEntriesin interfaceComputeAsync- 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.
-
listImages
public Future<ListImagesResponse> listImages(ListImagesRequest request, AsyncHandler<ListImagesRequest,ListImagesResponse> handler)
Description copied from interface:ComputeAsyncLists a subset of images available in the specified compartment, including platform images and custom images.The list of platform images includes the three most recently published versions of each major distribution. The list does not support filtering based on image tags.
The list of images returned is ordered to first show the recent platform images, then all of the custom images.
*Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.
- Specified by:
listImagesin interfaceComputeAsync- 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.
-
listInstanceConsoleConnections
public Future<ListInstanceConsoleConnectionsResponse> listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request, AsyncHandler<ListInstanceConsoleConnectionsRequest,ListInstanceConsoleConnectionsResponse> handler)
Description copied from interface:ComputeAsyncLists the console connections for the specified compartment or instance.For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
- Specified by:
listInstanceConsoleConnectionsin interfaceComputeAsync- 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.
-
listInstanceDevices
public Future<ListInstanceDevicesResponse> listInstanceDevices(ListInstanceDevicesRequest request, AsyncHandler<ListInstanceDevicesRequest,ListInstanceDevicesResponse> handler)
Description copied from interface:ComputeAsyncGets a list of all the devices for given instance.You can optionally filter results by device availability.
- Specified by:
listInstanceDevicesin interfaceComputeAsync- 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.
-
listInstanceMaintenanceEvents
public Future<ListInstanceMaintenanceEventsResponse> listInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest request, AsyncHandler<ListInstanceMaintenanceEventsRequest,ListInstanceMaintenanceEventsResponse> handler)
Description copied from interface:ComputeAsyncGets a list of all the maintenance events for the given compartment.- Specified by:
listInstanceMaintenanceEventsin interfaceComputeAsync- 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.
-
listInstances
public Future<ListInstancesResponse> listInstances(ListInstancesRequest request, AsyncHandler<ListInstancesRequest,ListInstancesResponse> handler)
Description copied from interface:ComputeAsyncLists the instances in the specified compartment and the specified availability domain.You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).
*Note:** To retrieve public and private IP addresses for an instance, use the
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.- Specified by:
listInstancesin interfaceComputeAsync- 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.
-
listShapes
public Future<ListShapesResponse> listShapes(ListShapesRequest request, AsyncHandler<ListShapesRequest,ListShapesResponse> handler)
Description copied from interface:ComputeAsyncLists the shapes that can be used to launch an instance within the specified compartment.You can filter the list by compatibility with a specific image.
- Specified by:
listShapesin interfaceComputeAsync- 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.
-
listVnicAttachments
public Future<ListVnicAttachmentsResponse> listVnicAttachments(ListVnicAttachmentsRequest request, AsyncHandler<ListVnicAttachmentsRequest,ListVnicAttachmentsResponse> handler)
Description copied from interface:ComputeAsyncLists the VNIC attachments in the specified compartment.A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.
- Specified by:
listVnicAttachmentsin interfaceComputeAsync- 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.
-
listVolumeAttachments
public Future<ListVolumeAttachmentsResponse> listVolumeAttachments(ListVolumeAttachmentsRequest request, AsyncHandler<ListVolumeAttachmentsRequest,ListVolumeAttachmentsResponse> handler)
Description copied from interface:ComputeAsyncLists the volume attachments in the specified compartment.You can filter the list by specifying an instance OCID, volume OCID, or both.
Currently, the only supported volume attachment type are
IScsiVolumeAttachmentandParavirtualizedVolumeAttachment.- Specified by:
listVolumeAttachmentsin interfaceComputeAsync- 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.
-
removeImageShapeCompatibilityEntry
public Future<RemoveImageShapeCompatibilityEntryResponse> removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request, AsyncHandler<RemoveImageShapeCompatibilityEntryRequest,RemoveImageShapeCompatibilityEntryResponse> handler)
Description copied from interface:ComputeAsyncRemoves a shape from the compatible shapes list for the image.- Specified by:
removeImageShapeCompatibilityEntryin interfaceComputeAsync- 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.
-
terminateInstance
public Future<TerminateInstanceResponse> terminateInstance(TerminateInstanceRequest request, AsyncHandler<TerminateInstanceRequest,TerminateInstanceResponse> handler)
Description copied from interface:ComputeAsyncPermanently terminates (deletes) the specified instance.Any attached VNICs and volumes are automatically detached when the instance terminates.
To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.
To preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveDataVolumesQueryParam`. To delete the data volumes when the instance itself is deleted, specify `false` for `PreserveDataVolumesQueryParam`.
This is an asynchronous operation. The instance's `lifecycleState` changes to TERMINATING temporarily until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances with the state TERMINATED for at least 12 hours, but no further action is needed.
- Specified by:
terminateInstancein interfaceComputeAsync- 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.
-
updateComputeCapacityReservation
public Future<UpdateComputeCapacityReservationResponse> updateComputeCapacityReservation(UpdateComputeCapacityReservationRequest request, AsyncHandler<UpdateComputeCapacityReservationRequest,UpdateComputeCapacityReservationResponse> handler)
Description copied from interface:ComputeAsyncUpdates the specified capacity reservation and its associated capacity configurations.Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. Avoid entering confidential information.
- Specified by:
updateComputeCapacityReservationin interfaceComputeAsync- 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.
-
updateComputeCapacityTopology
public Future<UpdateComputeCapacityTopologyResponse> updateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest request, AsyncHandler<UpdateComputeCapacityTopologyRequest,UpdateComputeCapacityTopologyResponse> handler)
Description copied from interface:ComputeAsyncUpdates the specified compute capacity topology.Fields that are not provided in the request will not be updated.
- Specified by:
updateComputeCapacityTopologyin interfaceComputeAsync- 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.
-
updateComputeCluster
public Future<UpdateComputeClusterResponse> updateComputeCluster(UpdateComputeClusterRequest request, AsyncHandler<UpdateComputeClusterRequest,UpdateComputeClusterResponse> handler)
Description copied from interface:ComputeAsyncUpdates a compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
To create instances within a compute cluster, use the
launchInstanceoperation.To delete instances from a compute cluster, use the
terminateInstanceoperation.- Specified by:
updateComputeClusterin interfaceComputeAsync- 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.
-
updateComputeGpuMemoryCluster
public Future<UpdateComputeGpuMemoryClusterResponse> updateComputeGpuMemoryCluster(UpdateComputeGpuMemoryClusterRequest request, AsyncHandler<UpdateComputeGpuMemoryClusterRequest,UpdateComputeGpuMemoryClusterResponse> handler)
Description copied from interface:ComputeAsyncUpdates a compute gpu memory cluster resource.- Specified by:
updateComputeGpuMemoryClusterin interfaceComputeAsync- 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.
-
updateComputeGpuMemoryFabric
public Future<UpdateComputeGpuMemoryFabricResponse> updateComputeGpuMemoryFabric(UpdateComputeGpuMemoryFabricRequest request, AsyncHandler<UpdateComputeGpuMemoryFabricRequest,UpdateComputeGpuMemoryFabricResponse> handler)
Description copied from interface:ComputeAsyncCustomer can update displayName, tags and for compute GPU memory fabric record- Specified by:
updateComputeGpuMemoryFabricin interfaceComputeAsync- 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.
-
updateComputeHost
public Future<UpdateComputeHostResponse> updateComputeHost(UpdateComputeHostRequest request, AsyncHandler<UpdateComputeHostRequest,UpdateComputeHostResponse> handler)
Description copied from interface:ComputeAsyncCustomer can update the some fields for ComputeHost record- Specified by:
updateComputeHostin interfaceComputeAsync- 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.
-
updateComputeHostGroup
public Future<UpdateComputeHostGroupResponse> updateComputeHostGroup(UpdateComputeHostGroupRequest request, AsyncHandler<UpdateComputeHostGroupRequest,UpdateComputeHostGroupResponse> handler)
Description copied from interface:ComputeAsyncUpdates the specified compute host group details.- Specified by:
updateComputeHostGroupin interfaceComputeAsync- 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.
-
updateComputeImageCapabilitySchema
public Future<UpdateComputeImageCapabilitySchemaResponse> updateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest request, AsyncHandler<UpdateComputeImageCapabilitySchemaRequest,UpdateComputeImageCapabilitySchemaResponse> handler)
Description copied from interface:ComputeAsyncUpdates the specified Compute Image Capability Schema- Specified by:
updateComputeImageCapabilitySchemain interfaceComputeAsync- 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.
-
updateConsoleHistory
public Future<UpdateConsoleHistoryResponse> updateConsoleHistory(UpdateConsoleHistoryRequest request, AsyncHandler<UpdateConsoleHistoryRequest,UpdateConsoleHistoryResponse> handler)
Description copied from interface:ComputeAsyncUpdates the specified console history metadata.- Specified by:
updateConsoleHistoryin interfaceComputeAsync- 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.
-
updateDedicatedVmHost
public Future<UpdateDedicatedVmHostResponse> updateDedicatedVmHost(UpdateDedicatedVmHostRequest request, AsyncHandler<UpdateDedicatedVmHostRequest,UpdateDedicatedVmHostResponse> handler)
Description copied from interface:ComputeAsyncUpdates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.If an attribute value is not included, it will not be updated.
- Specified by:
updateDedicatedVmHostin interfaceComputeAsync- 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.
-
updateImage
public Future<UpdateImageResponse> updateImage(UpdateImageRequest request, AsyncHandler<UpdateImageRequest,UpdateImageResponse> handler)
Description copied from interface:ComputeAsyncUpdates the display name of the image.Avoid entering confidential information.
- Specified by:
updateImagein interfaceComputeAsync- 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.
-
updateInstance
public Future<UpdateInstanceResponse> updateInstance(UpdateInstanceRequest request, AsyncHandler<UpdateInstanceRequest,UpdateInstanceResponse> handler)
Description copied from interface:ComputeAsyncUpdates certain fields on the specified instance.Fields that are not provided in the request will not be updated. Avoid entering confidential information.
Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute).
The OCID of the instance remains the same.
- Specified by:
updateInstancein interfaceComputeAsync- 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.
-
updateInstanceConsoleConnection
public Future<UpdateInstanceConsoleConnectionResponse> updateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest request, AsyncHandler<UpdateInstanceConsoleConnectionRequest,UpdateInstanceConsoleConnectionResponse> handler)
Description copied from interface:ComputeAsyncUpdates the defined tags and free-form tags for the specified instance console connection.- Specified by:
updateInstanceConsoleConnectionin interfaceComputeAsync- 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.
-
updateInstanceMaintenanceEvent
public Future<UpdateInstanceMaintenanceEventResponse> updateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest request, AsyncHandler<UpdateInstanceMaintenanceEventRequest,UpdateInstanceMaintenanceEventResponse> handler)
Description copied from interface:ComputeAsyncUpdates the maintenance event for the given instance.- Specified by:
updateInstanceMaintenanceEventin interfaceComputeAsync- 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.
-
updateVolumeAttachment
public Future<UpdateVolumeAttachmentResponse> updateVolumeAttachment(UpdateVolumeAttachmentRequest request, AsyncHandler<UpdateVolumeAttachmentRequest,UpdateVolumeAttachmentResponse> handler)
Description copied from interface:ComputeAsyncUpdates information about the specified volume attachment.- Specified by:
updateVolumeAttachmentin interfaceComputeAsync- 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
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)
-
-