Package co.elastic.clients.elasticsearch.license

Class ElasticsearchLicenseClient

java.lang.Object

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

co.elastic.clients.elasticsearch.license.ElasticsearchLicenseClient

public class ElasticsearchLicenseClient
extends ApiClient<ElasticsearchTransport,ElasticsearchLicenseClient>

Client for the license namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeleteLicenseResponse	delete()	Deletes licensing information for the cluster
GetLicenseResponse	get()	This API returns information about the type of license, when it was issued, and when it expires, for example.
GetLicenseResponse	get(GetLicenseRequest request)	This API returns information about the type of license, when it was issued, and when it expires, for example.
final GetLicenseResponse	get(Function<GetLicenseRequest.Builder,ObjectBuilder<GetLicenseRequest>> fn)	This API returns information about the type of license, when it was issued, and when it expires, for example.
GetBasicStatusResponse	getBasicStatus()	Retrieves information about the status of the basic license.
GetTrialStatusResponse	getTrialStatus()	Retrieves information about the status of the trial license.
PostResponse	post()	Updates the license for the cluster.
PostResponse	post(PostRequest request)	Updates the license for the cluster.
final PostResponse	post(Function<PostRequest.Builder,ObjectBuilder<PostRequest>> fn)	Updates the license for the cluster.
PostStartBasicResponse	postStartBasic()	The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features.
PostStartBasicResponse	postStartBasic(PostStartBasicRequest request)	The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features.
final PostStartBasicResponse	postStartBasic(Function<PostStartBasicRequest.Builder,ObjectBuilder<PostStartBasicRequest>> fn)	The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features.
PostStartTrialResponse	postStartTrial()	The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
PostStartTrialResponse	postStartTrial(PostStartTrialRequest request)	The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
final PostStartTrialResponse	postStartTrial(Function<PostStartTrialRequest.Builder,ObjectBuilder<PostStartTrialRequest>> fn)	The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
ElasticsearchLicenseClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchLicenseClient

public ElasticsearchLicenseClient(ElasticsearchTransport transport)

ElasticsearchLicenseClient

public ElasticsearchLicenseClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchLicenseClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchLicenseClient>

delete

public DeleteLicenseResponse delete()
                             throws IOException,
ElasticsearchException

Deletes licensing information for the cluster

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetLicenseResponse get(GetLicenseRequest request)
                       throws IOException,
ElasticsearchException

This API returns information about the type of license, when it was issued, and when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final GetLicenseResponse get(Function<GetLicenseRequest.Builder,ObjectBuilder<GetLicenseRequest>> fn)
                             throws IOException,
ElasticsearchException

This API returns information about the type of license, when it was issued, and when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetLicenseResponse get()
                       throws IOException,
ElasticsearchException

This API returns information about the type of license, when it was issued, and when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBasicStatus

public GetBasicStatusResponse getBasicStatus()
                                      throws IOException,
ElasticsearchException

Retrieves information about the status of the basic license.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrialStatus

public GetTrialStatusResponse getTrialStatus()
                                      throws IOException,
ElasticsearchException

Retrieves information about the status of the trial license.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public PostResponse post(PostRequest request)
                  throws IOException,
ElasticsearchException

Updates the license for the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public final PostResponse post(Function<PostRequest.Builder,ObjectBuilder<PostRequest>> fn)
                        throws IOException,
ElasticsearchException

Updates the license for the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public PostResponse post()
                  throws IOException,
ElasticsearchException

Updates the license for the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartBasic

public PostStartBasicResponse postStartBasic(PostStartBasicRequest request)
                                      throws IOException,
ElasticsearchException

The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the following API: Get basic status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartBasic

public final PostStartBasicResponse postStartBasic(Function<PostStartBasicRequest.Builder,ObjectBuilder<PostStartBasicRequest>> fn)
                                            throws IOException,
ElasticsearchException

The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the following API: Get basic status.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartBasic

public PostStartBasicResponse postStartBasic()
                                      throws IOException,
ElasticsearchException

The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the following API: Get basic status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartTrial

public PostStartTrialResponse postStartTrial(PostStartTrialRequest request)
                                      throws IOException,
ElasticsearchException

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartTrial

public final PostStartTrialResponse postStartTrial(Function<PostStartTrialRequest.Builder,ObjectBuilder<PostStartTrialRequest>> fn)
                                            throws IOException,
ElasticsearchException

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postStartTrial

public PostStartTrialResponse postStartTrial()
                                      throws IOException,
ElasticsearchException

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co