ComputeManagementClient (Oracle Cloud Infrastructure Java SDK

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 and Description

static class ComputeManagementClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComputeManagementClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`clientCommonLibraryVersion` Compatible SDK version, provided by the codegen.
`protected ExecutorService`	`executorService`
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient` Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE` Service instance for ComputeManagement.

Constructor Summary

Constructors
Constructor and Description
`ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Deprecated. Use the `builder` instead.
`ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachInstancePoolInstanceResponse`	`attachInstancePoolInstance(AttachInstancePoolInstanceRequest request)` Attaches an instance to an instance pool.
`AttachLoadBalancerResponse`	`attachLoadBalancer(AttachLoadBalancerRequest request)` Attach a load balancer to the instance pool.
`static ComputeManagementClient.Builder`	`builder()` Create a builder for this client.
`ChangeClusterNetworkCompartmentResponse`	`changeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest request)` Moves a cluster network with instance pools into a different compartment within the same tenancy.
`ChangeInstanceConfigurationCompartmentResponse`	`changeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest request)` Moves an instance configuration into a different compartment within the same tenancy.
`ChangeInstancePoolCompartmentResponse`	`changeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest request)` Moves an instance pool into a different compartment within the same tenancy.
`void`	`close()`
`CreateClusterNetworkResponse`	`createClusterNetwork(CreateClusterNetworkRequest request)` Creates a cluster network with instance pools.
`CreateInstanceConfigurationResponse`	`createInstanceConfiguration(CreateInstanceConfigurationRequest request)` Creates an instance configuration.
`CreateInstancePoolResponse`	`createInstancePool(CreateInstancePoolRequest request)` Creates an instance pool.
`DeleteInstanceConfigurationResponse`	`deleteInstanceConfiguration(DeleteInstanceConfigurationRequest request)` Deletes an instance configuration.
`DetachInstancePoolInstanceResponse`	`detachInstancePoolInstance(DetachInstancePoolInstanceRequest request)` Detaches an instance from an instance pool.
`DetachLoadBalancerResponse`	`detachLoadBalancer(DetachLoadBalancerRequest request)` Detach a load balancer from the instance pool.
`String`	`getClientCommonLibraryVersion()`
`GetClusterNetworkResponse`	`getClusterNetwork(GetClusterNetworkRequest request)` Gets information about a cluster network with instance pools.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`GetInstanceConfigurationResponse`	`getInstanceConfiguration(GetInstanceConfigurationRequest request)` Gets the specified instance configuration
`GetInstancePoolResponse`	`getInstancePool(GetInstancePoolRequest request)` Gets the specified instance pool
`GetInstancePoolInstanceResponse`	`getInstancePoolInstance(GetInstancePoolInstanceRequest request)` Gets information about an instance that belongs to an instance pool.
`GetInstancePoolLoadBalancerAttachmentResponse`	`getInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest request)` Gets information about a load balancer that is attached to the specified instance pool.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`ComputeManagementPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`ComputeManagementWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`LaunchInstanceConfigurationResponse`	`launchInstanceConfiguration(LaunchInstanceConfigurationRequest request)` Creates an instance from an instance configuration.
`ListClusterNetworkInstancesResponse`	`listClusterNetworkInstances(ListClusterNetworkInstancesRequest request)` Lists the instances in a cluster network with instance pools.
`ListClusterNetworksResponse`	`listClusterNetworks(ListClusterNetworksRequest request)` Lists the cluster networks with instance pools in the specified compartment.
`ListInstanceConfigurationsResponse`	`listInstanceConfigurations(ListInstanceConfigurationsRequest request)` Lists the instance configurations in the specified compartment.
`ListInstancePoolInstancesResponse`	`listInstancePoolInstances(ListInstancePoolInstancesRequest request)` List the instances in the specified instance pool.
`ListInstancePoolsResponse`	`listInstancePools(ListInstancePoolsRequest request)` Lists the instance pools in the specified compartment.
`ComputeManagementWaiters`	`newWaiters(WorkRequest workRequestClient)` Creates a new `ComputeManagementWaiters` for resources for this service.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)` Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()` Rebuild the backing `HttpClient`.
`ResetInstancePoolResponse`	`resetInstancePool(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.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`SoftresetInstancePoolResponse`	`softresetInstancePool(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.
`SoftstopInstancePoolResponse`	`softstopInstancePool(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.
`StartInstancePoolResponse`	`startInstancePool(StartInstancePoolRequest request)` Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.
`StopInstancePoolResponse`	`stopInstancePool(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.
`TerminateClusterNetworkResponse`	`terminateClusterNetwork(TerminateClusterNetworkRequest request)` Deletes (terminates) a cluster network with instance pools.
`TerminateInstancePoolResponse`	`terminateInstancePool(TerminateInstancePoolRequest request)` Terminate the specified instance pool.
`void`	`updateBaseEndpoint(String endpoint)` This method should be used for parameterized endpoint templates only.
`UpdateClusterNetworkResponse`	`updateClusterNetwork(UpdateClusterNetworkRequest request)` Updates a cluster network with instance pools.
`UpdateInstanceConfigurationResponse`	`updateInstanceConfiguration(UpdateInstanceConfigurationRequest request)` Updates the free-form tags, defined tags, and display name of an instance configuration.
`UpdateInstancePoolResponse`	`updateInstancePool(UpdateInstancePoolRequest request)` Update the specified instance pool.
`void`	`useRealmSpecificEndpointTemplate(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 com.oracle.bmc.core.ComputeManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable
close

- 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.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - 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 the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory,
                                           List<ClientConfigurator> additionalClientConfigurators,
                                           String endpoint)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - ComputeManagementClient
```
@Deprecated
public ComputeManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory,
                                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                           List<ClientConfigurator> additionalClientConfigurators,
                                           String endpoint)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - 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 the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ComputeManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - 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: ComputeManagement
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface ComputeManagement
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: ComputeManagement
    
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Specified by:
    
    setRegion in interface ComputeManagement
    
    Parameters:
    
    regionId - The public region ID.
  - attachInstancePoolInstance
```
public AttachInstancePoolInstanceResponse attachInstancePoolInstance(AttachInstancePoolInstanceRequest request)
```
    Description copied from interface: ComputeManagement
    
    Attaches 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:
    
    attachInstancePoolInstance in interface ComputeManagement
    
    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: ComputeManagement
    
    Attach a load balancer to the instance pool.
    
    Specified by:
    
    attachLoadBalancer in interface ComputeManagement
    
    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: ComputeManagement
    
    Moves 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:
    
    changeClusterNetworkCompartment in interface ComputeManagement
    
    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: ComputeManagement
    
    Moves 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.cloud.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).
    
    Specified by:
    
    changeInstanceConfigurationCompartment in interface ComputeManagement
    
    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: ComputeManagement
    
    Moves 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:
    
    changeInstancePoolCompartment in interface ComputeManagement
    
    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: ComputeManagement
    
    Creates 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 createComputeCluster operation.
    To determine whether capacity is available for a specific shape before you create a cluster network, use the createComputeCapacityReport operation.
    
    Specified by:
    
    createClusterNetwork in interface ComputeManagement
    
    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: ComputeManagement
    
    Creates an instance configuration. An instance configuration is a template that defines the settings to use when creating Compute instances.
    
    Specified by:
    
    createInstanceConfiguration in interface ComputeManagement
    
    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: ComputeManagement
    
    Creates an instance pool.
    
    To determine whether capacity is available for a specific shape before you create an instance pool, use the createComputeCapacityReport operation.
    
    Specified by:
    
    createInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Deletes an instance configuration.
    
    Specified by:
    
    deleteInstanceConfiguration in interface ComputeManagement
    
    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: ComputeManagement
    
    Detaches an instance from an instance pool.
    
    Specified by:
    
    detachInstancePoolInstance in interface ComputeManagement
    
    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: ComputeManagement
    
    Detach a load balancer from the instance pool.
    
    Specified by:
    
    detachLoadBalancer in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets information about a cluster network with instance pools.
    
    Specified by:
    
    getClusterNetwork in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets the specified instance configuration
    
    Specified by:
    
    getInstanceConfiguration in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets the specified instance pool
    
    Specified by:
    
    getInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets information about an instance that belongs to an instance pool.
    
    Specified by:
    
    getInstancePoolInstance in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets information about a load balancer that is attached to the specified instance pool.
    
    Specified by:
    
    getInstancePoolLoadBalancerAttachment in interface ComputeManagement
    
    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: ComputeManagement
    
    Creates 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 InstanceConfiguration resource.
    To determine whether capacity is available for a specific shape before you create an instance, use the createComputeCapacityReport operation.
    
    Specified by:
    
    launchInstanceConfiguration in interface ComputeManagement
    
    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: ComputeManagement
    
    Lists the instances in a cluster network with instance pools.
    
    Specified by:
    
    listClusterNetworkInstances in interface ComputeManagement
    
    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: ComputeManagement
    
    Lists the cluster networks with instance pools in the specified compartment.
    
    Specified by:
    
    listClusterNetworks in interface ComputeManagement
    
    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: ComputeManagement
    
    Lists the instance configurations in the specified compartment.
    
    Specified by:
    
    listInstanceConfigurations in interface ComputeManagement
    
    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: ComputeManagement
    
    List the instances in the specified instance pool.
    
    Specified by:
    
    listInstancePoolInstances in interface ComputeManagement
    
    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: ComputeManagement
    
    Lists the instance pools in the specified compartment.
    
    Specified by:
    
    listInstancePools in interface ComputeManagement
    
    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: ComputeManagement
    
    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.
    
    Specified by:
    
    resetInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    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.
    
    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:
    
    softresetInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    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.
    
    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:
    
    softstopInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.
    
    Specified by:
    
    startInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.
    
    Specified by:
    
    stopInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Deletes (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:
    
    terminateClusterNetwork in interface ComputeManagement
    
    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: ComputeManagement
    
    Terminate 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:
    
    terminateInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Updates a cluster network with instance pools. The OCID of the cluster network remains the same.
    
    Specified by:
    
    updateClusterNetwork in interface ComputeManagement
    
    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: ComputeManagement
    
    Updates the free-form tags, defined tags, and display name of an instance configuration.
    
    Specified by:
    
    updateInstanceConfiguration in interface ComputeManagement
    
    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: ComputeManagement
    
    Update the specified instance pool.
    
    The OCID of the instance pool remains the same.
    
    Specified by:
    
    updateInstancePool in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface ComputeManagement
    
    Returns:
    
    The service waiters.
  - newWaiters
```
public ComputeManagementWaiters newWaiters(WorkRequest workRequestClient)
```
    Description copied from interface: ComputeManagement
    
    Creates a new ComputeManagementWaiters for resources for this service.
    
    Specified by:
    
    newWaiters in interface ComputeManagement
    
    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: ComputeManagement
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface ComputeManagement
    
    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 use
    
    requiredParametersMap - 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 backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class ComputeManagementClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.core.ComputeManagement

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE

executorService

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

ComputeManagementClient

Method Detail

builder

setRegion

setRegion

attachInstancePoolInstance

attachLoadBalancer

changeClusterNetworkCompartment

changeInstanceConfigurationCompartment

changeInstancePoolCompartment

createClusterNetwork

createInstanceConfiguration

createInstancePool

deleteInstanceConfiguration

detachInstancePoolInstance

detachLoadBalancer

getClusterNetwork

getInstanceConfiguration

getInstancePool

getInstancePoolInstance

getInstancePoolLoadBalancerAttachment

launchInstanceConfiguration

listClusterNetworkInstances

listClusterNetworks

listInstanceConfigurations

listInstancePoolInstances

listInstancePools

resetInstancePool

softresetInstancePool

softstopInstancePool

startInstancePool

stopInstancePool

terminateClusterNetwork

terminateInstancePool

updateClusterNetwork

updateInstanceConfiguration

updateInstancePool

getWaiters

newWaiters

getPaginators

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient