Package com.oracle.bmc.autoscaling

Class AutoScalingClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.autoscaling.AutoScalingClient

All Implemented Interfaces:

AutoScaling, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181001")
public class AutoScalingClient
extends BaseSyncClient
implements AutoScaling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoScalingClient.Builder	Builder class for this client.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static AutoScalingClient.Builder	builder()	Create a builder for this client.
ChangeAutoScalingConfigurationCompartmentResponse	changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)	Moves an autoscaling configuration into a different compartment within the same tenancy.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	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.
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’).
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	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.autoscaling.AutoScaling

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AutoScaling.

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

AutoScalingClient

@Deprecated
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AutoScalingClient

@Deprecated
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AutoScalingClient

@Deprecated
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AutoScalingClient

@Deprecated
public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AutoScalingClient

@Deprecated
public AutoScalingClient(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 AutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AutoScalingClient

@Deprecated
public AutoScalingClient(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 AutoScalingClient.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)

AutoScalingClient

@Deprecated
public AutoScalingClient(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 AutoScalingClient.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

Method Detail

builder

public static AutoScalingClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AutoScaling

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 AutoScaling

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AutoScaling

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 AutoScaling

Parameters:

regionId - The public region ID.

changeAutoScalingConfigurationCompartment

public ChangeAutoScalingConfigurationCompartmentResponse changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)

Description copied from interface: AutoScaling

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.

Specified by:

changeAutoScalingConfigurationCompartment in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAutoScalingConfiguration

public CreateAutoScalingConfigurationResponse createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)

Description copied from interface: AutoScaling

Creates an autoscaling configuration.

Specified by:

createAutoScalingConfiguration in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAutoScalingPolicy

public CreateAutoScalingPolicyResponse createAutoScalingPolicy(CreateAutoScalingPolicyRequest request)

Description copied from interface: AutoScaling

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.

Specified by:

createAutoScalingPolicy in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAutoScalingConfiguration

public DeleteAutoScalingConfigurationResponse deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)

Description copied from interface: AutoScaling

Deletes an autoscaling configuration.

Specified by:

deleteAutoScalingConfiguration in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAutoScalingPolicy

public DeleteAutoScalingPolicyResponse deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request)

Description copied from interface: AutoScaling

Deletes an autoscaling policy for the specified autoscaling configuration.

Specified by:

deleteAutoScalingPolicy in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAutoScalingConfiguration

public GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)

Description copied from interface: AutoScaling

Gets information about the specified autoscaling configuration.

Specified by:

getAutoScalingConfiguration in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAutoScalingPolicy

public GetAutoScalingPolicyResponse getAutoScalingPolicy(GetAutoScalingPolicyRequest request)

Description copied from interface: AutoScaling

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

Specified by:

getAutoScalingPolicy in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAutoScalingConfigurations

public ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)

Description copied from interface: AutoScaling

Lists autoscaling configurations in the specifed compartment.

Specified by:

listAutoScalingConfigurations in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAutoScalingPolicies

public ListAutoScalingPoliciesResponse listAutoScalingPolicies(ListAutoScalingPoliciesRequest request)

Description copied from interface: AutoScaling

Lists the autoscaling policies in the specified autoscaling configuration.

Specified by:

listAutoScalingPolicies in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAutoScalingConfiguration

public UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)

Description copied from interface: AutoScaling

Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.

Specified by:

updateAutoScalingConfiguration in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAutoScalingPolicy

public UpdateAutoScalingPolicyResponse updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request)

Description copied from interface: AutoScaling

Updates an autoscaling policy in the specified autoscaling configuration.

Specified by:

updateAutoScalingPolicy in interface AutoScaling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public AutoScalingPaginators getPaginators()

Description copied from interface: AutoScaling

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 AutoScaling

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()