@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeClient extends BaseSyncClient implements Compute
Modifier and Type | Class and Description |
---|---|
static class |
ComputeClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
protected ExecutorService |
executorService |
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for Compute.
|
Constructor and Description |
---|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Compute.
protected final ExecutorService executorService
public final String clientCommonLibraryVersion
@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- ComputeClient.Builder.executorService
public static ComputeClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
Compute
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.
public void setRegion(String regionId)
Compute
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
.
public AcceptShieldedIntegrityPolicyResponse acceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest request)
Compute
Accept the changes to the PCR values in the measured boot report.
acceptShieldedIntegrityPolicy
in interface Compute
request
- The request object containing the details to sendpublic AddImageShapeCompatibilityEntryResponse addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)
Compute
Adds a shape to the compatible shapes list for the image.
addImageShapeCompatibilityEntry
in interface Compute
request
- The request object containing the details to sendpublic AttachBootVolumeResponse attachBootVolume(AttachBootVolumeRequest request)
Compute
Attaches the specified boot volume to the specified instance.
attachBootVolume
in interface Compute
request
- The request object containing the details to sendpublic AttachVnicResponse attachVnic(AttachVnicRequest request)
Compute
Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
attachVnic
in interface Compute
request
- The request object containing the details to sendpublic AttachVolumeResponse attachVolume(AttachVolumeRequest request)
Compute
Attaches the specified storage volume to the specified instance.
attachVolume
in interface Compute
request
- The request object containing the details to sendpublic CaptureConsoleHistoryResponse captureConsoleHistory(CaptureConsoleHistoryRequest request)
Compute
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.
captureConsoleHistory
in interface Compute
request
- The request object containing the details to sendpublic ChangeComputeCapacityReservationCompartmentResponse changeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest request)
Compute
Moves a compute capacity reservation into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeComputeCapacityReservationCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeComputeCapacityTopologyCompartmentResponse changeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest request)
Compute
Moves a compute capacity topology into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeComputeCapacityTopologyCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeComputeClusterCompartmentResponse changeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest request)
Compute
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).
changeComputeClusterCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeComputeImageCapabilitySchemaCompartmentResponse changeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest request)
Compute
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.
changeComputeImageCapabilitySchemaCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeDedicatedVmHostCompartmentResponse changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)
Compute
Moves a dedicated virtual machine host from one compartment to another.
changeDedicatedVmHostCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeImageCompartmentResponse changeImageCompartment(ChangeImageCompartmentRequest request)
Compute
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.
changeImageCompartment
in interface Compute
request
- The request object containing the details to sendpublic ChangeInstanceCompartmentResponse changeInstanceCompartment(ChangeInstanceCompartmentRequest request)
Compute
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.
changeInstanceCompartment
in interface Compute
request
- The request object containing the details to sendpublic CreateAppCatalogSubscriptionResponse createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)
Compute
Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
createAppCatalogSubscription
in interface Compute
request
- The request object containing the details to sendpublic CreateComputeCapacityReportResponse createComputeCapacityReport(CreateComputeCapacityReportRequest request)
Compute
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.
createComputeCapacityReport
in interface Compute
request
- The request object containing the details to sendpublic CreateComputeCapacityReservationResponse createComputeCapacityReservation(CreateComputeCapacityReservationRequest request)
Compute
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.
createComputeCapacityReservation
in interface Compute
request
- The request object containing the details to sendpublic CreateComputeCapacityTopologyResponse createComputeCapacityTopology(CreateComputeCapacityTopologyRequest request)
Compute
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.
createComputeCapacityTopology
in interface Compute
request
- The request object containing the details to sendpublic CreateComputeClusterResponse createComputeCluster(CreateComputeClusterRequest request)
Compute
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.
createComputeCluster
in interface Compute
request
- The request object containing the details to sendpublic CreateComputeImageCapabilitySchemaResponse createComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest request)
Compute
Creates compute image capability schema.
createComputeImageCapabilitySchema
in interface Compute
request
- The request object containing the details to sendpublic CreateDedicatedVmHostResponse createDedicatedVmHost(CreateDedicatedVmHostRequest request)
Compute
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.
createDedicatedVmHost
in interface Compute
request
- The request object containing the details to sendpublic CreateImageResponse createImage(CreateImageRequest request)
Compute
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.
createImage
in interface Compute
request
- The request object containing the details to sendpublic CreateInstanceConsoleConnectionResponse createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request)
Compute
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).
createInstanceConsoleConnection
in interface Compute
request
- The request object containing the details to sendpublic DeleteAppCatalogSubscriptionResponse deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)
Compute
Delete a subscription for a listing resource version for a compartment.
deleteAppCatalogSubscription
in interface Compute
request
- The request object containing the details to sendpublic DeleteComputeCapacityReservationResponse deleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest request)
Compute
Deletes the specified compute capacity reservation.
deleteComputeCapacityReservation
in interface Compute
request
- The request object containing the details to sendpublic DeleteComputeCapacityTopologyResponse deleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest request)
Compute
Deletes the specified compute capacity topology.
deleteComputeCapacityTopology
in interface Compute
request
- The request object containing the details to sendpublic DeleteComputeClusterResponse deleteComputeCluster(DeleteComputeClusterRequest request)
Compute
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.
deleteComputeCluster
in interface Compute
request
- The request object containing the details to sendpublic DeleteComputeImageCapabilitySchemaResponse deleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest request)
Compute
Deletes the specified Compute Image Capability Schema
deleteComputeImageCapabilitySchema
in interface Compute
request
- The request object containing the details to sendpublic DeleteConsoleHistoryResponse deleteConsoleHistory(DeleteConsoleHistoryRequest request)
Compute
Deletes the specified console history metadata and the console history data.
deleteConsoleHistory
in interface Compute
request
- The request object containing the details to sendpublic DeleteDedicatedVmHostResponse deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request)
Compute
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.
deleteDedicatedVmHost
in interface Compute
request
- The request object containing the details to sendpublic DeleteImageResponse deleteImage(DeleteImageRequest request)
Compute
Deletes an image.
deleteImage
in interface Compute
request
- The request object containing the details to sendpublic DeleteInstanceConsoleConnectionResponse deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)
Compute
Deletes the specified instance console connection.
deleteInstanceConsoleConnection
in interface Compute
request
- The request object containing the details to sendpublic DetachBootVolumeResponse detachBootVolume(DetachBootVolumeRequest request)
Compute
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.
detachBootVolume
in interface Compute
request
- The request object containing the details to sendpublic DetachVnicResponse detachVnic(DetachVnicRequest request)
Compute
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.
detachVnic
in interface Compute
request
- The request object containing the details to sendpublic DetachVolumeResponse detachVolume(DetachVolumeRequest request)
Compute
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.
detachVolume
in interface Compute
request
- The request object containing the details to sendpublic ExportImageResponse exportImage(ExportImageRequest request)
Compute
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.
exportImage
in interface Compute
request
- The request object containing the details to sendpublic GetAppCatalogListingResponse getAppCatalogListing(GetAppCatalogListingRequest request)
Compute
Gets the specified listing.
getAppCatalogListing
in interface Compute
request
- The request object containing the details to sendpublic GetAppCatalogListingAgreementsResponse getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)
Compute
Retrieves the agreements for a particular resource version of a listing.
getAppCatalogListingAgreements
in interface Compute
request
- The request object containing the details to sendpublic GetAppCatalogListingResourceVersionResponse getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)
Compute
Gets the specified listing resource version.
getAppCatalogListingResourceVersion
in interface Compute
request
- The request object containing the details to sendpublic GetBootVolumeAttachmentResponse getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)
Compute
Gets information about the specified boot volume attachment.
getBootVolumeAttachment
in interface Compute
request
- The request object containing the details to sendpublic GetComputeCapacityReservationResponse getComputeCapacityReservation(GetComputeCapacityReservationRequest request)
Compute
Gets information about the specified compute capacity reservation.
getComputeCapacityReservation
in interface Compute
request
- The request object containing the details to sendpublic GetComputeCapacityTopologyResponse getComputeCapacityTopology(GetComputeCapacityTopologyRequest request)
Compute
Gets information about the specified compute capacity topology.
getComputeCapacityTopology
in interface Compute
request
- The request object containing the details to sendpublic GetComputeClusterResponse getComputeCluster(GetComputeClusterRequest request)
Compute
Gets information about a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.
getComputeCluster
in interface Compute
request
- The request object containing the details to sendpublic GetComputeGlobalImageCapabilitySchemaResponse getComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest request)
Compute
Gets the specified Compute Global Image Capability Schema
getComputeGlobalImageCapabilitySchema
in interface Compute
request
- The request object containing the details to sendpublic GetComputeGlobalImageCapabilitySchemaVersionResponse getComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest request)
Compute
Gets the specified Compute Global Image Capability Schema Version
getComputeGlobalImageCapabilitySchemaVersion
in interface Compute
request
- The request object containing the details to sendpublic GetComputeImageCapabilitySchemaResponse getComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest request)
Compute
Gets the specified Compute Image Capability Schema
getComputeImageCapabilitySchema
in interface Compute
request
- The request object containing the details to sendpublic GetConsoleHistoryResponse getConsoleHistory(GetConsoleHistoryRequest request)
Compute
Shows the metadata for the specified console history. See captureConsoleHistory
for details about
using the console history operations.
getConsoleHistory
in interface Compute
request
- The request object containing the details to sendpublic GetConsoleHistoryContentResponse getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
Compute
Gets the actual console history data (not the metadata). See captureConsoleHistory
for details about
using the console history operations.
getConsoleHistoryContent
in interface Compute
request
- The request object containing the details to sendpublic GetDedicatedVmHostResponse getDedicatedVmHost(GetDedicatedVmHostRequest request)
Compute
Gets information about the specified dedicated virtual machine host.
getDedicatedVmHost
in interface Compute
request
- The request object containing the details to sendpublic GetImageResponse getImage(GetImageRequest request)
Compute
Gets the specified image.
public GetImageShapeCompatibilityEntryResponse getImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest request)
Compute
Retrieves an image shape compatibility entry.
getImageShapeCompatibilityEntry
in interface Compute
request
- The request object containing the details to sendpublic GetInstanceResponse getInstance(GetInstanceRequest request)
Compute
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.
getInstance
in interface Compute
request
- The request object containing the details to sendpublic GetInstanceConsoleConnectionResponse getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)
Compute
Gets the specified instance console connection’s information.
getInstanceConsoleConnection
in interface Compute
request
- The request object containing the details to sendpublic GetInstanceMaintenanceEventResponse getInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest request)
Compute
Gets the maintenance event for the given instance.
getInstanceMaintenanceEvent
in interface Compute
request
- The request object containing the details to sendpublic GetInstanceMaintenanceRebootResponse getInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest request)
Compute
Gets the maximum possible date that a maintenance reboot can be extended. For more information, see Infrastructure Maintenance.
getInstanceMaintenanceReboot
in interface Compute
request
- The request object containing the details to sendpublic GetMeasuredBootReportResponse getMeasuredBootReport(GetMeasuredBootReportRequest request)
Compute
Gets the measured boot report for this shielded instance.
getMeasuredBootReport
in interface Compute
request
- The request object containing the details to sendpublic GetVnicAttachmentResponse getVnicAttachment(GetVnicAttachmentRequest request)
Compute
Gets the information for the specified VNIC attachment.
getVnicAttachment
in interface Compute
request
- The request object containing the details to sendpublic GetVolumeAttachmentResponse getVolumeAttachment(GetVolumeAttachmentRequest request)
Compute
Gets information about the specified volume attachment.
getVolumeAttachment
in interface Compute
request
- The request object containing the details to sendpublic GetWindowsInstanceInitialCredentialsResponse getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)
Compute
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.
getWindowsInstanceInitialCredentials
in interface Compute
request
- The request object containing the details to sendpublic InstanceActionResponse instanceAction(InstanceActionRequest request)
Compute
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).
instanceAction
in interface Compute
request
- The request object containing the details to sendpublic LaunchInstanceResponse launchInstance(LaunchInstanceRequest request)
Compute
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.
launchInstance
in interface Compute
request
- The request object containing the details to sendpublic ListAppCatalogListingResourceVersionsResponse listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)
Compute
Gets all resource versions for a particular listing.
listAppCatalogListingResourceVersions
in interface Compute
request
- The request object containing the details to sendpublic ListAppCatalogListingsResponse listAppCatalogListings(ListAppCatalogListingsRequest request)
Compute
Lists the published listings.
listAppCatalogListings
in interface Compute
request
- The request object containing the details to sendpublic ListAppCatalogSubscriptionsResponse listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)
Compute
Lists subscriptions for a compartment.
listAppCatalogSubscriptions
in interface Compute
request
- The request object containing the details to sendpublic ListBootVolumeAttachmentsResponse listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request)
Compute
Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
listBootVolumeAttachments
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityReservationInstanceShapesResponse listComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest request)
Compute
Lists the shapes that can be reserved within the specified compartment.
listComputeCapacityReservationInstanceShapes
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityReservationInstancesResponse listComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest request)
Compute
Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.
listComputeCapacityReservationInstances
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityReservationsResponse listComputeCapacityReservations(ListComputeCapacityReservationsRequest request)
Compute
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).
listComputeCapacityReservations
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityTopologiesResponse listComputeCapacityTopologies(ListComputeCapacityTopologiesRequest request)
Compute
Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute capacity topology display name.
listComputeCapacityTopologies
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityTopologyComputeBareMetalHostsResponse listComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest request)
Compute
Lists compute bare metal hosts in the specified compute capacity topology.
listComputeCapacityTopologyComputeBareMetalHosts
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityTopologyComputeHpcIslandsResponse listComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest request)
Compute
Lists compute HPC islands in the specified compute capacity topology.
listComputeCapacityTopologyComputeHpcIslands
in interface Compute
request
- The request object containing the details to sendpublic ListComputeCapacityTopologyComputeNetworkBlocksResponse listComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest request)
Compute
Lists compute network blocks in the specified compute capacity topology.
listComputeCapacityTopologyComputeNetworkBlocks
in interface Compute
request
- The request object containing the details to sendpublic ListComputeClustersResponse listComputeClusters(ListComputeClustersRequest request)
Compute
Lists the compute clusters in the specified compartment. A compute cluster is a remote direct memory access (RDMA) network group.
listComputeClusters
in interface Compute
request
- The request object containing the details to sendpublic ListComputeGlobalImageCapabilitySchemaVersionsResponse listComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest request)
Compute
Lists Compute Global Image Capability Schema versions in the specified compartment.
listComputeGlobalImageCapabilitySchemaVersions
in interface Compute
request
- The request object containing the details to sendpublic ListComputeGlobalImageCapabilitySchemasResponse listComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest request)
Compute
Lists Compute Global Image Capability Schema in the specified compartment.
listComputeGlobalImageCapabilitySchemas
in interface Compute
request
- The request object containing the details to sendpublic ListComputeImageCapabilitySchemasResponse listComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest request)
Compute
Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
listComputeImageCapabilitySchemas
in interface Compute
request
- The request object containing the details to sendpublic ListConsoleHistoriesResponse listConsoleHistories(ListConsoleHistoriesRequest request)
Compute
Lists the console history metadata for the specified compartment or instance.
listConsoleHistories
in interface Compute
request
- The request object containing the details to sendpublic ListDedicatedVmHostInstanceShapesResponse listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request)
Compute
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.
listDedicatedVmHostInstanceShapes
in interface Compute
request
- The request object containing the details to sendpublic ListDedicatedVmHostInstancesResponse listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)
Compute
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
listDedicatedVmHostInstances
in interface Compute
request
- The request object containing the details to sendpublic ListDedicatedVmHostShapesResponse listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)
Compute
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
listDedicatedVmHostShapes
in interface Compute
request
- The request object containing the details to sendpublic ListDedicatedVmHostsResponse listDedicatedVmHosts(ListDedicatedVmHostsRequest request)
Compute
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.
listDedicatedVmHosts
in interface Compute
request
- The request object containing the details to sendpublic ListImageShapeCompatibilityEntriesResponse listImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest request)
Compute
Lists the compatible shapes for the specified image.
listImageShapeCompatibilityEntries
in interface Compute
request
- The request object containing the details to sendpublic ListImagesResponse listImages(ListImagesRequest request)
Compute
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.
listImages
in interface Compute
request
- The request object containing the details to sendpublic ListInstanceConsoleConnectionsResponse listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)
Compute
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).
listInstanceConsoleConnections
in interface Compute
request
- The request object containing the details to sendpublic ListInstanceDevicesResponse listInstanceDevices(ListInstanceDevicesRequest request)
Compute
Gets a list of all the devices for given instance. You can optionally filter results by device availability.
listInstanceDevices
in interface Compute
request
- The request object containing the details to sendpublic ListInstanceMaintenanceEventsResponse listInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest request)
Compute
Gets a list of all the maintenance events for the given instance.
listInstanceMaintenanceEvents
in interface Compute
request
- The request object containing the details to sendpublic ListInstancesResponse listInstances(ListInstancesRequest request)
Compute
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.
listInstances
in interface Compute
request
- The request object containing the details to sendpublic ListShapesResponse listShapes(ListShapesRequest request)
Compute
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.
listShapes
in interface Compute
request
- The request object containing the details to sendpublic ListVnicAttachmentsResponse listVnicAttachments(ListVnicAttachmentsRequest request)
Compute
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.
listVnicAttachments
in interface Compute
request
- The request object containing the details to sendpublic ListVolumeAttachmentsResponse listVolumeAttachments(ListVolumeAttachmentsRequest request)
Compute
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
.
listVolumeAttachments
in interface Compute
request
- The request object containing the details to sendpublic RemoveImageShapeCompatibilityEntryResponse removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)
Compute
Removes a shape from the compatible shapes list for the image.
removeImageShapeCompatibilityEntry
in interface Compute
request
- The request object containing the details to sendpublic TerminateInstanceResponse terminateInstance(TerminateInstanceRequest request)
Compute
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.
terminateInstance
in interface Compute
request
- The request object containing the details to sendpublic UpdateComputeCapacityReservationResponse updateComputeCapacityReservation(UpdateComputeCapacityReservationRequest request)
Compute
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.
updateComputeCapacityReservation
in interface Compute
request
- The request object containing the details to sendpublic UpdateComputeCapacityTopologyResponse updateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest request)
Compute
Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.
updateComputeCapacityTopology
in interface Compute
request
- The request object containing the details to sendpublic UpdateComputeClusterResponse updateComputeCluster(UpdateComputeClusterRequest request)
Compute
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.
updateComputeCluster
in interface Compute
request
- The request object containing the details to sendpublic UpdateComputeImageCapabilitySchemaResponse updateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest request)
Compute
Updates the specified Compute Image Capability Schema
updateComputeImageCapabilitySchema
in interface Compute
request
- The request object containing the details to sendpublic UpdateConsoleHistoryResponse updateConsoleHistory(UpdateConsoleHistoryRequest request)
Compute
Updates the specified console history metadata.
updateConsoleHistory
in interface Compute
request
- The request object containing the details to sendpublic UpdateDedicatedVmHostResponse updateDedicatedVmHost(UpdateDedicatedVmHostRequest request)
Compute
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.
updateDedicatedVmHost
in interface Compute
request
- The request object containing the details to sendpublic UpdateImageResponse updateImage(UpdateImageRequest request)
Compute
Updates the display name of the image. Avoid entering confidential information.
updateImage
in interface Compute
request
- The request object containing the details to sendpublic UpdateInstanceResponse updateInstance(UpdateInstanceRequest request)
Compute
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.
updateInstance
in interface Compute
request
- The request object containing the details to sendpublic UpdateInstanceConsoleConnectionResponse updateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest request)
Compute
Updates the defined tags and free-form tags for the specified instance console connection.
updateInstanceConsoleConnection
in interface Compute
request
- The request object containing the details to sendpublic UpdateInstanceMaintenanceEventResponse updateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest request)
Compute
Updates the maintenance event for the given instance.
updateInstanceMaintenanceEvent
in interface Compute
request
- The request object containing the details to sendpublic UpdateVolumeAttachmentResponse updateVolumeAttachment(UpdateVolumeAttachmentRequest request)
Compute
Updates information about the specified volume attachment.
updateVolumeAttachment
in interface Compute
request
- The request object containing the details to sendpublic ComputeWaiters getWaiters()
Compute
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Compute
public ComputeWaiters newWaiters(WorkRequest workRequestClient)
Compute
Creates a new ComputeWaiters
for resources for this service.
newWaiters
in interface Compute
workRequestClient
- The work request service client used to query for work request
statuspublic ComputePaginators getPaginators()
Compute
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.
getPaginators
in interface Compute
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.