Package com.oracle.bmc.core

Interface ComputeManagement

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ComputeManagementClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface ComputeManagement
extends AutoCloseable
    Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes.

    For more information, see the console documentation for the Networking, Compute, and Block Volume services. The required permissions are documented in the Details for the Core Services article.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        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.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • attachInstancePoolInstance

        AttachInstancePoolInstanceResponse attachInstancePoolInstance​(AttachInstancePoolInstanceRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/AttachInstancePoolInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachInstancePoolInstance API.

      • attachLoadBalancer

        AttachLoadBalancerResponse attachLoadBalancer​(AttachLoadBalancerRequest request)
        Attach a load balancer to the instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/AttachLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachLoadBalancer API.

      • changeClusterNetworkCompartment

        ChangeClusterNetworkCompartmentResponse changeClusterNetworkCompartment​(ChangeClusterNetworkCompartmentRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ChangeClusterNetworkCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeClusterNetworkCompartment API.

      • changeInstanceConfigurationCompartment

        ChangeInstanceConfigurationCompartmentResponse changeInstanceConfigurationCompartment​(ChangeInstanceConfigurationCompartmentRequest request)
        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.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ChangeInstanceConfigurationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeInstanceConfigurationCompartment API.

      • changeInstancePoolCompartment

        ChangeInstancePoolCompartmentResponse changeInstancePoolCompartment​(ChangeInstancePoolCompartmentRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ChangeInstancePoolCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeInstancePoolCompartment API.

      • createClusterNetwork

        CreateClusterNetworkResponse createClusterNetwork​(CreateClusterNetworkRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/CreateClusterNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateClusterNetwork API.

      • createInstanceConfiguration

        CreateInstanceConfigurationResponse createInstanceConfiguration​(CreateInstanceConfigurationRequest request)
        Creates an instance configuration.

        An instance configuration is a template that defines the settings to use when creating Compute instances.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/CreateInstanceConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInstanceConfiguration API.

      • createInstancePool

        CreateInstancePoolResponse createInstancePool​(CreateInstancePoolRequest request)
        Creates an instance pool.

        To determine whether capacity is available for a specific shape before you create an instance pool, use the createComputeCapacityReport operation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/CreateInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInstancePool API.

      • deleteInstanceConfiguration

        DeleteInstanceConfigurationResponse deleteInstanceConfiguration​(DeleteInstanceConfigurationRequest request)
        Deletes an instance configuration.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/DeleteInstanceConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteInstanceConfiguration API.

      • detachInstancePoolInstance

        DetachInstancePoolInstanceResponse detachInstancePoolInstance​(DetachInstancePoolInstanceRequest request)
        Detaches an instance from an instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/DetachInstancePoolInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachInstancePoolInstance API.

      • detachLoadBalancer

        DetachLoadBalancerResponse detachLoadBalancer​(DetachLoadBalancerRequest request)
        Detach a load balancer from the instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/DetachLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachLoadBalancer API.

      • getClusterNetwork

        GetClusterNetworkResponse getClusterNetwork​(GetClusterNetworkRequest request)
        Gets information about a cluster network with instance pools.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/GetClusterNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetClusterNetwork API.

      • getInstanceConfiguration

        GetInstanceConfigurationResponse getInstanceConfiguration​(GetInstanceConfigurationRequest request)
        Gets the specified instance configuration
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/GetInstanceConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstanceConfiguration API.

      • getInstancePool

        GetInstancePoolResponse getInstancePool​(GetInstancePoolRequest request)
        Gets the specified instance pool
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/GetInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstancePool API.

      • getInstancePoolInstance

        GetInstancePoolInstanceResponse getInstancePoolInstance​(GetInstancePoolInstanceRequest request)
        Gets information about an instance that belongs to an instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/GetInstancePoolInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstancePoolInstance API.

      • getInstancePoolLoadBalancerAttachment

        GetInstancePoolLoadBalancerAttachmentResponse getInstancePoolLoadBalancerAttachment​(GetInstancePoolLoadBalancerAttachmentRequest request)
        Gets information about a load balancer that is attached to the specified instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/GetInstancePoolLoadBalancerAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstancePoolLoadBalancerAttachment API.

      • launchInstanceConfiguration

        LaunchInstanceConfigurationResponse launchInstanceConfiguration​(LaunchInstanceConfigurationRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/LaunchInstanceConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use LaunchInstanceConfiguration API.

      • listClusterNetworkInstances

        ListClusterNetworkInstancesResponse listClusterNetworkInstances​(ListClusterNetworkInstancesRequest request)
        Lists the instances in a cluster network with instance pools.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ListClusterNetworkInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListClusterNetworkInstances API.

      • listClusterNetworks

        ListClusterNetworksResponse listClusterNetworks​(ListClusterNetworksRequest request)
        Lists the cluster networks with instance pools in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ListClusterNetworksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListClusterNetworks API.

      • listInstanceConfigurations

        ListInstanceConfigurationsResponse listInstanceConfigurations​(ListInstanceConfigurationsRequest request)
        Lists the instance configurations in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ListInstanceConfigurationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstanceConfigurations API.

      • listInstancePoolInstances

        ListInstancePoolInstancesResponse listInstancePoolInstances​(ListInstancePoolInstancesRequest request)
        List the instances in the specified instance pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ListInstancePoolInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstancePoolInstances API.

      • listInstancePools

        ListInstancePoolsResponse listInstancePools​(ListInstancePoolsRequest request)
        Lists the instance pools in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ListInstancePoolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstancePools API.

      • resetInstancePool

        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.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/ResetInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ResetInstancePool API.

      • softresetInstancePool

        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.

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/SoftresetInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SoftresetInstancePool API.

      • softstopInstancePool

        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.

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/SoftstopInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SoftstopInstancePool API.

      • startInstancePool

        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.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/StartInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartInstancePool API.

      • stopInstancePool

        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.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/StopInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopInstancePool API.

      • terminateClusterNetwork

        TerminateClusterNetworkResponse terminateClusterNetwork​(TerminateClusterNetworkRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/TerminateClusterNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TerminateClusterNetwork API.

      • terminateInstancePool

        TerminateInstancePoolResponse terminateInstancePool​(TerminateInstancePoolRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/TerminateInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TerminateInstancePool API.

      • updateClusterNetwork

        UpdateClusterNetworkResponse updateClusterNetwork​(UpdateClusterNetworkRequest request)
        Updates a cluster network with instance pools.

        The OCID of the cluster network remains the same.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/UpdateClusterNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateClusterNetwork API.

      • updateInstanceConfiguration

        UpdateInstanceConfigurationResponse updateInstanceConfiguration​(UpdateInstanceConfigurationRequest request)
        Updates the free-form tags, defined tags, and display name of an instance configuration.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/UpdateInstanceConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateInstanceConfiguration API.

      • updateInstancePool

        UpdateInstancePoolResponse updateInstancePool​(UpdateInstancePoolRequest request)
        Update the specified instance pool.

        The OCID of the instance pool remains the same.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/core/UpdateInstancePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateInstancePool API.

      • getWaiters

        @Deprecated
ComputeManagementWaiters getWaiters()
        Deprecated.
        use newWaiters(WorkRequest) instead. Otherwise, a default one will be provided that does not support operations that rely on the WorkRequestClient for polling. An IllegalStateException will be thrown for such operations.
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • newWaiters

        ComputeManagementWaiters newWaiters​(WorkRequest workRequestClient)
        Creates a new ComputeManagementWaiters for resources for this service.
        Parameters:
        workRequestClient - The work request service client used to query for work request status
        Returns:
        The service waiters.

      • getPaginators

        ComputeManagementPaginators getPaginators()
        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.

        Returns:
        The service paginators.