32 lines
6.3 KiB
Markdown
32 lines
6.3 KiB
Markdown
## `Autoscaling`
|
||
|
||
### Constructor
|
||
|
||
:::
|
||
new Autoscaling(transport: [Transport](./Transport.md));
|
||
:::
|
||
|
||
### Properties
|
||
|
||
| Name | Type | Description |
|
||
| - | - | - |
|
||
| `acceptedParams` | Record<string, { path: string[]; body: string[]; query: string[]; }> | |
|
||
| `transport` | [Transport](./Transport.md) | |
|
||
|
||
### Methods
|
||
|
||
| Name | Signature | Description |
|
||
| - | - | - |
|
||
| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` | Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. |
|
||
| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md), unknown>>;` | |
|
||
| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` | |
|
||
| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` | Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions. |
|
||
| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md), unknown>>;` | |
|
||
| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` | |
|
||
| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` | Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. |
|
||
| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md), unknown>>;` | |
|
||
| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` | |
|
||
| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` | Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. |
|
||
| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md), unknown>>;` | |
|
||
| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` | |
|