AutoScalingClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.autoscaling.AutoScalingClient

All Implemented Interfaces:: AutoScaling, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AutoScalingClient.Builder
Builder class for this client.

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

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for AutoScaling.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for AutoScaling.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for AutoScaling.
- Constructor Detail
  - AutoScalingClient
```
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - AutoScalingClient
```
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - AutoScalingClient
```
public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - AutoScalingClient
```
public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - AutoScalingClient
```
public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - AutoScalingClient
```
public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         List<ClientConfigurator> additionalClientConfigurators,
                         String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - AutoScalingClient
```
public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                         List<ClientConfigurator> additionalClientConfigurators,
                         String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - AutoScalingClient
```
protected AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint,
                            RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the AutoScalingClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static AutoScalingClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: AutoScaling
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface AutoScaling
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AutoScaling
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface AutoScaling
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: AutoScaling
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface AutoScaling
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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.

Class AutoScalingClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

AutoScalingClient

AutoScalingClient

AutoScalingClient

AutoScalingClient

AutoScalingClient

AutoScalingClient

AutoScalingClient

AutoScalingClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

changeAutoScalingConfigurationCompartment

createAutoScalingConfiguration

createAutoScalingPolicy

deleteAutoScalingConfiguration

deleteAutoScalingPolicy

getAutoScalingConfiguration

getAutoScalingPolicy

listAutoScalingConfigurations

listAutoScalingPolicies

updateAutoScalingConfiguration

updateAutoScalingPolicy

getPaginators