Package co.elastic.clients.elasticsearch.autoscaling

Class GetAutoscalingCapacityRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.autoscaling.GetAutoscalingCapacityRequest

public class GetAutoscalingCapacityRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetAutoscalingCapacityRequest.Builder	Builder for GetAutoscalingCapacityRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetAutoscalingCapacityRequest,GetAutoscalingCapacityResponse,ErrorResponse>	_ENDPOINT	Endpoint "autoscaling.get_autoscaling_capacity".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
static GetAutoscalingCapacityRequest	of(Function<GetAutoscalingCapacityRequest.Builder,ObjectBuilder<GetAutoscalingCapacityRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetAutoscalingCapacityRequest,GetAutoscalingCapacityResponse,ErrorResponse> _ENDPOINT

Endpoint "autoscaling.get_autoscaling_capacity".

Method Details

of

public static GetAutoscalingCapacityRequest of(Function<GetAutoscalingCapacityRequest.Builder,ObjectBuilder<GetAutoscalingCapacityRequest>> fn)

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout