Class ComputeClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.core.ComputeClient
-
- All Implemented Interfaces:
Compute,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeClient extends BaseSyncClient implements Compute
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classComputeClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.protected ExecutorServiceexecutorServiceOptional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Compute.
-
Constructor Summary
Constructors Constructor Description ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.core.Compute
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Field Detail
-
SERVICE
public static final Service SERVICE
Service instance for Compute.
-
executorService
protected final ExecutorService executorService
-
clientCommonLibraryVersion
public final String clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
-
-
Constructor Detail
-
ComputeClient
@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ComputeClient
@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ComputeClient
@Deprecated public ComputeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ComputeClient
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ComputeClient
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ComputeClient
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
ComputeClient
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
ComputeClient
@Deprecated public ComputeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-ComputeClient.Builder.executorService
-
-
Method Detail
-
builder
public static ComputeClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ComputeSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ComputeSets 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 callsetEndpoint.
-
acceptShieldedIntegrityPolicy
public AcceptShieldedIntegrityPolicyResponse acceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest request)
Description copied from interface:ComputeAccept the changes to the PCR values in the measured boot report.- Specified by:
acceptShieldedIntegrityPolicyin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addImageShapeCompatibilityEntry
public AddImageShapeCompatibilityEntryResponse addImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request)
Description copied from interface:ComputeAdds a shape to the compatible shapes list for the image.- Specified by:
addImageShapeCompatibilityEntryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachBootVolume
public AttachBootVolumeResponse attachBootVolume(AttachBootVolumeRequest request)
Description copied from interface:ComputeAttaches the specified boot volume to the specified instance.- Specified by:
attachBootVolumein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachComputeHostGroupHost
public AttachComputeHostGroupHostResponse attachComputeHostGroupHost(AttachComputeHostGroupHostRequest request)
Description copied from interface:ComputeAttaches the Compute BM Host to a Host group- Specified by:
attachComputeHostGroupHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachVnic
public AttachVnicResponse attachVnic(AttachVnicRequest request)
Description copied from interface:ComputeCreates a secondary VNIC and attaches it to the specified instance.For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
- Specified by:
attachVnicin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachVolume
public AttachVolumeResponse attachVolume(AttachVolumeRequest request)
Description copied from interface:ComputeAttaches the specified storage volume to the specified instance.- Specified by:
attachVolumein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
captureConsoleHistory
public CaptureConsoleHistoryResponse captureConsoleHistory(CaptureConsoleHistoryRequest request)
Description copied from interface:ComputeCaptures 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.
- Specified by:
captureConsoleHistoryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeCapacityReservationCompartment
public ChangeComputeCapacityReservationCompartmentResponse changeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest request)
Description copied from interface:ComputeMoves a compute capacity reservation into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeCapacityReservationCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeCapacityTopologyCompartment
public ChangeComputeCapacityTopologyCompartmentResponse changeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest request)
Description copied from interface:ComputeMoves a compute capacity topology into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeCapacityTopologyCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeClusterCompartment
public ChangeComputeClusterCompartmentResponse changeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest request)
Description copied from interface:ComputeMoves 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.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
- Specified by:
changeComputeClusterCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeGpuMemoryClusterCompartment
public ChangeComputeGpuMemoryClusterCompartmentResponse changeComputeGpuMemoryClusterCompartment(ChangeComputeGpuMemoryClusterCompartmentRequest request)
Description copied from interface:ComputeMoves a compute GPU memory cluster into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeGpuMemoryClusterCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeGpuMemoryFabricCompartment
public ChangeComputeGpuMemoryFabricCompartmentResponse changeComputeGpuMemoryFabricCompartment(ChangeComputeGpuMemoryFabricCompartmentRequest request)
Description copied from interface:ComputeMoves a compute GPU memory fabric into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeGpuMemoryFabricCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeHostCompartment
public ChangeComputeHostCompartmentResponse changeComputeHostCompartment(ChangeComputeHostCompartmentRequest request)
Description copied from interface:ComputeMoves a compute host into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeHostCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeHostGroupCompartment
public ChangeComputeHostGroupCompartmentResponse changeComputeHostGroupCompartment(ChangeComputeHostGroupCompartmentRequest request)
Description copied from interface:ComputeMoves a compute host group into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeComputeHostGroupCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeComputeImageCapabilitySchemaCompartment
public ChangeComputeImageCapabilitySchemaCompartmentResponse changeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest request)
Description copied from interface:ComputeMoves 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.
- Specified by:
changeComputeImageCapabilitySchemaCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDedicatedVmHostCompartment
public ChangeDedicatedVmHostCompartmentResponse changeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request)
Description copied from interface:ComputeMoves a dedicated virtual machine host from one compartment to another.- Specified by:
changeDedicatedVmHostCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeImageCompartment
public ChangeImageCompartmentResponse changeImageCompartment(ChangeImageCompartmentRequest request)
Description copied from interface:ComputeMoves an image into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeImageCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeInstanceCompartment
public ChangeInstanceCompartmentResponse changeInstanceCompartment(ChangeInstanceCompartmentRequest request)
Description copied from interface:ComputeMoves 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.
- Specified by:
changeInstanceCompartmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAppCatalogSubscription
public CreateAppCatalogSubscriptionResponse createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request)
Description copied from interface:ComputeCreate a subscription for listing resource version for a compartment.It will take some time to propagate to all regions.
- Specified by:
createAppCatalogSubscriptionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeCapacityReport
public CreateComputeCapacityReportResponse createComputeCapacityReport(CreateComputeCapacityReportRequest request)
Description copied from interface:ComputeGenerates 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.
- Specified by:
createComputeCapacityReportin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeCapacityReservation
public CreateComputeCapacityReservationResponse createComputeCapacityReservation(CreateComputeCapacityReservationRequest request)
Description copied from interface:ComputeCreates 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.
- Specified by:
createComputeCapacityReservationin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeCapacityTopology
public CreateComputeCapacityTopologyResponse createComputeCapacityTopology(CreateComputeCapacityTopologyRequest request)
Description copied from interface:ComputeCreates 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.
- Specified by:
createComputeCapacityTopologyin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeCluster
public CreateComputeClusterResponse createComputeCluster(CreateComputeClusterRequest request)
Description copied from interface:ComputeCreates 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
launchInstanceoperation 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
createClusterNetworkoperation.- Specified by:
createComputeClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeGpuMemoryCluster
public CreateComputeGpuMemoryClusterResponse createComputeGpuMemoryCluster(CreateComputeGpuMemoryClusterRequest request)
Description copied from interface:ComputeCreate a compute GPU memory cluster instance on a specific compute GPU memory fabric- Specified by:
createComputeGpuMemoryClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeHostGroup
public CreateComputeHostGroupResponse createComputeHostGroup(CreateComputeHostGroupRequest request)
Description copied from interface:ComputeCreates a new compute host group in the specified compartment and availability domain.- Specified by:
createComputeHostGroupin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createComputeImageCapabilitySchema
public CreateComputeImageCapabilitySchemaResponse createComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest request)
Description copied from interface:ComputeCreates compute image capability schema.- Specified by:
createComputeImageCapabilitySchemain interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDedicatedVmHost
public CreateDedicatedVmHostResponse createDedicatedVmHost(CreateDedicatedVmHostRequest request)
Description copied from interface:ComputeCreates 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.
- Specified by:
createDedicatedVmHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createImage
public CreateImageResponse createImage(CreateImageRequest request)
Description copied from interface:ComputeCreates 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.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.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.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.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.- Specified by:
createImagein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createInstanceConsoleConnection
public CreateInstanceConsoleConnectionResponse createInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request)
Description copied from interface:ComputeCreates 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.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
- Specified by:
createInstanceConsoleConnectionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAppCatalogSubscription
public DeleteAppCatalogSubscriptionResponse deleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request)
Description copied from interface:ComputeDelete a subscription for a listing resource version for a compartment.- Specified by:
deleteAppCatalogSubscriptionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeCapacityReservation
public DeleteComputeCapacityReservationResponse deleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest request)
Description copied from interface:ComputeDeletes the specified compute capacity reservation.- Specified by:
deleteComputeCapacityReservationin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeCapacityTopology
public DeleteComputeCapacityTopologyResponse deleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest request)
Description copied from interface:ComputeDeletes the specified compute capacity topology.- Specified by:
deleteComputeCapacityTopologyin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeCluster
public DeleteComputeClusterResponse deleteComputeCluster(DeleteComputeClusterRequest request)
Description copied from interface:ComputeDeletes 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
terminateInstanceoperation.- Specified by:
deleteComputeClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeGpuMemoryCluster
public DeleteComputeGpuMemoryClusterResponse deleteComputeGpuMemoryCluster(DeleteComputeGpuMemoryClusterRequest request)
Description copied from interface:ComputeTerminates and deletes the specified compute GPU memory cluster and underlying instances.- Specified by:
deleteComputeGpuMemoryClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeHostGroup
public DeleteComputeHostGroupResponse deleteComputeHostGroup(DeleteComputeHostGroupRequest request)
Description copied from interface:ComputeDeletes the specified compute host group- Specified by:
deleteComputeHostGroupin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteComputeImageCapabilitySchema
public DeleteComputeImageCapabilitySchemaResponse deleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest request)
Description copied from interface:ComputeDeletes the specified Compute Image Capability Schema- Specified by:
deleteComputeImageCapabilitySchemain interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConsoleHistory
public DeleteConsoleHistoryResponse deleteConsoleHistory(DeleteConsoleHistoryRequest request)
Description copied from interface:ComputeDeletes the specified console history metadata and the console history data.- Specified by:
deleteConsoleHistoryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDedicatedVmHost
public DeleteDedicatedVmHostResponse deleteDedicatedVmHost(DeleteDedicatedVmHostRequest request)
Description copied from interface:ComputeDeletes 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.
- Specified by:
deleteDedicatedVmHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteImage
public DeleteImageResponse deleteImage(DeleteImageRequest request)
Description copied from interface:ComputeDeletes an image.- Specified by:
deleteImagein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteInstanceConsoleConnection
public DeleteInstanceConsoleConnectionResponse deleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request)
Description copied from interface:ComputeDeletes the specified instance console connection.- Specified by:
deleteInstanceConsoleConnectionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachBootVolume
public DetachBootVolumeResponse detachBootVolume(DetachBootVolumeRequest request)
Description copied from interface:ComputeDetaches 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.
- Specified by:
detachBootVolumein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachComputeHostGroupHost
public DetachComputeHostGroupHostResponse detachComputeHostGroupHost(DetachComputeHostGroupHostRequest request)
Description copied from interface:ComputeDetaches the specified bare metal host from the compute host group- Specified by:
detachComputeHostGroupHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachVnic
public DetachVnicResponse detachVnic(DetachVnicRequest request)
Description copied from interface:ComputeDetaches 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
PrivateIpthat is the [target of a route rule](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.- Specified by:
detachVnicin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachVolume
public DetachVolumeResponse detachVolume(DetachVolumeRequest request)
Description copied from interface:ComputeDetaches 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.
- Specified by:
detachVolumein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportImage
public ExportImageResponse exportImage(ExportImageRequest request)
Description copied from interface:ComputeExports 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.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.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](https://docs.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.
- Specified by:
exportImagein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAppCatalogListing
public GetAppCatalogListingResponse getAppCatalogListing(GetAppCatalogListingRequest request)
Description copied from interface:ComputeGets the specified listing.- Specified by:
getAppCatalogListingin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAppCatalogListingAgreements
public GetAppCatalogListingAgreementsResponse getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request)
Description copied from interface:ComputeRetrieves the agreements for a particular resource version of a listing.- Specified by:
getAppCatalogListingAgreementsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAppCatalogListingResourceVersion
public GetAppCatalogListingResourceVersionResponse getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request)
Description copied from interface:ComputeGets the specified listing resource version.- Specified by:
getAppCatalogListingResourceVersionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBootVolumeAttachment
public GetBootVolumeAttachmentResponse getBootVolumeAttachment(GetBootVolumeAttachmentRequest request)
Description copied from interface:ComputeGets information about the specified boot volume attachment.- Specified by:
getBootVolumeAttachmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeCapacityReservation
public GetComputeCapacityReservationResponse getComputeCapacityReservation(GetComputeCapacityReservationRequest request)
Description copied from interface:ComputeGets information about the specified compute capacity reservation.- Specified by:
getComputeCapacityReservationin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeCapacityTopology
public GetComputeCapacityTopologyResponse getComputeCapacityTopology(GetComputeCapacityTopologyRequest request)
Description copied from interface:ComputeGets information about the specified compute capacity topology.- Specified by:
getComputeCapacityTopologyin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeCluster
public GetComputeClusterResponse getComputeCluster(GetComputeClusterRequest request)
Description copied from interface:ComputeGets information about a compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
- Specified by:
getComputeClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeGlobalImageCapabilitySchema
public GetComputeGlobalImageCapabilitySchemaResponse getComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest request)
Description copied from interface:ComputeGets the specified Compute Global Image Capability Schema- Specified by:
getComputeGlobalImageCapabilitySchemain interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeGlobalImageCapabilitySchemaVersion
public GetComputeGlobalImageCapabilitySchemaVersionResponse getComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest request)
Description copied from interface:ComputeGets the specified Compute Global Image Capability Schema Version- Specified by:
getComputeGlobalImageCapabilitySchemaVersionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeGpuMemoryCluster
public GetComputeGpuMemoryClusterResponse getComputeGpuMemoryCluster(GetComputeGpuMemoryClusterRequest request)
Description copied from interface:ComputeGets information about the specified compute GPU memory cluster- Specified by:
getComputeGpuMemoryClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeGpuMemoryFabric
public GetComputeGpuMemoryFabricResponse getComputeGpuMemoryFabric(GetComputeGpuMemoryFabricRequest request)
Description copied from interface:ComputeGets information about the specified compute GPU memory fabric- Specified by:
getComputeGpuMemoryFabricin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeHost
public GetComputeHostResponse getComputeHost(GetComputeHostRequest request)
Description copied from interface:ComputeGets information about the specified compute host- Specified by:
getComputeHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeHostGroup
public GetComputeHostGroupResponse getComputeHostGroup(GetComputeHostGroupRequest request)
Description copied from interface:ComputeGets information about the specified compute host group- Specified by:
getComputeHostGroupin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getComputeImageCapabilitySchema
public GetComputeImageCapabilitySchemaResponse getComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest request)
Description copied from interface:ComputeGets the specified Compute Image Capability Schema- Specified by:
getComputeImageCapabilitySchemain interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConsoleHistory
public GetConsoleHistoryResponse getConsoleHistory(GetConsoleHistoryRequest request)
Description copied from interface:ComputeShows the metadata for the specified console history.See
captureConsoleHistoryfor details about using the console history operations.- Specified by:
getConsoleHistoryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConsoleHistoryContent
public GetConsoleHistoryContentResponse getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
Description copied from interface:ComputeGets the actual console history data (not the metadata).See
captureConsoleHistoryfor details about using the console history operations.- Specified by:
getConsoleHistoryContentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDedicatedVmHost
public GetDedicatedVmHostResponse getDedicatedVmHost(GetDedicatedVmHostRequest request)
Description copied from interface:ComputeGets information about the specified dedicated virtual machine host.- Specified by:
getDedicatedVmHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getImage
public GetImageResponse getImage(GetImageRequest request)
Description copied from interface:ComputeGets the specified image.
-
getImageShapeCompatibilityEntry
public GetImageShapeCompatibilityEntryResponse getImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest request)
Description copied from interface:ComputeRetrieves an image shape compatibility entry.- Specified by:
getImageShapeCompatibilityEntryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstance
public GetInstanceResponse getInstance(GetInstanceRequest request)
Description copied from interface:ComputeGets information about the specified instance.*Note:** To retrieve public and private IP addresses for an instance, use the
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.- Specified by:
getInstancein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstanceConsoleConnection
public GetInstanceConsoleConnectionResponse getInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request)
Description copied from interface:ComputeGets the specified instance console connection’s information.- Specified by:
getInstanceConsoleConnectionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstanceMaintenanceEvent
public GetInstanceMaintenanceEventResponse getInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest request)
Description copied from interface:ComputeGets the maintenance event for the given instance.- Specified by:
getInstanceMaintenanceEventin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstanceMaintenanceReboot
public GetInstanceMaintenanceRebootResponse getInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest request)
Description copied from interface:ComputeGets the maximum possible date that a maintenance reboot can be extended.For more information, see Infrastructure Maintenance.
- Specified by:
getInstanceMaintenanceRebootin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMeasuredBootReport
public GetMeasuredBootReportResponse getMeasuredBootReport(GetMeasuredBootReportRequest request)
Description copied from interface:ComputeGets the measured boot report for this shielded instance.- Specified by:
getMeasuredBootReportin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVnicAttachment
public GetVnicAttachmentResponse getVnicAttachment(GetVnicAttachmentRequest request)
Description copied from interface:ComputeGets the information for the specified VNIC attachment.- Specified by:
getVnicAttachmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVolumeAttachment
public GetVolumeAttachmentResponse getVolumeAttachment(GetVolumeAttachmentRequest request)
Description copied from interface:ComputeGets information about the specified volume attachment.- Specified by:
getVolumeAttachmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWindowsInstanceInitialCredentials
public GetWindowsInstanceInitialCredentialsResponse getWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request)
Description copied from interface:ComputeGets 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.
- Specified by:
getWindowsInstanceInitialCredentialsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
instanceAction
public InstanceActionResponse instanceAction(InstanceActionRequest request)
Description copied from interface:ComputePerforms 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.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.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.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.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.oracle.com/iaas/Content/Compute/Tasks/restartinginstance.htm).
- Specified by:
instanceActionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
launchInstance
public LaunchInstanceResponse launchInstance(LaunchInstanceRequest request)
Description copied from interface:ComputeCreates 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.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.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
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.You can later add secondary VNICs to an instance. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.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
getAppCatalogListingAgreementsoperation to get the signature for the terms of use agreement for the desired listing resource version. Then, callcreateAppCatalogSubscriptionwith the signature. To get the image ID for the LaunchInstance operation, callgetAppCatalogListingResourceVersion.When launching an instance, you may provide the `securityAttributes` parameter in
LaunchInstanceDetailsto manage security attributes via the instance, or in the embeddedCreateVnicDetailsto 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
createComputeCapacityReportoperation.- Specified by:
launchInstancein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAppCatalogListingResourceVersions
public ListAppCatalogListingResourceVersionsResponse listAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request)
Description copied from interface:ComputeGets all resource versions for a particular listing.- Specified by:
listAppCatalogListingResourceVersionsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAppCatalogListings
public ListAppCatalogListingsResponse listAppCatalogListings(ListAppCatalogListingsRequest request)
Description copied from interface:ComputeLists the published listings.- Specified by:
listAppCatalogListingsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAppCatalogSubscriptions
public ListAppCatalogSubscriptionsResponse listAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request)
Description copied from interface:ComputeLists subscriptions for a compartment.- Specified by:
listAppCatalogSubscriptionsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBootVolumeAttachments
public ListBootVolumeAttachmentsResponse listBootVolumeAttachments(ListBootVolumeAttachmentsRequest request)
Description copied from interface:ComputeLists the boot volume attachments in the specified compartment.You can filter the list by specifying an instance OCID, boot volume OCID, or both.
- Specified by:
listBootVolumeAttachmentsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityReservationInstanceShapes
public ListComputeCapacityReservationInstanceShapesResponse listComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest request)
Description copied from interface:ComputeLists the shapes that can be reserved within the specified compartment.- Specified by:
listComputeCapacityReservationInstanceShapesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityReservationInstances
public ListComputeCapacityReservationInstancesResponse listComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest request)
Description copied from interface:ComputeLists the instances launched under a capacity reservation.You can filter results by specifying criteria.
- Specified by:
listComputeCapacityReservationInstancesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityReservations
public ListComputeCapacityReservationsResponse listComputeCapacityReservations(ListComputeCapacityReservationsRequest request)
Description copied from interface:ComputeLists 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).
- Specified by:
listComputeCapacityReservationsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityTopologies
public ListComputeCapacityTopologiesResponse listComputeCapacityTopologies(ListComputeCapacityTopologiesRequest request)
Description copied from interface:ComputeLists the compute capacity topologies in the specified compartment.You can filter the list by a compute capacity topology display name.
- Specified by:
listComputeCapacityTopologiesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityTopologyComputeBareMetalHosts
public ListComputeCapacityTopologyComputeBareMetalHostsResponse listComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest request)
Description copied from interface:ComputeLists compute bare metal hosts in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeBareMetalHostsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityTopologyComputeHpcIslands
public ListComputeCapacityTopologyComputeHpcIslandsResponse listComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest request)
Description copied from interface:ComputeLists compute HPC islands in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeHpcIslandsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeCapacityTopologyComputeNetworkBlocks
public ListComputeCapacityTopologyComputeNetworkBlocksResponse listComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest request)
Description copied from interface:ComputeLists compute network blocks in the specified compute capacity topology.- Specified by:
listComputeCapacityTopologyComputeNetworkBlocksin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeClusters
public ListComputeClustersResponse listComputeClusters(ListComputeClustersRequest request)
Description copied from interface:ComputeLists the compute clusters in the specified compartment.A compute cluster is a remote direct memory access (RDMA) network group.
- Specified by:
listComputeClustersin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeGlobalImageCapabilitySchemaVersions
public ListComputeGlobalImageCapabilitySchemaVersionsResponse listComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest request)
Description copied from interface:ComputeLists Compute Global Image Capability Schema versions in the specified compartment.- Specified by:
listComputeGlobalImageCapabilitySchemaVersionsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeGlobalImageCapabilitySchemas
public ListComputeGlobalImageCapabilitySchemasResponse listComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest request)
Description copied from interface:ComputeLists Compute Global Image Capability Schema in the specified compartment.- Specified by:
listComputeGlobalImageCapabilitySchemasin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeGpuMemoryClusterInstances
public ListComputeGpuMemoryClusterInstancesResponse listComputeGpuMemoryClusterInstances(ListComputeGpuMemoryClusterInstancesRequest request)
Description copied from interface:ComputeList all of the GPU memory cluster instances.- Specified by:
listComputeGpuMemoryClusterInstancesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeGpuMemoryClusters
public ListComputeGpuMemoryClustersResponse listComputeGpuMemoryClusters(ListComputeGpuMemoryClustersRequest request)
Description copied from interface:ComputeList all of the compute GPU memory clusters.- Specified by:
listComputeGpuMemoryClustersin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeGpuMemoryFabrics
public ListComputeGpuMemoryFabricsResponse listComputeGpuMemoryFabrics(ListComputeGpuMemoryFabricsRequest request)
Description copied from interface:ComputeLists the compute GPU memory fabrics that match the specified criteria and compartmentId.- Specified by:
listComputeGpuMemoryFabricsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeHostGroups
public ListComputeHostGroupsResponse listComputeHostGroups(ListComputeHostGroupsRequest request)
Description copied from interface:ComputeLists the compute host groups that match the specified criteria and compartment.- Specified by:
listComputeHostGroupsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeHosts
public ListComputeHostsResponse listComputeHosts(ListComputeHostsRequest request)
Description copied from interface:ComputeGenerates a list of summary host details- Specified by:
listComputeHostsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listComputeImageCapabilitySchemas
public ListComputeImageCapabilitySchemasResponse listComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest request)
Description copied from interface:ComputeLists Compute Image Capability Schema in the specified compartment.You can also query by a specific imageId.
- Specified by:
listComputeImageCapabilitySchemasin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConsoleHistories
public ListConsoleHistoriesResponse listConsoleHistories(ListConsoleHistoriesRequest request)
Description copied from interface:ComputeLists the console history metadata for the specified compartment or instance.- Specified by:
listConsoleHistoriesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDedicatedVmHostInstanceShapes
public ListDedicatedVmHostInstanceShapesResponse listDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request)
Description copied from interface:ComputeLists 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.
- Specified by:
listDedicatedVmHostInstanceShapesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDedicatedVmHostInstances
public ListDedicatedVmHostInstancesResponse listDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request)
Description copied from interface:ComputeReturns the list of instances on the dedicated virtual machine hosts that match the specified criteria.- Specified by:
listDedicatedVmHostInstancesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDedicatedVmHostShapes
public ListDedicatedVmHostShapesResponse listDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request)
Description copied from interface:ComputeLists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.- Specified by:
listDedicatedVmHostShapesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDedicatedVmHosts
public ListDedicatedVmHostsResponse listDedicatedVmHosts(ListDedicatedVmHostsRequest request)
Description copied from interface:ComputeReturns 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.
- Specified by:
listDedicatedVmHostsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listImageShapeCompatibilityEntries
public ListImageShapeCompatibilityEntriesResponse listImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest request)
Description copied from interface:ComputeLists the compatible shapes for the specified image.- Specified by:
listImageShapeCompatibilityEntriesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listImages
public ListImagesResponse listImages(ListImagesRequest request)
Description copied from interface:ComputeLists 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.
- Specified by:
listImagesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstanceConsoleConnections
public ListInstanceConsoleConnectionsResponse listInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request)
Description copied from interface:ComputeLists 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.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
- Specified by:
listInstanceConsoleConnectionsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstanceDevices
public ListInstanceDevicesResponse listInstanceDevices(ListInstanceDevicesRequest request)
Description copied from interface:ComputeGets a list of all the devices for given instance.You can optionally filter results by device availability.
- Specified by:
listInstanceDevicesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstanceMaintenanceEvents
public ListInstanceMaintenanceEventsResponse listInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest request)
Description copied from interface:ComputeGets a list of all the maintenance events for the given compartment.- Specified by:
listInstanceMaintenanceEventsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstances
public ListInstancesResponse listInstances(ListInstancesRequest request)
Description copied from interface:ComputeLists 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
listVnicAttachmentsoperation to get the VNIC ID for the instance, and then callgetVnicwith the VNIC ID.- Specified by:
listInstancesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listShapes
public ListShapesResponse listShapes(ListShapesRequest request)
Description copied from interface:ComputeLists 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.
- Specified by:
listShapesin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVnicAttachments
public ListVnicAttachmentsResponse listVnicAttachments(ListVnicAttachmentsRequest request)
Description copied from interface:ComputeLists 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.
- Specified by:
listVnicAttachmentsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVolumeAttachments
public ListVolumeAttachmentsResponse listVolumeAttachments(ListVolumeAttachmentsRequest request)
Description copied from interface:ComputeLists 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
IScsiVolumeAttachmentandParavirtualizedVolumeAttachment.- Specified by:
listVolumeAttachmentsin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeImageShapeCompatibilityEntry
public RemoveImageShapeCompatibilityEntryResponse removeImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request)
Description copied from interface:ComputeRemoves a shape from the compatible shapes list for the image.- Specified by:
removeImageShapeCompatibilityEntryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
terminateInstance
public TerminateInstanceResponse terminateInstance(TerminateInstanceRequest request)
Description copied from interface:ComputePermanently 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.
- Specified by:
terminateInstancein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeCapacityReservation
public UpdateComputeCapacityReservationResponse updateComputeCapacityReservation(UpdateComputeCapacityReservationRequest request)
Description copied from interface:ComputeUpdates 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.
- Specified by:
updateComputeCapacityReservationin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeCapacityTopology
public UpdateComputeCapacityTopologyResponse updateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest request)
Description copied from interface:ComputeUpdates the specified compute capacity topology.Fields that are not provided in the request will not be updated.
- Specified by:
updateComputeCapacityTopologyin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeCluster
public UpdateComputeClusterResponse updateComputeCluster(UpdateComputeClusterRequest request)
Description copied from interface:ComputeUpdates a compute cluster.A compute cluster is a remote direct memory access (RDMA) network group.
To create instances within a compute cluster, use the
launchInstanceoperation.To delete instances from a compute cluster, use the
terminateInstanceoperation.- Specified by:
updateComputeClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeGpuMemoryCluster
public UpdateComputeGpuMemoryClusterResponse updateComputeGpuMemoryCluster(UpdateComputeGpuMemoryClusterRequest request)
Description copied from interface:ComputeUpdates a compute gpu memory cluster resource.- Specified by:
updateComputeGpuMemoryClusterin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeGpuMemoryFabric
public UpdateComputeGpuMemoryFabricResponse updateComputeGpuMemoryFabric(UpdateComputeGpuMemoryFabricRequest request)
Description copied from interface:ComputeCustomer can update displayName, tags and for compute GPU memory fabric record- Specified by:
updateComputeGpuMemoryFabricin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeHost
public UpdateComputeHostResponse updateComputeHost(UpdateComputeHostRequest request)
Description copied from interface:ComputeCustomer can update the some fields for ComputeHost record- Specified by:
updateComputeHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeHostGroup
public UpdateComputeHostGroupResponse updateComputeHostGroup(UpdateComputeHostGroupRequest request)
Description copied from interface:ComputeUpdates the specified compute host group details.- Specified by:
updateComputeHostGroupin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateComputeImageCapabilitySchema
public UpdateComputeImageCapabilitySchemaResponse updateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest request)
Description copied from interface:ComputeUpdates the specified Compute Image Capability Schema- Specified by:
updateComputeImageCapabilitySchemain interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConsoleHistory
public UpdateConsoleHistoryResponse updateConsoleHistory(UpdateConsoleHistoryRequest request)
Description copied from interface:ComputeUpdates the specified console history metadata.- Specified by:
updateConsoleHistoryin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDedicatedVmHost
public UpdateDedicatedVmHostResponse updateDedicatedVmHost(UpdateDedicatedVmHostRequest request)
Description copied from interface:ComputeUpdates 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.
- Specified by:
updateDedicatedVmHostin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateImage
public UpdateImageResponse updateImage(UpdateImageRequest request)
Description copied from interface:ComputeUpdates the display name of the image.Avoid entering confidential information.
- Specified by:
updateImagein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInstance
public UpdateInstanceResponse updateInstance(UpdateInstanceRequest request)
Description copied from interface:ComputeUpdates 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.
- Specified by:
updateInstancein interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInstanceConsoleConnection
public UpdateInstanceConsoleConnectionResponse updateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest request)
Description copied from interface:ComputeUpdates the defined tags and free-form tags for the specified instance console connection.- Specified by:
updateInstanceConsoleConnectionin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInstanceMaintenanceEvent
public UpdateInstanceMaintenanceEventResponse updateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest request)
Description copied from interface:ComputeUpdates the maintenance event for the given instance.- Specified by:
updateInstanceMaintenanceEventin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateVolumeAttachment
public UpdateVolumeAttachmentResponse updateVolumeAttachment(UpdateVolumeAttachmentRequest request)
Description copied from interface:ComputeUpdates information about the specified volume attachment.- Specified by:
updateVolumeAttachmentin interfaceCompute- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public ComputeWaiters getWaiters()
Description copied from interface:ComputeGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceCompute- Returns:
- The service waiters.
-
newWaiters
public ComputeWaiters newWaiters(WorkRequest workRequestClient)
Description copied from interface:ComputeCreates a new ComputeWaiters for resources for this service.- Specified by:
newWaitersin interfaceCompute- Parameters:
workRequestClient- The work request service client used to query for work request status- Returns:
- The service waiters.
-
getPaginators
public ComputePaginators getPaginators()
Description copied from interface:ComputeGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceCompute- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint- The endpoint template in userequiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-