Package co.elastic.clients.elasticsearch.autoscaling

Class ElasticsearchAutoscalingClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchAutoscalingClient>

co.elastic.clients.elasticsearch.autoscaling.ElasticsearchAutoscalingClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchAutoscalingClient
extends ApiClient<ElasticsearchTransport,ElasticsearchAutoscalingClient>

Client for the autoscaling namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchAutoscalingClient(ElasticsearchTransport transport)
ElasticsearchAutoscalingClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeleteAutoscalingPolicyResponse	deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest request)	Delete an autoscaling policy.
final DeleteAutoscalingPolicyResponse	deleteAutoscalingPolicy(Function<DeleteAutoscalingPolicyRequest.Builder,ObjectBuilder<DeleteAutoscalingPolicyRequest>> fn)	Delete an autoscaling policy.
GetAutoscalingCapacityResponse	getAutoscalingCapacity()	Get the autoscaling capacity.
GetAutoscalingCapacityResponse	getAutoscalingCapacity(GetAutoscalingCapacityRequest request)	Get the autoscaling capacity.
final GetAutoscalingCapacityResponse	getAutoscalingCapacity(Function<GetAutoscalingCapacityRequest.Builder,ObjectBuilder<GetAutoscalingCapacityRequest>> fn)	Get the autoscaling capacity.
GetAutoscalingPolicyResponse	getAutoscalingPolicy(GetAutoscalingPolicyRequest request)	Get an autoscaling policy.
final GetAutoscalingPolicyResponse	getAutoscalingPolicy(Function<GetAutoscalingPolicyRequest.Builder,ObjectBuilder<GetAutoscalingPolicyRequest>> fn)	Get an autoscaling policy.
PutAutoscalingPolicyResponse	putAutoscalingPolicy(PutAutoscalingPolicyRequest request)	Create or update an autoscaling policy.
final PutAutoscalingPolicyResponse	putAutoscalingPolicy(Function<PutAutoscalingPolicyRequest.Builder,ObjectBuilder<PutAutoscalingPolicyRequest>> fn)	Create or update an autoscaling policy.
ElasticsearchAutoscalingClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchAutoscalingClient

public ElasticsearchAutoscalingClient(ElasticsearchTransport transport)

ElasticsearchAutoscalingClient

public ElasticsearchAutoscalingClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchAutoscalingClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchAutoscalingClient>

deleteAutoscalingPolicy

public DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest request)
                                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAutoscalingPolicy

public final DeleteAutoscalingPolicyResponse deleteAutoscalingPolicy(Function<DeleteAutoscalingPolicyRequest.Builder,ObjectBuilder<DeleteAutoscalingPolicyRequest>> fn)
                                                              throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the DeleteAutoscalingPolicyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoscalingCapacity

public GetAutoscalingCapacityResponse getAutoscalingCapacity(GetAutoscalingCapacityRequest request)
                                                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoscalingCapacity

public final GetAutoscalingCapacityResponse getAutoscalingCapacity(Function<GetAutoscalingCapacityRequest.Builder,ObjectBuilder<GetAutoscalingCapacityRequest>> fn)
                                                            throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the GetAutoscalingCapacityRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoscalingCapacity

public GetAutoscalingCapacityResponse getAutoscalingCapacity()
                                                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoscalingPolicy

public GetAutoscalingPolicyResponse getAutoscalingPolicy(GetAutoscalingPolicyRequest request)
                                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoscalingPolicy

public final GetAutoscalingPolicyResponse getAutoscalingPolicy(Function<GetAutoscalingPolicyRequest.Builder,ObjectBuilder<GetAutoscalingPolicyRequest>> fn)
                                                        throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the GetAutoscalingPolicyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAutoscalingPolicy

public PutAutoscalingPolicyResponse putAutoscalingPolicy(PutAutoscalingPolicyRequest request)
                                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAutoscalingPolicy

public final PutAutoscalingPolicyResponse putAutoscalingPolicy(Function<PutAutoscalingPolicyRequest.Builder,ObjectBuilder<PutAutoscalingPolicyRequest>> fn)
                                                        throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the PutAutoscalingPolicyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co