AutoScaling (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AutoScalingClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181001")
public interface AutoScaling
extends AutoCloseable
```
APIs for dynamically scaling Compute resources to meet application requirements. For more information about autoscaling, see Autoscaling. For information about the Compute service, see Overview of the Compute Service.

*Note:** Autoscaling is not available in US Government Cloud tenancies. For more information, see [Oracle Cloud Infrastructure US Government Cloud](https://docs.cloud.oracle.com/Content/General/Concepts/govoverview.htm).
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 Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangeAutoScalingConfigurationCompartmentResponse`	`changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)` Moves an autoscaling configuration into a different compartment within the same tenancy.
`CreateAutoScalingConfigurationResponse`	`createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)` Creates an autoscaling configuration.
`CreateAutoScalingPolicyResponse`	`createAutoScalingPolicy(CreateAutoScalingPolicyRequest request)` Creates an autoscaling policy for the specified autoscaling configuration.
`DeleteAutoScalingConfigurationResponse`	`deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)` Deletes an autoscaling configuration.
`DeleteAutoScalingPolicyResponse`	`deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request)` Deletes an autoscaling policy for the specified autoscaling configuration.
`GetAutoScalingConfigurationResponse`	`getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)` Gets information about the specified autoscaling configuration.
`GetAutoScalingPolicyResponse`	`getAutoScalingPolicy(GetAutoScalingPolicyRequest request)` Gets information about the specified autoscaling policy in the specified autoscaling configuration.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`AutoScalingPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`ListAutoScalingConfigurationsResponse`	`listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)` Lists autoscaling configurations in the specifed compartment.
`ListAutoScalingPoliciesResponse`	`listAutoScalingPolicies(ListAutoScalingPoliciesRequest request)` Lists the autoscaling policies in the specified autoscaling configuration.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateAutoScalingConfigurationResponse`	`updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)` Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.
`UpdateAutoScalingPolicyResponse`	`updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request)` Updates an autoscaling policy in the specified autoscaling configuration.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- 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
  - changeAutoScalingConfigurationCompartment
```
ChangeAutoScalingConfigurationCompartmentResponse changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)
```
    Moves an autoscaling 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 autoscaling configuration to a different compartment, associated resources such as instance pools 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 here to see how to use ChangeAutoScalingConfigurationCompartment API.
  - createAutoScalingConfiguration
```
CreateAutoScalingConfigurationResponse createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)
```
    Creates an autoscaling 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 here to see how to use CreateAutoScalingConfiguration API.
  - createAutoScalingPolicy
```
CreateAutoScalingPolicyResponse createAutoScalingPolicy(CreateAutoScalingPolicyRequest request)
```
    Creates an autoscaling policy for the specified autoscaling configuration.
    
    You can create the following types of autoscaling policies:
    - **Schedule-based:** Autoscaling events take place at the specific times that you schedule. - **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold.
    An autoscaling configuration can either have multiple schedule-based autoscaling policies, or one threshold-based autoscaling policy.
    
    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 here to see how to use CreateAutoScalingPolicy API.
  - deleteAutoScalingConfiguration
```
DeleteAutoScalingConfigurationResponse deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)
```
    Deletes an autoscaling 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 here to see how to use DeleteAutoScalingConfiguration API.
  - deleteAutoScalingPolicy
```
DeleteAutoScalingPolicyResponse deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request)
```
    Deletes an autoscaling policy for the specified autoscaling 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 here to see how to use DeleteAutoScalingPolicy API.
  - getAutoScalingConfiguration
```
GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)
```
    Gets information about the specified autoscaling 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 here to see how to use GetAutoScalingConfiguration API.
  - getAutoScalingPolicy
```
GetAutoScalingPolicyResponse getAutoScalingPolicy(GetAutoScalingPolicyRequest request)
```
    Gets information about the specified autoscaling policy in the specified autoscaling 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 here to see how to use GetAutoScalingPolicy API.
  - listAutoScalingConfigurations
```
ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
```
    Lists autoscaling configurations in the specifed 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 here to see how to use ListAutoScalingConfigurations API.
  - listAutoScalingPolicies
```
ListAutoScalingPoliciesResponse listAutoScalingPolicies(ListAutoScalingPoliciesRequest request)
```
    Lists the autoscaling policies in the specified autoscaling 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 here to see how to use ListAutoScalingPolicies API.
  - updateAutoScalingConfiguration
```
UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)
```
    Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.
    
    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 here to see how to use UpdateAutoScalingConfiguration API.
  - updateAutoScalingPolicy
```
UpdateAutoScalingPolicyResponse updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request)
```
    Updates an autoscaling policy in the specified autoscaling 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 here to see how to use UpdateAutoScalingPolicy API.
  - getPaginators
```
AutoScalingPaginators 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.

Interface AutoScaling

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeAutoScalingConfigurationCompartment

createAutoScalingConfiguration

createAutoScalingPolicy

deleteAutoScalingConfiguration

deleteAutoScalingPolicy

getAutoScalingConfiguration

getAutoScalingPolicy

listAutoScalingConfigurations

listAutoScalingPolicies

updateAutoScalingConfiguration

updateAutoScalingPolicy

getPaginators