Compute (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: ComputeClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface Compute
extends AutoCloseable

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AddImageShapeCompatibilityEntryResponse`	`addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)` Adds a shape to the compatible shapes list for the image.
`AttachBootVolumeResponse`	`attachBootVolume(AttachBootVolumeRequest request)` Attaches the specified boot volume to the specified instance.
`AttachVnicResponse`	`attachVnic(AttachVnicRequest request)` Creates a secondary VNIC and attaches it to the specified instance.
`AttachVolumeResponse`	`attachVolume(AttachVolumeRequest request)` Attaches the specified storage volume to the specified instance.
`CaptureConsoleHistoryResponse`	`captureConsoleHistory(CaptureConsoleHistoryRequest request)` Captures the most recent serial console data (up to a megabyte) for the specified instance.
`ChangeDedicatedVmHostCompartmentResponse`	`changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)` Moves a dedicated virtual machine host from one compartment to another.
`ChangeImageCompartmentResponse`	`changeImageCompartment(ChangeImageCompartmentRequest request)` Moves an image into a different compartment within the same tenancy.
`ChangeInstanceCompartmentResponse`	`changeInstanceCompartment(ChangeInstanceCompartmentRequest request)` Moves an instance into a different compartment within the same tenancy.
`CreateAppCatalogSubscriptionResponse`	`createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)` Create a subscription for listing resource version for a compartment.
`CreateDedicatedVmHostResponse`	`createDedicatedVmHost(CreateDedicatedVmHostRequest request)` Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.
`CreateImageResponse`	`createImage(CreateImageRequest request)` Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
`CreateInstanceConsoleConnectionResponse`	`createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request)` Creates a new console connection to the specified instance.
`DeleteAppCatalogSubscriptionResponse`	`deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)` Delete a subscription for a listing resource version for a compartment.
`DeleteConsoleHistoryResponse`	`deleteConsoleHistory(DeleteConsoleHistoryRequest request)` Deletes the specified console history metadata and the console history data.
`DeleteDedicatedVmHostResponse`	`deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request)` Deletes the specified dedicated virtual machine host.
`DeleteImageResponse`	`deleteImage(DeleteImageRequest request)` Deletes an image.
`DeleteInstanceConsoleConnectionResponse`	`deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)` Deletes the specified instance console connection.
`DetachBootVolumeResponse`	`detachBootVolume(DetachBootVolumeRequest request)` Detaches a boot volume from an instance.
`DetachVnicResponse`	`detachVnic(DetachVnicRequest request)` Detaches and deletes the specified secondary VNIC.
`DetachVolumeResponse`	`detachVolume(DetachVolumeRequest request)` Detaches a storage volume from an instance.
`ExportImageResponse`	`exportImage(ExportImageRequest request)` Exports the specified image to the Oracle Cloud Infrastructure Object Storage service.
`GetAppCatalogListingResponse`	`getAppCatalogListing(GetAppCatalogListingRequest request)` Gets the specified listing.
`GetAppCatalogListingAgreementsResponse`	`getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)` Retrieves the agreements for a particular resource version of a listing.
`GetAppCatalogListingResourceVersionResponse`	`getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)` Gets the specified listing resource version.
`GetBootVolumeAttachmentResponse`	`getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)` Gets information about the specified boot volume attachment.
`GetConsoleHistoryResponse`	`getConsoleHistory(GetConsoleHistoryRequest request)` Shows the metadata for the specified console history.
`GetConsoleHistoryContentResponse`	`getConsoleHistoryContent(GetConsoleHistoryContentRequest request)` Gets the actual console history data (not the metadata).
`GetDedicatedVmHostResponse`	`getDedicatedVmHost(GetDedicatedVmHostRequest request)` Gets information about the specified dedicated virtual machine host.
`GetImageResponse`	`getImage(GetImageRequest request)` Gets the specified image.
`GetInstanceResponse`	`getInstance(GetInstanceRequest request)` Gets information about the specified instance.
`GetInstanceConsoleConnectionResponse`	`getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)` Gets the specified instance console connection’s information.
`ComputePaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetVnicAttachmentResponse`	`getVnicAttachment(GetVnicAttachmentRequest request)` Gets the information for the specified VNIC attachment.
`GetVolumeAttachmentResponse`	`getVolumeAttachment(GetVolumeAttachmentRequest request)` Gets information about the specified volume attachment.
`ComputeWaiters`	`getWaiters()` Deprecated. use `newWaiters(WorkRequest)` instead. Otherwise, a default one will be provided that does not support operations that rely on the `WorkRequestClient` for polling. An `IllegalStateException` will be thrown for such operations.
`GetWindowsInstanceInitialCredentialsResponse`	`getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)` Gets the generated credentials for the instance.
`InstanceActionResponse`	`instanceAction(InstanceActionRequest request)` Performs one of the following power actions on the specified instance:
`LaunchInstanceResponse`	`launchInstance(LaunchInstanceRequest request)` Creates a new instance in the specified compartment and the specified availability domain.
`ListAppCatalogListingResourceVersionsResponse`	`listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)` Gets all resource versions for a particular listing.
`ListAppCatalogListingsResponse`	`listAppCatalogListings(ListAppCatalogListingsRequest request)` Lists the published listings.
`ListAppCatalogSubscriptionsResponse`	`listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)` Lists subscriptions for a compartment.
`ListBootVolumeAttachmentsResponse`	`listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request)` Lists the boot volume attachments in the specified compartment.
`ListConsoleHistoriesResponse`	`listConsoleHistories(ListConsoleHistoriesRequest request)` Lists the console history metadata for the specified compartment or instance.
`ListDedicatedVmHostInstancesResponse`	`listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)` Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
`ListDedicatedVmHostInstanceShapesResponse`	`listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request)` Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.
`ListDedicatedVmHostsResponse`	`listDedicatedVmHosts(ListDedicatedVmHostsRequest request)` Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.
`ListDedicatedVmHostShapesResponse`	`listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)` Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
`ListImagesResponse`	`listImages(ListImagesRequest request)` Lists the available images in the specified compartment, including both Oracle-provided images and custom images that have been created.
`ListInstanceConsoleConnectionsResponse`	`listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)` Lists the console connections for the specified compartment or instance.
`ListInstanceDevicesResponse`	`listInstanceDevices(ListInstanceDevicesRequest request)` Gets a list of all the devices for given instance.
`ListInstancesResponse`	`listInstances(ListInstancesRequest request)` Lists the instances in the specified compartment and the specified availability domain.
`ListShapesResponse`	`listShapes(ListShapesRequest request)` Lists the shapes that can be used to launch an instance within the specified compartment.
`ListVnicAttachmentsResponse`	`listVnicAttachments(ListVnicAttachmentsRequest request)` Lists the VNIC attachments in the specified compartment.
`ListVolumeAttachmentsResponse`	`listVolumeAttachments(ListVolumeAttachmentsRequest request)` Lists the volume attachments in the specified compartment.
`ComputeWaiters`	`newWaiters(WorkRequest workRequestClient)` Creates a new `ComputeWaiters` for resources for this service.
`RemoveImageShapeCompatibilityEntryResponse`	`removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)` Removes a shape from the compatible shapes list for the image.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`TerminateInstanceResponse`	`terminateInstance(TerminateInstanceRequest request)` Terminates the specified instance.
`UpdateConsoleHistoryResponse`	`updateConsoleHistory(UpdateConsoleHistoryRequest request)` Updates the specified console history metadata.
`UpdateDedicatedVmHostResponse`	`updateDedicatedVmHost(UpdateDedicatedVmHostRequest request)` Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.
`UpdateImageResponse`	`updateImage(UpdateImageRequest request)` Updates the display name of the image.
`UpdateInstanceResponse`	`updateInstance(UpdateInstanceRequest request)` Updates certain fields on the specified instance.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - setRegion
```
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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
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.
    
    Parameters:
    
    regionId - The public region ID.
  - addImageShapeCompatibilityEntry
```
AddImageShapeCompatibilityEntryResponse addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)
```
    Adds a shape to the compatible shapes list for the image.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - attachBootVolume
```
AttachBootVolumeResponse attachBootVolume(AttachBootVolumeRequest request)
```
    Attaches the specified boot volume to the specified instance.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - attachVnic
```
AttachVnicResponse attachVnic(AttachVnicRequest request)
```
    Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - attachVolume
```
AttachVolumeResponse attachVolume(AttachVolumeRequest request)
```
    Attaches the specified storage volume to the specified instance.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - captureConsoleHistory
```
CaptureConsoleHistoryResponse captureConsoleHistory(CaptureConsoleHistoryRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - changeDedicatedVmHostCompartment
```
ChangeDedicatedVmHostCompartmentResponse changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)
```
    Moves a dedicated virtual machine host from one compartment to another.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - changeImageCompartment
```
ChangeImageCompartmentResponse changeImageCompartment(ChangeImageCompartmentRequest request)
```
    Moves an image into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - changeInstanceCompartment
```
ChangeInstanceCompartmentResponse changeInstanceCompartment(ChangeInstanceCompartmentRequest request)
```
    Moves 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - createAppCatalogSubscription
```
CreateAppCatalogSubscriptionResponse createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)
```
    Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - createDedicatedVmHost
```
CreateDedicatedVmHostResponse createDedicatedVmHost(CreateDedicatedVmHostRequest request)
```
    Creates 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - createImage
```
CreateImageResponse createImage(CreateImageRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - createInstanceConsoleConnection
```
CreateInstanceConsoleConnectionResponse createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request)
```
    Creates 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 console access, see Accessing the Console.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - deleteAppCatalogSubscription
```
DeleteAppCatalogSubscriptionResponse deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)
```
    Delete a subscription for a listing resource version for a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - deleteConsoleHistory
```
DeleteConsoleHistoryResponse deleteConsoleHistory(DeleteConsoleHistoryRequest request)
```
    Deletes the specified console history metadata and the console history data.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - deleteDedicatedVmHost
```
DeleteDedicatedVmHostResponse deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request)
```
    Deletes 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - deleteImage
```
DeleteImageResponse deleteImage(DeleteImageRequest request)
```
    Deletes an image.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - deleteInstanceConsoleConnection
```
DeleteInstanceConsoleConnectionResponse deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)
```
    Deletes the specified instance console connection.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - detachBootVolume
```
DetachBootVolumeResponse detachBootVolume(DetachBootVolumeRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - detachVnic
```
DetachVnicResponse detachVnic(DetachVnicRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - detachVolume
```
DetachVolumeResponse detachVolume(DetachVolumeRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - exportImage
```
ExportImageResponse exportImage(ExportImageRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getAppCatalogListing
```
GetAppCatalogListingResponse getAppCatalogListing(GetAppCatalogListingRequest request)
```
    Gets the specified listing.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getAppCatalogListingAgreements
```
GetAppCatalogListingAgreementsResponse getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)
```
    Retrieves the agreements for a particular resource version of a listing.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getAppCatalogListingResourceVersion
```
GetAppCatalogListingResourceVersionResponse getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)
```
    Gets the specified listing resource version.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getBootVolumeAttachment
```
GetBootVolumeAttachmentResponse getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)
```
    Gets information about the specified boot volume attachment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getConsoleHistory
```
GetConsoleHistoryResponse getConsoleHistory(GetConsoleHistoryRequest request)
```
    Shows the metadata for the specified console history. See captureConsoleHistory for details about using the console history operations.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getConsoleHistoryContent
```
GetConsoleHistoryContentResponse getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
```
    Gets the actual console history data (not the metadata). See captureConsoleHistory for details about using the console history operations.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getDedicatedVmHost
```
GetDedicatedVmHostResponse getDedicatedVmHost(GetDedicatedVmHostRequest request)
```
    Gets information about the specified dedicated virtual machine host.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getImage
```
GetImageResponse getImage(GetImageRequest request)
```
    Gets the specified image.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getInstance
```
GetInstanceResponse getInstance(GetInstanceRequest request)
```
    Gets information about the specified instance.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getInstanceConsoleConnection
```
GetInstanceConsoleConnectionResponse getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)
```
    Gets the specified instance console connection’s information.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getVnicAttachment
```
GetVnicAttachmentResponse getVnicAttachment(GetVnicAttachmentRequest request)
```
    Gets the information for the specified VNIC attachment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getVolumeAttachment
```
GetVolumeAttachmentResponse getVolumeAttachment(GetVolumeAttachmentRequest request)
```
    Gets information about the specified volume attachment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getWindowsInstanceInitialCredentials
```
GetWindowsInstanceInitialCredentialsResponse getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - instanceAction
```
InstanceActionResponse instanceAction(InstanceActionRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - launchInstance
```
LaunchInstanceResponse launchInstance(LaunchInstanceRequest request)
```
    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).
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listAppCatalogListingResourceVersions
```
ListAppCatalogListingResourceVersionsResponse listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)
```
    Gets all resource versions for a particular listing.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listAppCatalogListings
```
ListAppCatalogListingsResponse listAppCatalogListings(ListAppCatalogListingsRequest request)
```
    Lists the published listings.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listAppCatalogSubscriptions
```
ListAppCatalogSubscriptionsResponse listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)
```
    Lists subscriptions for a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listBootVolumeAttachments
```
ListBootVolumeAttachmentsResponse listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request)
```
    Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listConsoleHistories
```
ListConsoleHistoriesResponse listConsoleHistories(ListConsoleHistoriesRequest request)
```
    Lists the console history metadata for the specified compartment or instance.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listDedicatedVmHostInstanceShapes
```
ListDedicatedVmHostInstanceShapesResponse listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request)
```
    Lists 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listDedicatedVmHostInstances
```
ListDedicatedVmHostInstancesResponse listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)
```
    Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listDedicatedVmHostShapes
```
ListDedicatedVmHostShapesResponse listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)
```
    Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listDedicatedVmHosts
```
ListDedicatedVmHostsResponse listDedicatedVmHosts(ListDedicatedVmHostsRequest request)
```
    Returns 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listImages
```
ListImagesResponse listImages(ListImagesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listInstanceConsoleConnections
```
ListInstanceConsoleConnectionsResponse listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)
```
    Lists the console connections for the specified compartment or instance.
    For more information about console access, see Accessing the Console.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listInstanceDevices
```
ListInstanceDevicesResponse listInstanceDevices(ListInstanceDevicesRequest request)
```
    Gets a list of all the devices for given instance. You can optionally filter results by device availability.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listInstances
```
ListInstancesResponse listInstances(ListInstancesRequest request)
```
    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).
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listShapes
```
ListShapesResponse listShapes(ListShapesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listVnicAttachments
```
ListVnicAttachmentsResponse listVnicAttachments(ListVnicAttachmentsRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - listVolumeAttachments
```
ListVolumeAttachmentsResponse listVolumeAttachments(ListVolumeAttachmentsRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - removeImageShapeCompatibilityEntry
```
RemoveImageShapeCompatibilityEntryResponse removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)
```
    Removes a shape from the compatible shapes list for the image.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - terminateInstance
```
TerminateInstanceResponse terminateInstance(TerminateInstanceRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - updateConsoleHistory
```
UpdateConsoleHistoryResponse updateConsoleHistory(UpdateConsoleHistoryRequest request)
```
    Updates the specified console history metadata.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - updateDedicatedVmHost
```
UpdateDedicatedVmHostResponse updateDedicatedVmHost(UpdateDedicatedVmHostRequest request)
```
    Updates 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - updateImage
```
UpdateImageResponse updateImage(UpdateImageRequest request)
```
    Updates the display name of the image. Avoid entering confidential information.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - updateInstance
```
UpdateInstanceResponse updateInstance(UpdateInstanceRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs.
  - getWaiters
```
@Deprecated
ComputeWaiters getWaiters()
```
    Deprecated. use newWaiters(WorkRequest) instead. Otherwise, a default one will be provided that does not support operations that rely on the WorkRequestClient for polling. An IllegalStateException will be thrown for such operations.
    
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - newWaiters
```
ComputeWaiters newWaiters(WorkRequest workRequestClient)
```
    Creates a new ComputeWaiters for resources for this service.
    
    Parameters:
    
    workRequestClient - The work request service client used to query for work request status
    
    Returns:
    
    The service waiters.
  - getPaginators
```
ComputePaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface Compute

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

setEndpoint

setRegion

setRegion

addImageShapeCompatibilityEntry

attachBootVolume

attachVnic

attachVolume

captureConsoleHistory

changeDedicatedVmHostCompartment

changeImageCompartment

changeInstanceCompartment

createAppCatalogSubscription

createDedicatedVmHost

createImage

createInstanceConsoleConnection

deleteAppCatalogSubscription

deleteConsoleHistory

deleteDedicatedVmHost

deleteImage

deleteInstanceConsoleConnection

detachBootVolume

detachVnic

detachVolume

exportImage

getAppCatalogListing

getAppCatalogListingAgreements

getAppCatalogListingResourceVersion

getBootVolumeAttachment

getConsoleHistory

getConsoleHistoryContent

getDedicatedVmHost

getImage

getInstance

getInstanceConsoleConnection

getVnicAttachment

getVolumeAttachment

getWindowsInstanceInitialCredentials

instanceAction

launchInstance

listAppCatalogListingResourceVersions

listAppCatalogListings

listAppCatalogSubscriptions

listBootVolumeAttachments

listConsoleHistories

listDedicatedVmHostInstanceShapes

listDedicatedVmHostInstances

listDedicatedVmHostShapes

listDedicatedVmHosts

listImages

listInstanceConsoleConnections

listInstanceDevices

listInstances

listShapes

listVnicAttachments

listVolumeAttachments

removeImageShapeCompatibilityEntry

terminateInstance

updateConsoleHistory

updateDedicatedVmHost

updateImage

updateInstance

getWaiters

newWaiters

getPaginators