Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoScalingClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • AutoScalingClient

Constructors

constructor

  • new AutoScalingClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): AutoScalingClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

targetService

targetService: string = "AutoScaling"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://autoscaling.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeAutoScalingConfigurationCompartment

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAutoScalingConfigurationCompartment API.

    Parameters

    Returns Promise<ChangeAutoScalingConfigurationCompartmentResponse>

    ChangeAutoScalingConfigurationCompartmentResponse

createAutoScalingConfiguration

createAutoScalingPolicy

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAutoScalingPolicy API.

    Parameters

    Returns Promise<CreateAutoScalingPolicyResponse>

    CreateAutoScalingPolicyResponse

deleteAutoScalingConfiguration

deleteAutoScalingPolicy

getAutoScalingConfiguration

getAutoScalingPolicy

  • Gets information about the specified autoscaling policy in the specified autoscaling configuration. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAutoScalingPolicy API.

    Parameters

    Returns Promise<GetAutoScalingPolicyResponse>

    GetAutoScalingPolicyResponse

listAllAutoScalingConfigurations

  • NOTE: This function is deprecated in favor of listAutoScalingConfigurationsRecordIterator function. Creates a new async iterator which will iterate over the models.AutoScalingConfigurationSummary objects contained in responses from the listAutoScalingConfigurations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutoScalingConfigurationSummary>

listAllAutoScalingConfigurationsResponses

listAllAutoScalingPolicies

  • NOTE: This function is deprecated in favor of listAutoScalingPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.AutoScalingPolicySummary objects contained in responses from the listAutoScalingPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutoScalingPolicySummary>

listAllAutoScalingPoliciesResponses

  • NOTE: This function is deprecated in favor of listAutoScalingPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAutoScalingPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAutoScalingPoliciesResponse>

listAutoScalingConfigurations

  • Lists autoscaling configurations in the specifed compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAutoScalingConfigurations API.

    Parameters

    Returns Promise<ListAutoScalingConfigurationsResponse>

    ListAutoScalingConfigurationsResponse

listAutoScalingConfigurationsRecordIterator

listAutoScalingConfigurationsResponseIterator

listAutoScalingPolicies

  • Lists the autoscaling policies in the specified autoscaling configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAutoScalingPolicies API.

    Parameters

    Returns Promise<ListAutoScalingPoliciesResponse>

    ListAutoScalingPoliciesResponse

listAutoScalingPoliciesRecordIterator

listAutoScalingPoliciesResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAutoScalingConfiguration

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

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAutoScalingConfiguration API.

    Parameters

    Returns Promise<UpdateAutoScalingConfigurationResponse>

    UpdateAutoScalingConfigurationResponse

updateAutoScalingPolicy