@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeClient extends Object implements Compute
Modifier and Type | Class and Description |
---|---|
static class |
ComputeClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Compute.
|
Constructor and Description |
---|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
AddImageShapeCompatibilityEntryResponse |
addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)
Adds a shape to the compatible shapes list for the image.
|
AttachBootVolumeResponse |
attachBootVolume(AttachBootVolumeRequest request)
Attaches the specified boot volume to the specified instance.
|
AttachVnicResponse |
attachVnic(AttachVnicRequest request)
Creates a secondary VNIC and attaches it to the specified instance.
|
AttachVolumeResponse |
attachVolume(AttachVolumeRequest request)
Attaches the specified storage volume to the specified instance.
|
static ComputeClient.Builder |
builder()
Create a builder for this client.
|
CaptureConsoleHistoryResponse |
captureConsoleHistory(CaptureConsoleHistoryRequest request)
Captures the most recent serial console data (up to a megabyte) for the specified instance.
|
ChangeDedicatedVmHostCompartmentResponse |
changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)
Moves a dedicated virtual machine host from one compartment to another.
|
ChangeImageCompartmentResponse |
changeImageCompartment(ChangeImageCompartmentRequest request)
Moves an image into a different compartment within the same tenancy.
|
ChangeInstanceCompartmentResponse |
changeInstanceCompartment(ChangeInstanceCompartmentRequest request)
Moves an instance into a different compartment within the same tenancy.
|
void |
close() |
CreateAppCatalogSubscriptionResponse |
createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)
Create a subscription for listing resource version for a compartment.
|
CreateDedicatedVmHostResponse |
createDedicatedVmHost(CreateDedicatedVmHostRequest request)
Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.
|
CreateImageResponse |
createImage(CreateImageRequest request)
Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
|
CreateInstanceConsoleConnectionResponse |
createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request)
Creates a new console connection to the specified instance.
|
DeleteAppCatalogSubscriptionResponse |
deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)
Delete a subscription for a listing resource version for a compartment.
|
DeleteConsoleHistoryResponse |
deleteConsoleHistory(DeleteConsoleHistoryRequest request)
Deletes the specified console history metadata and the console history data.
|
DeleteDedicatedVmHostResponse |
deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request)
Deletes the specified dedicated virtual machine host.
|
DeleteImageResponse |
deleteImage(DeleteImageRequest request)
Deletes an image.
|
DeleteInstanceConsoleConnectionResponse |
deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)
Deletes the specified instance console connection.
|
DetachBootVolumeResponse |
detachBootVolume(DetachBootVolumeRequest request)
Detaches a boot volume from an instance.
|
DetachVnicResponse |
detachVnic(DetachVnicRequest request)
Detaches and deletes the specified secondary VNIC.
|
DetachVolumeResponse |
detachVolume(DetachVolumeRequest request)
Detaches a storage volume from an instance.
|
ExportImageResponse |
exportImage(ExportImageRequest request)
Exports the specified image to the Oracle Cloud Infrastructure Object Storage service.
|
GetAppCatalogListingResponse |
getAppCatalogListing(GetAppCatalogListingRequest request)
Gets the specified listing.
|
GetAppCatalogListingAgreementsResponse |
getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)
Retrieves the agreements for a particular resource version of a listing.
|
GetAppCatalogListingResourceVersionResponse |
getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)
Gets the specified listing resource version.
|
GetBootVolumeAttachmentResponse |
getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)
Gets information about the specified boot volume attachment.
|
GetConsoleHistoryResponse |
getConsoleHistory(GetConsoleHistoryRequest request)
Shows the metadata for the specified console history.
|
GetConsoleHistoryContentResponse |
getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
Gets the actual console history data (not the metadata).
|
GetDedicatedVmHostResponse |
getDedicatedVmHost(GetDedicatedVmHostRequest request)
Gets information about the specified dedicated virtual machine host.
|
GetImageResponse |
getImage(GetImageRequest request)
Gets the specified image.
|
GetInstanceResponse |
getInstance(GetInstanceRequest request)
Gets information about the specified instance.
|
GetInstanceConsoleConnectionResponse |
getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)
Gets the specified instance console connection’s information.
|
ComputePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetVnicAttachmentResponse |
getVnicAttachment(GetVnicAttachmentRequest request)
Gets the information for the specified VNIC attachment.
|
GetVolumeAttachmentResponse |
getVolumeAttachment(GetVolumeAttachmentRequest request)
Gets information about the specified volume attachment.
|
ComputeWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWindowsInstanceInitialCredentialsResponse |
getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)
Gets the generated credentials for the instance.
|
InstanceActionResponse |
instanceAction(InstanceActionRequest request)
Performs one of the following power actions on the specified instance:
|
LaunchInstanceResponse |
launchInstance(LaunchInstanceRequest request)
Creates a new instance in the specified compartment and the specified availability domain.
|
ListAppCatalogListingResourceVersionsResponse |
listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)
Gets all resource versions for a particular listing.
|
ListAppCatalogListingsResponse |
listAppCatalogListings(ListAppCatalogListingsRequest request)
Lists the published listings.
|
ListAppCatalogSubscriptionsResponse |
listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)
Lists subscriptions for a compartment.
|
ListBootVolumeAttachmentsResponse |
listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request)
Lists the boot volume attachments in the specified compartment.
|
ListConsoleHistoriesResponse |
listConsoleHistories(ListConsoleHistoriesRequest request)
Lists the console history metadata for the specified compartment or instance.
|
ListDedicatedVmHostInstancesResponse |
listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
|
ListDedicatedVmHostInstanceShapesResponse |
listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request)
Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.
|
ListDedicatedVmHostsResponse |
listDedicatedVmHosts(ListDedicatedVmHostsRequest request)
Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.
|
ListDedicatedVmHostShapesResponse |
listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
|
ListImagesResponse |
listImages(ListImagesRequest request)
Lists the available images in the specified compartment, including both Oracle-provided images and custom images that have been created.
|
ListInstanceConsoleConnectionsResponse |
listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)
Lists the console connections for the specified compartment or instance.
|
ListInstanceDevicesResponse |
listInstanceDevices(ListInstanceDevicesRequest request)
Gets a list of all the devices for given instance.
|
ListInstancesResponse |
listInstances(ListInstancesRequest request)
Lists the instances in the specified compartment and the specified availability domain.
|
ListShapesResponse |
listShapes(ListShapesRequest request)
Lists the shapes that can be used to launch an instance within the specified compartment.
|
ListVnicAttachmentsResponse |
listVnicAttachments(ListVnicAttachmentsRequest request)
Lists the VNIC attachments in the specified compartment.
|
ListVolumeAttachmentsResponse |
listVolumeAttachments(ListVolumeAttachmentsRequest request)
Lists the volume attachments in the specified compartment.
|
ComputeWaiters |
newWaiters(WorkRequest workRequestClient)
Creates a new
ComputeWaiters for resources for this service. |
RemoveImageShapeCompatibilityEntryResponse |
removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)
Removes a shape from the compatible shapes list for the image.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
TerminateInstanceResponse |
terminateInstance(TerminateInstanceRequest request)
Terminates the specified instance.
|
UpdateConsoleHistoryResponse |
updateConsoleHistory(UpdateConsoleHistoryRequest request)
Updates the specified console history metadata.
|
UpdateDedicatedVmHostResponse |
updateDedicatedVmHost(UpdateDedicatedVmHostRequest request)
Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.
|
UpdateImageResponse |
updateImage(UpdateImageRequest request)
Updates the display name of the image.
|
UpdateInstanceResponse |
updateInstance(UpdateInstanceRequest request)
Updates certain fields on the specified instance.
|
public static final Service SERVICE
Service instance for Compute.
public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorpublic static ComputeClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Compute
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Compute
endpoint
- The endpoint of the service.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 void close()
close
in interface AutoCloseable
public 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 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 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.
When importing an exported image from Object Storage, you specify the source information in imageSourceDetails
.
When importing an image based on the namespace, bucket name, and object name, use imageSourceViaObjectStorageTupleDetails
.
When importing an image based on the Object Storage URL, use imageSourceViaObjectStorageUriDetails
. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
For more information about importing exported images, see Image Import/Export.
You may optionally specify a display name for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See updateImage
. Avoid entering confidential information.
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 console access, see Accessing the Console.
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 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, 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.
To perform an image export, you need write access to the Object Storage bucket for the image, see Let Users Write Objects to Object Storage Buckets.
See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
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 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 GetInstanceResponse getInstance(GetInstanceRequest request)
Compute
Gets information about the specified instance.
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 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 password to log in (E.g. Windows). For certain OS’es, 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.
- SOFTRESET - Gracefully reboots instance by sending a shutdown command to the operating system and then powers the instance back on.
- SOFTSTOP - Gracefully shuts down instance by sending a shutdown command to the operating system.
- RESET - Powers off the instance and then powers it back on.
For more information see Stopping and Starting an Instance.
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.
For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
To launch an instance using an image or a boot volume use the sourceDetails
parameter in LaunchInstanceDetails
.
When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the primary VNIC. The VNIC has a private IP address from the subnet’s CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the listVnicAttachments
operation to get the VNIC ID for the instance, and then call getVnic
with the VNIC ID.
You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs).
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 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 ListImagesResponse listImages(ListImagesRequest request)
Compute
Lists the available images in the specified compartment, including both Oracle-provided images and custom images that have been created. The list of images returned is ordered to first show all Oracle-provided images, then all custom images.
The order of images returned may change when new images are released.
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 console access, see Accessing the Console.
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 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).
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
Terminates the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates.
To preserve the boot volume associated with the instance, specify true
for PreserveBootVolumeQueryParam
. To delete the boot volume when the instance is deleted, specify false
or do not specify a value for PreserveBootVolumeQueryParam
.
This is an asynchronous operation. The instance’s lifecycleState
will change to TERMINATING temporarily until the instance is completely removed.
terminateInstance
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 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
Copyright © 2016–2020. All rights reserved.