@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface ComputeAsync extends AutoCloseable
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<AttachBootVolumeResponse> attachBootVolume(AttachBootVolumeRequest request, AsyncHandler<AttachBootVolumeRequest,AttachBootVolumeResponse> handler)
Attaches the specified boot volume to the specified instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachVnicResponse> attachVnic(AttachVnicRequest request, AsyncHandler<AttachVnicRequest,AttachVnicResponse> handler)
Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachVolumeResponse> attachVolume(AttachVolumeRequest request, AsyncHandler<AttachVolumeRequest,AttachVolumeResponse> handler)
Attaches the specified storage volume to the specified instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CaptureConsoleHistoryResponse> captureConsoleHistory(CaptureConsoleHistoryRequest request, AsyncHandler<CaptureConsoleHistoryRequest,CaptureConsoleHistoryResponse> handler)
Captures 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAppCatalogSubscriptionResponse> createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request, AsyncHandler<CreateAppCatalogSubscriptionRequest,CreateAppCatalogSubscriptionResponse> handler)
Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateImageResponse> createImage(CreateImageRequest request, AsyncHandler<CreateImageRequest,CreateImageResponse> handler)
Creates 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.
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 and Using Pre-Authenticated Requests for constructing URLs for image import/export.
For more information about importing exported images, see Image Import/Export.
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateInstanceConsoleConnectionResponse> createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request, AsyncHandler<CreateInstanceConsoleConnectionRequest,CreateInstanceConsoleConnectionResponse> handler)
Creates a new console connection to the specified instance. Once the console connection has been created and is available, you connect to the console using SSH.
For more information about console access, see Accessing the Console.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAppCatalogSubscriptionResponse> deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request, AsyncHandler<DeleteAppCatalogSubscriptionRequest,DeleteAppCatalogSubscriptionResponse> handler)
Delete a subscription for a listing resource version for a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteConsoleHistoryResponse> deleteConsoleHistory(DeleteConsoleHistoryRequest request, AsyncHandler<DeleteConsoleHistoryRequest,DeleteConsoleHistoryResponse> handler)
Deletes the specified console history metadata and the console history data.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteImageResponse> deleteImage(DeleteImageRequest request, AsyncHandler<DeleteImageRequest,DeleteImageResponse> handler)
Deletes an image.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteInstanceConsoleConnectionResponse> deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request, AsyncHandler<DeleteInstanceConsoleConnectionRequest,DeleteInstanceConsoleConnectionResponse> handler)
Deletes the specified instance console connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachBootVolumeResponse> detachBootVolume(DetachBootVolumeRequest request, AsyncHandler<DetachBootVolumeRequest,DetachBootVolumeResponse> handler)
Detaches 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachVnicResponse> detachVnic(DetachVnicRequest request, AsyncHandler<DetachVnicRequest,DetachVnicResponse> handler)
Detaches 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 PrivateIp
that is the target of a route rule, deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachVolumeResponse> detachVolume(DetachVolumeRequest request, AsyncHandler<DetachVolumeRequest,DetachVolumeResponse> handler)
Detaches 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ExportImageResponse> exportImage(ExportImageRequest request, AsyncHandler<ExportImageRequest,ExportImageResponse> handler)
Exports 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.
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.
See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAppCatalogListingResponse> getAppCatalogListing(GetAppCatalogListingRequest request, AsyncHandler<GetAppCatalogListingRequest,GetAppCatalogListingResponse> handler)
Gets the specified listing.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAppCatalogListingAgreementsResponse> getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request, AsyncHandler<GetAppCatalogListingAgreementsRequest,GetAppCatalogListingAgreementsResponse> handler)
Retrieves the agreements for a particular resource version of a listing.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAppCatalogListingResourceVersionResponse> getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request, AsyncHandler<GetAppCatalogListingResourceVersionRequest,GetAppCatalogListingResourceVersionResponse> handler)
Gets the specified listing resource version.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetBootVolumeAttachmentResponse> getBootVolumeAttachment(GetBootVolumeAttachmentRequest request, AsyncHandler<GetBootVolumeAttachmentRequest,GetBootVolumeAttachmentResponse> handler)
Gets information about the specified boot volume attachment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetConsoleHistoryResponse> getConsoleHistory(GetConsoleHistoryRequest request, AsyncHandler<GetConsoleHistoryRequest,GetConsoleHistoryResponse> handler)
Shows the metadata for the specified console history. See captureConsoleHistory
for details about using the console history operations.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetConsoleHistoryContentResponse> getConsoleHistoryContent(GetConsoleHistoryContentRequest request, AsyncHandler<GetConsoleHistoryContentRequest,GetConsoleHistoryContentResponse> handler)
Gets the actual console history data (not the metadata). See captureConsoleHistory
for details about using the console history operations.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetImageResponse> getImage(GetImageRequest request, AsyncHandler<GetImageRequest,GetImageResponse> handler)
Gets the specified image.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetInstanceResponse> getInstance(GetInstanceRequest request, AsyncHandler<GetInstanceRequest,GetInstanceResponse> handler)
Gets information about the specified instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetInstanceConsoleConnectionResponse> getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request, AsyncHandler<GetInstanceConsoleConnectionRequest,GetInstanceConsoleConnectionResponse> handler)
Gets the specified instance console connection’s information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetVnicAttachmentResponse> getVnicAttachment(GetVnicAttachmentRequest request, AsyncHandler<GetVnicAttachmentRequest,GetVnicAttachmentResponse> handler)
Gets the information for the specified VNIC attachment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetVolumeAttachmentResponse> getVolumeAttachment(GetVolumeAttachmentRequest request, AsyncHandler<GetVolumeAttachmentRequest,GetVolumeAttachmentResponse> handler)
Gets information about the specified volume attachment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWindowsInstanceInitialCredentialsResponse> getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request, AsyncHandler<GetWindowsInstanceInitialCredentialsRequest,GetWindowsInstanceInitialCredentialsResponse> handler)
Gets the generated credentials for the instance. Only works for instances that require password to log in (E.g. Windows). For certain OS’es, users will be forced to change the initial credentials.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstanceActionResponse> instanceAction(InstanceActionRequest request, AsyncHandler<InstanceActionRequest,InstanceActionResponse> handler)
Performs one of the following power actions on the specified instance:
- START - Powers on the instance.
- STOP - Powers off the instance.
- SOFTRESET - Gracefully reboots instance by sending a shutdown command to the operating system and then powers the instance back on.
- SOFTSTOP - Gracefully shuts down instance by sending a shutdown command to the operating system.
- RESET - Powers off the instance and then powers it back on.
For more information see Stopping and Starting an Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<LaunchInstanceResponse> launchInstance(LaunchInstanceRequest request, AsyncHandler<LaunchInstanceRequest,LaunchInstanceResponse> handler)
Creates 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.
For information about availability domains, see Regions and Availability Domains. 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 listVnicAttachments
operation to get the VNIC ID for the instance, and then call getVnic
with the VNIC ID.
You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAppCatalogListingResourceVersionsResponse> listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request, AsyncHandler<ListAppCatalogListingResourceVersionsRequest,ListAppCatalogListingResourceVersionsResponse> handler)
Gets all resource versions for a particular listing.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAppCatalogListingsResponse> listAppCatalogListings(ListAppCatalogListingsRequest request, AsyncHandler<ListAppCatalogListingsRequest,ListAppCatalogListingsResponse> handler)
Lists the published listings.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAppCatalogSubscriptionsResponse> listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request, AsyncHandler<ListAppCatalogSubscriptionsRequest,ListAppCatalogSubscriptionsResponse> handler)
Lists subscriptions for a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListBootVolumeAttachmentsResponse> listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request, AsyncHandler<ListBootVolumeAttachmentsRequest,ListBootVolumeAttachmentsResponse> handler)
Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListConsoleHistoriesResponse> listConsoleHistories(ListConsoleHistoriesRequest request, AsyncHandler<ListConsoleHistoriesRequest,ListConsoleHistoriesResponse> handler)
Lists the console history metadata for the specified compartment or instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListImagesResponse> listImages(ListImagesRequest request, AsyncHandler<ListImagesRequest,ListImagesResponse> handler)
Lists the available images in the specified compartment, including both Oracle-provided images and custom images that have been created. The list of images returned is ordered to first show all Oracle-provided images, then all custom images.
The order of images returned may change when new images are released.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListInstanceConsoleConnectionsResponse> listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request, AsyncHandler<ListInstanceConsoleConnectionsRequest,ListInstanceConsoleConnectionsResponse> handler)
Lists the console connections for the specified compartment or instance.
For more information about console access, see Accessing the Console.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListInstanceDevicesResponse> listInstanceDevices(ListInstanceDevicesRequest request, AsyncHandler<ListInstanceDevicesRequest,ListInstanceDevicesResponse> handler)
Gets a list of all the devices for given instance. You can optionally filter results by device availability.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListInstancesResponse> listInstances(ListInstancesRequest request, AsyncHandler<ListInstancesRequest,ListInstancesResponse> handler)
Lists 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).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListShapesResponse> listShapes(ListShapesRequest request, AsyncHandler<ListShapesRequest,ListShapesResponse> handler)
Lists 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListVnicAttachmentsResponse> listVnicAttachments(ListVnicAttachmentsRequest request, AsyncHandler<ListVnicAttachmentsRequest,ListVnicAttachmentsResponse> handler)
Lists 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListVolumeAttachmentsResponse> listVolumeAttachments(ListVolumeAttachmentsRequest request, AsyncHandler<ListVolumeAttachmentsRequest,ListVolumeAttachmentsResponse> handler)
Lists 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 IScsiVolumeAttachment
and ParavirtualizedVolumeAttachment
.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<TerminateInstanceResponse> terminateInstance(TerminateInstanceRequest request, AsyncHandler<TerminateInstanceRequest,TerminateInstanceResponse> handler)
Terminates 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
.
This is an asynchronous operation. The instance’s lifecycleState
will change to TERMINATING temporarily until the instance is completely removed.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateConsoleHistoryResponse> updateConsoleHistory(UpdateConsoleHistoryRequest request, AsyncHandler<UpdateConsoleHistoryRequest,UpdateConsoleHistoryResponse> handler)
Updates the specified console history metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateImageResponse> updateImage(UpdateImageRequest request, AsyncHandler<UpdateImageRequest,UpdateImageResponse> handler)
Updates the display name of the image. Avoid entering confidential information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateInstanceResponse> updateInstance(UpdateInstanceRequest request, AsyncHandler<UpdateInstanceRequest,UpdateInstanceResponse> handler)
Updates 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2019. All rights reserved.