@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public interface Compute
extends AutoCloseable
Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the Networking, Compute, and Block Volume services. The required permissions are documented in the Details for the Core Services article.
This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
closevoid refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint
templateAcceptShieldedIntegrityPolicyResponse acceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest request)
Accept the changes to the PCR values in the measured boot report.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AcceptShieldedIntegrityPolicy API.
AddImageShapeCompatibilityEntryResponse addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)
Adds a shape to the compatible shapes list for the image.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddImageShapeCompatibilityEntry API.
AttachBootVolumeResponse attachBootVolume(AttachBootVolumeRequest request)
Attaches the specified boot volume to the specified instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AttachBootVolume API.
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).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AttachVnic API.
AttachVolumeResponse attachVolume(AttachVolumeRequest request)
Attaches the specified storage volume to the specified instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AttachVolume API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CaptureConsoleHistory API.
ChangeComputeCapacityReservationCompartmentResponse changeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest request)
Moves a compute capacity reservation into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeComputeCapacityReservationCompartment API.
ChangeComputeCapacityTopologyCompartmentResponse changeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest request)
Moves a compute capacity topology into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeComputeCapacityTopologyCompartment API.
ChangeComputeClusterCompartmentResponse changeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest request)
Moves 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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeComputeClusterCompartment API.
ChangeComputeImageCapabilitySchemaCompartmentResponse changeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest request)
Moves 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeComputeImageCapabilitySchemaCompartment API.
ChangeDedicatedVmHostCompartmentResponse changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)
Moves a dedicated virtual machine host from one compartment to another.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeDedicatedVmHostCompartment API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeImageCompartment API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeInstanceCompartment API.
CreateAppCatalogSubscriptionResponse createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)
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 sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateAppCatalogSubscription API.
CreateComputeCapacityReportResponse createComputeCapacityReport(CreateComputeCapacityReportRequest request)
Generates 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateComputeCapacityReport API.
CreateComputeCapacityReservationResponse createComputeCapacityReservation(CreateComputeCapacityReservationRequest request)
Creates 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateComputeCapacityReservation API.
CreateComputeCapacityTopologyResponse createComputeCapacityTopology(CreateComputeCapacityTopologyRequest request)
Creates 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateComputeCapacityTopology API.
CreateComputeClusterResponse createComputeCluster(CreateComputeClusterRequest request)
Creates 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
launchInstance operation 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 createClusterNetwork operation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateComputeCluster API.
CreateComputeImageCapabilitySchemaResponse createComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest request)
Creates compute image capability schema.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateComputeImageCapabilitySchema API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDedicatedVmHost API.
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](https://docs.cloud.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.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs)
and [Using Pre-Authenticated
Requests](https://docs.cloud.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.cloud.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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateImage API.
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 instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.cloud.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateInstanceConsoleConnection API.
DeleteAppCatalogSubscriptionResponse deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)
Delete a subscription for a listing resource version for a compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteAppCatalogSubscription API.
DeleteComputeCapacityReservationResponse deleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest request)
Deletes the specified compute capacity reservation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteComputeCapacityReservation API.
DeleteComputeCapacityTopologyResponse deleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest request)
Deletes the specified compute capacity topology.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteComputeCapacityTopology API.
DeleteComputeClusterResponse deleteComputeCluster(DeleteComputeClusterRequest request)
Deletes 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 terminateInstance operation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteComputeCluster API.
DeleteComputeImageCapabilitySchemaResponse deleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest request)
Deletes the specified Compute Image Capability Schema
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteComputeImageCapabilitySchema API.
DeleteConsoleHistoryResponse deleteConsoleHistory(DeleteConsoleHistoryRequest request)
Deletes the specified console history metadata and the console history data.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteConsoleHistory API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDedicatedVmHost API.
DeleteImageResponse deleteImage(DeleteImageRequest request)
Deletes an image.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteImage API.
DeleteInstanceConsoleConnectionResponse deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)
Deletes the specified instance console connection.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteInstanceConsoleConnection API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DetachBootVolume API.
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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),
deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DetachVnic API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DetachVolume API.
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](https://docs.cloud.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.cloud.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.cloud.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExportImage API.
GetAppCatalogListingResponse getAppCatalogListing(GetAppCatalogListingRequest request)
Gets the specified listing.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAppCatalogListing API.
GetAppCatalogListingAgreementsResponse getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)
Retrieves the agreements for a particular resource version of a listing.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAppCatalogListingAgreements API.
GetAppCatalogListingResourceVersionResponse getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)
Gets the specified listing resource version.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAppCatalogListingResourceVersion API.
GetBootVolumeAttachmentResponse getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)
Gets information about the specified boot volume attachment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetBootVolumeAttachment API.
GetComputeCapacityReservationResponse getComputeCapacityReservation(GetComputeCapacityReservationRequest request)
Gets information about the specified compute capacity reservation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeCapacityReservation API.
GetComputeCapacityTopologyResponse getComputeCapacityTopology(GetComputeCapacityTopologyRequest request)
Gets information about the specified compute capacity topology.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeCapacityTopology API.
GetComputeClusterResponse getComputeCluster(GetComputeClusterRequest request)
Gets information about a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeCluster API.
GetComputeGlobalImageCapabilitySchemaResponse getComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest request)
Gets the specified Compute Global Image Capability Schema
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeGlobalImageCapabilitySchema API.
GetComputeGlobalImageCapabilitySchemaVersionResponse getComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest request)
Gets the specified Compute Global Image Capability Schema Version
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeGlobalImageCapabilitySchemaVersion API.
GetComputeImageCapabilitySchemaResponse getComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest request)
Gets the specified Compute Image Capability Schema
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetComputeImageCapabilitySchema API.
GetConsoleHistoryResponse getConsoleHistory(GetConsoleHistoryRequest request)
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 sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConsoleHistory API.
GetConsoleHistoryContentResponse getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
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 sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConsoleHistoryContent API.
GetDedicatedVmHostResponse getDedicatedVmHost(GetDedicatedVmHostRequest request)
Gets information about the specified dedicated virtual machine host.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDedicatedVmHost API.
GetImageResponse getImage(GetImageRequest request)
Gets the specified image.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetImage API.
GetImageShapeCompatibilityEntryResponse getImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest request)
Retrieves an image shape compatibility entry.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetImageShapeCompatibilityEntry API.
GetInstanceResponse getInstance(GetInstanceRequest request)
Gets information about the specified instance.
*Note:** To retrieve public and private IP addresses for an instance, use the listVnicAttachments operation to get the
VNIC ID for the instance, and then call getVnic with the
VNIC ID.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetInstance API.
GetInstanceConsoleConnectionResponse getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)
Gets the specified instance console connection’s information.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetInstanceConsoleConnection API.
GetInstanceMaintenanceEventResponse getInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest request)
Gets the maintenance event for the given instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetInstanceMaintenanceEvent API.
GetInstanceMaintenanceRebootResponse getInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest request)
Gets the maximum possible date that a maintenance reboot can be extended. For more information, see Infrastructure Maintenance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetInstanceMaintenanceReboot API.
GetMeasuredBootReportResponse getMeasuredBootReport(GetMeasuredBootReportRequest request)
Gets the measured boot report for this shielded instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetMeasuredBootReport API.
GetVnicAttachmentResponse getVnicAttachment(GetVnicAttachmentRequest request)
Gets the information for the specified VNIC attachment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetVnicAttachment API.
GetVolumeAttachmentResponse getVolumeAttachment(GetVolumeAttachmentRequest request)
Gets information about the specified volume attachment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetVolumeAttachment API.
GetWindowsInstanceInitialCredentialsResponse getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)
Gets 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWindowsInstanceInitialCredentials API.
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.
- **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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.oracle.com/iaas/Content/Compute/Tasks/restartinginstance.htm).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use InstanceAction API.
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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.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 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)](https://docs.cloud.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 getAppCatalogListingAgreements operation to get the signature for the terms of use agreement
for the desired listing resource version. Then, call createAppCatalogSubscription with the signature. To get the image ID for the LaunchInstance
operation, call getAppCatalogListingResourceVersion.
When launching an instance, you may provide the `securityAttributes` parameter in LaunchInstanceDetails to manage security attributes via the instance, or in the embedded
CreateVnicDetails to 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 createComputeCapacityReport operation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use LaunchInstance API.
ListAppCatalogListingResourceVersionsResponse listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)
Gets all resource versions for a particular listing.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAppCatalogListingResourceVersions API.
ListAppCatalogListingsResponse listAppCatalogListings(ListAppCatalogListingsRequest request)
Lists the published listings.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAppCatalogListings API.
ListAppCatalogSubscriptionsResponse listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)
Lists subscriptions for a compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAppCatalogSubscriptions API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListBootVolumeAttachments API.
ListComputeCapacityReservationInstanceShapesResponse listComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest request)
Lists the shapes that can be reserved within the specified compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityReservationInstanceShapes API.
ListComputeCapacityReservationInstancesResponse listComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest request)
Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityReservationInstances API.
ListComputeCapacityReservationsResponse listComputeCapacityReservations(ListComputeCapacityReservationsRequest request)
Lists 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).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityReservations API.
ListComputeCapacityTopologiesResponse listComputeCapacityTopologies(ListComputeCapacityTopologiesRequest request)
Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute capacity topology display name.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityTopologies API.
ListComputeCapacityTopologyComputeBareMetalHostsResponse listComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest request)
Lists compute bare metal hosts in the specified compute capacity topology.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityTopologyComputeBareMetalHosts API.
ListComputeCapacityTopologyComputeHpcIslandsResponse listComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest request)
Lists compute HPC islands in the specified compute capacity topology.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityTopologyComputeHpcIslands API.
ListComputeCapacityTopologyComputeNetworkBlocksResponse listComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest request)
Lists compute network blocks in the specified compute capacity topology.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeCapacityTopologyComputeNetworkBlocks API.
ListComputeClustersResponse listComputeClusters(ListComputeClustersRequest request)
Lists the compute clusters in the specified compartment. A compute cluster is a remote direct memory access (RDMA) network group.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeClusters API.
ListComputeGlobalImageCapabilitySchemaVersionsResponse listComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest request)
Lists Compute Global Image Capability Schema versions in the specified compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeGlobalImageCapabilitySchemaVersions API.
ListComputeGlobalImageCapabilitySchemasResponse listComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest request)
Lists Compute Global Image Capability Schema in the specified compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeGlobalImageCapabilitySchemas API.
ListComputeImageCapabilitySchemasResponse listComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest request)
Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListComputeImageCapabilitySchemas API.
ListConsoleHistoriesResponse listConsoleHistories(ListConsoleHistoriesRequest request)
Lists the console history metadata for the specified compartment or instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConsoleHistories API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDedicatedVmHostInstanceShapes API.
ListDedicatedVmHostInstancesResponse listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDedicatedVmHostInstances API.
ListDedicatedVmHostShapesResponse listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDedicatedVmHostShapes API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDedicatedVmHosts API.
ListImageShapeCompatibilityEntriesResponse listImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest request)
Lists the compatible shapes for the specified image.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListImageShapeCompatibilityEntries API.
ListImagesResponse listImages(ListImagesRequest request)
Lists 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListImages API.
ListInstanceConsoleConnectionsResponse listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)
Lists 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.cloud.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListInstanceConsoleConnections API.
ListInstanceDevicesResponse listInstanceDevices(ListInstanceDevicesRequest request)
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 sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListInstanceDevices API.
ListInstanceMaintenanceEventsResponse listInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest request)
Gets a list of all the maintenance events for the given instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListInstanceMaintenanceEvents API.
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).
*Note:** To retrieve public and private IP addresses for an instance, use the listVnicAttachments operation to get the
VNIC ID for the instance, and then call getVnic with the
VNIC ID.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListInstances API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListShapes API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListVnicAttachments API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListVolumeAttachments API.
RemoveImageShapeCompatibilityEntryResponse removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)
Removes a shape from the compatible shapes list for the image.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveImageShapeCompatibilityEntry API.
TerminateInstanceResponse terminateInstance(TerminateInstanceRequest request)
Permanently 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use TerminateInstance API.
UpdateComputeCapacityReservationResponse updateComputeCapacityReservation(UpdateComputeCapacityReservationRequest request)
Updates 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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateComputeCapacityReservation API.
UpdateComputeCapacityTopologyResponse updateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest request)
Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateComputeCapacityTopology API.
UpdateComputeClusterResponse updateComputeCluster(UpdateComputeClusterRequest request)
Updates a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.
To create instances within a compute cluster, use the launchInstance operation.
To delete instances from a compute cluster, use the terminateInstance operation.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateComputeCluster API.
UpdateComputeImageCapabilitySchemaResponse updateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest request)
Updates the specified Compute Image Capability Schema
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateComputeImageCapabilitySchema API.
UpdateConsoleHistoryResponse updateConsoleHistory(UpdateConsoleHistoryRequest request)
Updates the specified console history metadata.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateConsoleHistory API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDedicatedVmHost API.
UpdateImageResponse updateImage(UpdateImageRequest request)
Updates the display name of the image. Avoid entering confidential information.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateImage API.
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateInstance API.
UpdateInstanceConsoleConnectionResponse updateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest request)
Updates the defined tags and free-form tags for the specified instance console connection.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateInstanceConsoleConnection API.
UpdateInstanceMaintenanceEventResponse updateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest request)
Updates the maintenance event for the given instance.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateInstanceMaintenanceEvent API.
UpdateVolumeAttachmentResponse updateVolumeAttachment(UpdateVolumeAttachmentRequest request)
Updates information about the specified volume attachment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateVolumeAttachment API.
@Deprecated ComputeWaiters getWaiters()
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.
ComputeWaiters newWaiters(WorkRequest workRequestClient)
Creates a new ComputeWaiters for resources for this service.
workRequestClient - The work request service client used to query for work request
statusComputePaginators 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.
Copyright © 2016–2024. All rights reserved.