Class ComputeManagementClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.core.ComputeManagementClient
-
- All Implemented Interfaces:
ComputeManagement,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeManagementClient extends BaseSyncClient implements ComputeManagement
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classComputeManagementClient.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 ComputeManagement.
-
Constructor Summary
Constructors Constructor Description ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttachInstancePoolInstanceResponseattachInstancePoolInstance(AttachInstancePoolInstanceRequest request)Attaches an instance to an instance pool.AttachLoadBalancerResponseattachLoadBalancer(AttachLoadBalancerRequest request)Attach a load balancer to the instance pool.static ComputeManagementClient.Builderbuilder()Create a builder for this client.ChangeClusterNetworkCompartmentResponsechangeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest request)Moves a cluster network with instance pools into a different compartment within the same tenancy.ChangeInstanceConfigurationCompartmentResponsechangeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest request)Moves an instance configuration into a different compartment within the same tenancy.ChangeInstancePoolCompartmentResponsechangeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest request)Moves an instance pool into a different compartment within the same tenancy.voidclose()CreateClusterNetworkResponsecreateClusterNetwork(CreateClusterNetworkRequest request)Creates a cluster network with instance pools.CreateInstanceConfigurationResponsecreateInstanceConfiguration(CreateInstanceConfigurationRequest request)Creates an instance configuration.CreateInstancePoolResponsecreateInstancePool(CreateInstancePoolRequest request)Creates an instance pool.DeleteInstanceConfigurationResponsedeleteInstanceConfiguration(DeleteInstanceConfigurationRequest request)Deletes an instance configuration.DetachInstancePoolInstanceResponsedetachInstancePoolInstance(DetachInstancePoolInstanceRequest request)Detaches an instance from an instance pool.DetachLoadBalancerResponsedetachLoadBalancer(DetachLoadBalancerRequest request)Detach a load balancer from the instance pool.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()GetClusterNetworkResponsegetClusterNetwork(GetClusterNetworkRequest request)Gets information about a cluster network with instance pools.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetInstanceConfigurationResponsegetInstanceConfiguration(GetInstanceConfigurationRequest request)Gets the specified instance configurationGetInstancePoolResponsegetInstancePool(GetInstancePoolRequest request)Gets the specified instance poolGetInstancePoolInstanceResponsegetInstancePoolInstance(GetInstancePoolInstanceRequest request)Gets information about an instance that belongs to an instance pool.GetInstancePoolLoadBalancerAttachmentResponsegetInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest request)Gets information about a load balancer that is attached to the specified instance pool.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.ComputeManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.ComputeManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.LaunchInstanceConfigurationResponselaunchInstanceConfiguration(LaunchInstanceConfigurationRequest request)Creates an instance from an instance configuration.ListClusterNetworkInstancesResponselistClusterNetworkInstances(ListClusterNetworkInstancesRequest request)Lists the instances in a cluster network with instance pools.ListClusterNetworksResponselistClusterNetworks(ListClusterNetworksRequest request)Lists the cluster networks with instance pools in the specified compartment.ListInstanceConfigurationsResponselistInstanceConfigurations(ListInstanceConfigurationsRequest request)Lists the instance configurations in the specified compartment.ListInstancePoolInstancesResponselistInstancePoolInstances(ListInstancePoolInstancesRequest request)List the instances in the specified instance pool.ListInstancePoolsResponselistInstancePools(ListInstancePoolsRequest request)Lists the instance pools in the specified compartment.ComputeManagementWaitersnewWaiters(WorkRequest workRequestClient)Creates a new ComputeManagementWaiters for resources for this service.voidrefreshClient()Rebuild the backingHttpClient.ResetInstancePoolResponseresetInstancePool(ResetInstancePoolRequest request)Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SoftresetInstancePoolResponsesoftresetInstancePool(SoftresetInstancePoolRequest request)Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.SoftstopInstancePoolResponsesoftstopInstancePool(SoftstopInstancePoolRequest request)Performs the softstop (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.StartInstancePoolResponsestartInstancePool(StartInstancePoolRequest request)Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.StopInstancePoolResponsestopInstancePool(StopInstancePoolRequest request)Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.TerminateClusterNetworkResponseterminateClusterNetwork(TerminateClusterNetworkRequest request)Deletes (terminates) a cluster network with instance pools.TerminateInstancePoolResponseterminateInstancePool(TerminateInstancePoolRequest request)Terminate the specified instance pool.TerminationProceedInstancePoolInstanceResponseterminationProceedInstancePoolInstance(TerminationProceedInstancePoolInstanceRequest request)Marks an instance in an instance pool to be ready for termination.UpdateClusterNetworkResponseupdateClusterNetwork(UpdateClusterNetworkRequest request)Updates a cluster network with instance pools.UpdateInstanceConfigurationResponseupdateInstanceConfiguration(UpdateInstanceConfigurationRequest request)Updates the free-form tags, defined tags, and display name of an instance configuration.UpdateInstancePoolResponseupdateInstancePool(UpdateInstancePoolRequest request)Update the specified instance pool.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
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.ComputeManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Field Detail
-
SERVICE
public static final Service SERVICE
Service instance for ComputeManagement.
-
executorService
protected final ExecutorService executorService
-
clientCommonLibraryVersion
public final String clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
-
-
Constructor Detail
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(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 (seeComputeManagementClient.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)
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(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 (seeComputeManagementClient.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
-
ComputeManagementClient
@Deprecated public ComputeManagementClient(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 (seeComputeManagementClient.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-ComputeManagementClient.Builder.executorService
-
-
Method Detail
-
builder
public static ComputeManagementClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ComputeManagementSets 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.- Specified by:
setRegionin interfaceComputeManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ComputeManagementSets 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.- Specified by:
setRegionin interfaceComputeManagement- Parameters:
regionId- The public region ID.
-
attachInstancePoolInstance
public AttachInstancePoolInstanceResponse attachInstancePoolInstance(AttachInstancePoolInstanceRequest request)
Description copied from interface:ComputeManagementAttaches an instance to an instance pool.For information about the prerequisites that an instance must meet before you can attach it to a pool, see Attaching an Instance to an Instance Pool.
- Specified by:
attachInstancePoolInstancein interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachLoadBalancer
public AttachLoadBalancerResponse attachLoadBalancer(AttachLoadBalancerRequest request)
Description copied from interface:ComputeManagementAttach a load balancer to the instance pool.- Specified by:
attachLoadBalancerin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeClusterNetworkCompartment
public ChangeClusterNetworkCompartmentResponse changeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest request)
Description copied from interface:ComputeManagementMoves a cluster network with instance pools 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 a cluster network to a different compartment, associated resources such as the instances in the cluster network, boot volumes, and VNICs are not moved.
- Specified by:
changeClusterNetworkCompartmentin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeInstanceConfigurationCompartment
public ChangeInstanceConfigurationCompartmentResponse changeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest request)
Description copied from interface:ComputeManagementMoves an instance configuration 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 configuration to a different compartment, associated resources such as instance pools are not moved.
*Important:** Most of the properties for an existing instance configuration, including the compartment, cannot be modified after you create the instance configuration. Although you can move an instance configuration to a different compartment, you will not be able to use the instance configuration to manage instance pools in the new compartment. If you want to update an instance configuration to point to a different compartment, you should instead create a new instance configuration in the target compartment using [CreateInstanceConfiguration](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).
- Specified by:
changeInstanceConfigurationCompartmentin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeInstancePoolCompartment
public ChangeInstancePoolCompartmentResponse changeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest request)
Description copied from interface:ComputeManagementMoves an instance pool 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 pool to a different compartment, associated resources such as the instances in the pool, boot volumes, VNICs, and autoscaling configurations are not moved.
- Specified by:
changeInstancePoolCompartmentin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createClusterNetwork
public CreateClusterNetworkResponse createClusterNetwork(CreateClusterNetworkRequest request)
Description copied from interface:ComputeManagementCreates a cluster network with instance pools.A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. Cluster networks with instance pools use instance pools to manage groups of identical instances.
Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group.
If you want to manage instances in the RDMA network independently of each other or use different types of instances in the network group, create a compute cluster by using the
createComputeClusteroperation.To determine whether capacity is available for a specific shape before you create a cluster network, use the
createComputeCapacityReportoperation.- Specified by:
createClusterNetworkin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createInstanceConfiguration
public CreateInstanceConfigurationResponse createInstanceConfiguration(CreateInstanceConfigurationRequest request)
Description copied from interface:ComputeManagementCreates an instance configuration.An instance configuration is a template that defines the settings to use when creating Compute instances.
- Specified by:
createInstanceConfigurationin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createInstancePool
public CreateInstancePoolResponse createInstancePool(CreateInstancePoolRequest request)
Description copied from interface:ComputeManagementCreates an instance pool.To determine whether capacity is available for a specific shape before you create an instance pool, use the
createComputeCapacityReportoperation.- Specified by:
createInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteInstanceConfiguration
public DeleteInstanceConfigurationResponse deleteInstanceConfiguration(DeleteInstanceConfigurationRequest request)
Description copied from interface:ComputeManagementDeletes an instance configuration.- Specified by:
deleteInstanceConfigurationin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachInstancePoolInstance
public DetachInstancePoolInstanceResponse detachInstancePoolInstance(DetachInstancePoolInstanceRequest request)
Description copied from interface:ComputeManagementDetaches an instance from an instance pool.- Specified by:
detachInstancePoolInstancein interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachLoadBalancer
public DetachLoadBalancerResponse detachLoadBalancer(DetachLoadBalancerRequest request)
Description copied from interface:ComputeManagementDetach a load balancer from the instance pool.- Specified by:
detachLoadBalancerin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getClusterNetwork
public GetClusterNetworkResponse getClusterNetwork(GetClusterNetworkRequest request)
Description copied from interface:ComputeManagementGets information about a cluster network with instance pools.- Specified by:
getClusterNetworkin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstanceConfiguration
public GetInstanceConfigurationResponse getInstanceConfiguration(GetInstanceConfigurationRequest request)
Description copied from interface:ComputeManagementGets the specified instance configuration- Specified by:
getInstanceConfigurationin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstancePool
public GetInstancePoolResponse getInstancePool(GetInstancePoolRequest request)
Description copied from interface:ComputeManagementGets the specified instance pool- Specified by:
getInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstancePoolInstance
public GetInstancePoolInstanceResponse getInstancePoolInstance(GetInstancePoolInstanceRequest request)
Description copied from interface:ComputeManagementGets information about an instance that belongs to an instance pool.- Specified by:
getInstancePoolInstancein interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInstancePoolLoadBalancerAttachment
public GetInstancePoolLoadBalancerAttachmentResponse getInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest request)
Description copied from interface:ComputeManagementGets information about a load balancer that is attached to the specified instance pool.- Specified by:
getInstancePoolLoadBalancerAttachmentin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
launchInstanceConfiguration
public LaunchInstanceConfigurationResponse launchInstanceConfiguration(LaunchInstanceConfigurationRequest request)
Description copied from interface:ComputeManagementCreates an instance from an instance configuration.If the instance configuration does not include all of the parameters that are required to create an instance, such as the availability domain and subnet ID, you must provide these parameters when you create an instance from the instance configuration. For more information, see the
InstanceConfigurationresource.To determine whether capacity is available for a specific shape before you create an instance, use the
createComputeCapacityReportoperation.- Specified by:
launchInstanceConfigurationin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listClusterNetworkInstances
public ListClusterNetworkInstancesResponse listClusterNetworkInstances(ListClusterNetworkInstancesRequest request)
Description copied from interface:ComputeManagementLists the instances in a cluster network with instance pools.- Specified by:
listClusterNetworkInstancesin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listClusterNetworks
public ListClusterNetworksResponse listClusterNetworks(ListClusterNetworksRequest request)
Description copied from interface:ComputeManagementLists the cluster networks with instance pools in the specified compartment.- Specified by:
listClusterNetworksin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstanceConfigurations
public ListInstanceConfigurationsResponse listInstanceConfigurations(ListInstanceConfigurationsRequest request)
Description copied from interface:ComputeManagementLists the instance configurations in the specified compartment.- Specified by:
listInstanceConfigurationsin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstancePoolInstances
public ListInstancePoolInstancesResponse listInstancePoolInstances(ListInstancePoolInstancesRequest request)
Description copied from interface:ComputeManagementList the instances in the specified instance pool.- Specified by:
listInstancePoolInstancesin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInstancePools
public ListInstancePoolsResponse listInstancePools(ListInstancePoolsRequest request)
Description copied from interface:ComputeManagementLists the instance pools in the specified compartment.- Specified by:
listInstancePoolsin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
resetInstancePool
public ResetInstancePoolResponse resetInstancePool(ResetInstancePoolRequest request)
Description copied from interface:ComputeManagementPerforms the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
resetInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
softresetInstancePool
public SoftresetInstancePoolResponse softresetInstancePool(SoftresetInstancePoolRequest request)
Description copied from interface:ComputeManagementPerforms the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.
- Specified by:
softresetInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
softstopInstancePool
public SoftstopInstancePoolResponse softstopInstancePool(SoftstopInstancePoolRequest request)
Description copied from interface:ComputeManagementPerforms the softstop (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.Softstop gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shutdown, the instances are powered off and then powered back on.
- Specified by:
softstopInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startInstancePool
public StartInstancePoolResponse startInstancePool(StartInstancePoolRequest request)
Description copied from interface:ComputeManagementPerforms the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
startInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopInstancePool
public StopInstancePoolResponse stopInstancePool(StopInstancePoolRequest request)
Description copied from interface:ComputeManagementPerforms the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
stopInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
terminateClusterNetwork
public TerminateClusterNetworkResponse terminateClusterNetwork(TerminateClusterNetworkRequest request)
Description copied from interface:ComputeManagementDeletes (terminates) a cluster network with instance pools.When you delete a cluster network, all of its resources are permanently deleted, including associated instances and instance pools.
- Specified by:
terminateClusterNetworkin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
terminateInstancePool
public TerminateInstancePoolResponse terminateInstancePool(TerminateInstancePoolRequest request)
Description copied from interface:ComputeManagementTerminate the specified instance pool.*Warning:** When you delete an instance pool, the resources that were created by the pool are permanently deleted, including associated instances, attached boot volumes, and block volumes.
If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using the `DeleteAutoScalingConfiguration` operation in the Autoscaling API.
- Specified by:
terminateInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
terminationProceedInstancePoolInstance
public TerminationProceedInstancePoolInstanceResponse terminationProceedInstancePoolInstance(TerminationProceedInstancePoolInstanceRequest request)
Description copied from interface:ComputeManagementMarks an instance in an instance pool to be ready for termination.- Specified by:
terminationProceedInstancePoolInstancein interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateClusterNetwork
public UpdateClusterNetworkResponse updateClusterNetwork(UpdateClusterNetworkRequest request)
Description copied from interface:ComputeManagementUpdates a cluster network with instance pools.The OCID of the cluster network remains the same.
- Specified by:
updateClusterNetworkin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInstanceConfiguration
public UpdateInstanceConfigurationResponse updateInstanceConfiguration(UpdateInstanceConfigurationRequest request)
Description copied from interface:ComputeManagementUpdates the free-form tags, defined tags, and display name of an instance configuration.- Specified by:
updateInstanceConfigurationin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInstancePool
public UpdateInstancePoolResponse updateInstancePool(UpdateInstancePoolRequest request)
Description copied from interface:ComputeManagementUpdate the specified instance pool.The OCID of the instance pool remains the same.
- Specified by:
updateInstancePoolin interfaceComputeManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public ComputeManagementWaiters getWaiters()
Description copied from interface:ComputeManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceComputeManagement- Returns:
- The service waiters.
-
newWaiters
public ComputeManagementWaiters newWaiters(WorkRequest workRequestClient)
Description copied from interface:ComputeManagementCreates a new ComputeManagementWaiters for resources for this service.- Specified by:
newWaitersin interfaceComputeManagement- Parameters:
workRequestClient- The work request service client used to query for work request status- Returns:
- The service waiters.
-
getPaginators
public ComputeManagementPaginators getPaginators()
Description copied from interface:ComputeManagementGets 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 interfaceComputeManagement- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
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()
-
-