com.oracle.bmc.autoscaling

Interface AutoScalingAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AutoScalingAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181001")
public interface AutoScalingAsync
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).

Method Summary

Modifier and Type	Method and Description
Future<ChangeAutoScalingConfigurationCompartmentResponse>	changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request, AsyncHandler<ChangeAutoScalingConfigurationCompartmentRequest,ChangeAutoScalingConfigurationCompartmentResponse> handler) Moves an autoscaling configuration into a different compartment within the same tenancy.
Future<CreateAutoScalingConfigurationResponse>	createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request, AsyncHandler<CreateAutoScalingConfigurationRequest,CreateAutoScalingConfigurationResponse> handler) Creates an autoscaling configuration.
Future<CreateAutoScalingPolicyResponse>	createAutoScalingPolicy(CreateAutoScalingPolicyRequest request, AsyncHandler<CreateAutoScalingPolicyRequest,CreateAutoScalingPolicyResponse> handler) Creates an autoscaling policy for the specified autoscaling configuration.
Future<DeleteAutoScalingConfigurationResponse>	deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request, AsyncHandler<DeleteAutoScalingConfigurationRequest,DeleteAutoScalingConfigurationResponse> handler) Deletes an autoscaling configuration.
Future<DeleteAutoScalingPolicyResponse>	deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request, AsyncHandler<DeleteAutoScalingPolicyRequest,DeleteAutoScalingPolicyResponse> handler) Deletes an autoscaling policy for the specified autoscaling configuration.
Future<GetAutoScalingConfigurationResponse>	getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request, AsyncHandler<GetAutoScalingConfigurationRequest,GetAutoScalingConfigurationResponse> handler) Gets information about the specified autoscaling configuration.
Future<GetAutoScalingPolicyResponse>	getAutoScalingPolicy(GetAutoScalingPolicyRequest request, AsyncHandler<GetAutoScalingPolicyRequest,GetAutoScalingPolicyResponse> handler) 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)
Future<ListAutoScalingConfigurationsResponse>	listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request, AsyncHandler<ListAutoScalingConfigurationsRequest,ListAutoScalingConfigurationsResponse> handler) Lists autoscaling configurations in the specifed compartment.
Future<ListAutoScalingPoliciesResponse>	listAutoScalingPolicies(ListAutoScalingPoliciesRequest request, AsyncHandler<ListAutoScalingPoliciesRequest,ListAutoScalingPoliciesResponse> handler) 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’).
Future<UpdateAutoScalingConfigurationResponse>	updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request, AsyncHandler<UpdateAutoScalingConfigurationRequest,UpdateAutoScalingConfigurationResponse> handler) Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.
Future<UpdateAutoScalingPolicyResponse>	updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request, AsyncHandler<UpdateAutoScalingPolicyRequest,UpdateAutoScalingPolicyResponse> handler) 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 serice.

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

Future<ChangeAutoScalingConfigurationCompartmentResponse> changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request,
                                                                                                    AsyncHandler<ChangeAutoScalingConfigurationCompartmentRequest,ChangeAutoScalingConfigurationCompartmentResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createAutoScalingConfiguration

Future<CreateAutoScalingConfigurationResponse> createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request,
                                                                              AsyncHandler<CreateAutoScalingConfigurationRequest,CreateAutoScalingConfigurationResponse> handler)

Creates an autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createAutoScalingPolicy

Future<CreateAutoScalingPolicyResponse> createAutoScalingPolicy(CreateAutoScalingPolicyRequest request,
                                                                AsyncHandler<CreateAutoScalingPolicyRequest,CreateAutoScalingPolicyResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAutoScalingConfiguration

Future<DeleteAutoScalingConfigurationResponse> deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request,
                                                                              AsyncHandler<DeleteAutoScalingConfigurationRequest,DeleteAutoScalingConfigurationResponse> handler)

Deletes an autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAutoScalingPolicy

Future<DeleteAutoScalingPolicyResponse> deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request,
                                                                AsyncHandler<DeleteAutoScalingPolicyRequest,DeleteAutoScalingPolicyResponse> handler)

Deletes an autoscaling policy for the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAutoScalingConfiguration

Future<GetAutoScalingConfigurationResponse> getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request,
                                                                        AsyncHandler<GetAutoScalingConfigurationRequest,GetAutoScalingConfigurationResponse> handler)

Gets information about the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAutoScalingPolicy

Future<GetAutoScalingPolicyResponse> getAutoScalingPolicy(GetAutoScalingPolicyRequest request,
                                                          AsyncHandler<GetAutoScalingPolicyRequest,GetAutoScalingPolicyResponse> handler)

Gets information about the specified autoscaling policy in the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAutoScalingConfigurations

Future<ListAutoScalingConfigurationsResponse> listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request,
                                                                            AsyncHandler<ListAutoScalingConfigurationsRequest,ListAutoScalingConfigurationsResponse> handler)

Lists autoscaling configurations in the specifed compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAutoScalingPolicies

Future<ListAutoScalingPoliciesResponse> listAutoScalingPolicies(ListAutoScalingPoliciesRequest request,
                                                                AsyncHandler<ListAutoScalingPoliciesRequest,ListAutoScalingPoliciesResponse> handler)

Lists the autoscaling policies in the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAutoScalingConfiguration

Future<UpdateAutoScalingConfigurationResponse> updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request,
                                                                              AsyncHandler<UpdateAutoScalingConfigurationRequest,UpdateAutoScalingConfigurationResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAutoScalingPolicy

Future<UpdateAutoScalingPolicyResponse> updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request,
                                                                AsyncHandler<UpdateAutoScalingPolicyRequest,UpdateAutoScalingPolicyResponse> handler)

Updates an autoscaling policy in the specified autoscaling configuration.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.