Package co.elastic.clients.elasticsearch.license

Class PostStartBasicRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.license.PostStartBasicRequest

public class PostStartBasicRequest
extends RequestBase

Start a basic license.

Start an indefinite basic license, which gives access to all the basic features.

NOTE: In order to start a basic license, you must not currently have a basic license.

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 get basic license API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PostStartBasicRequest,PostStartBasicResponse,ErrorResponse>	_ENDPOINT	Endpoint "license.post_start_basic".

Method Summary

Modifier and Type	Method	Description
final Boolean	acknowledge()	whether the user has acknowledged acknowledge messages (default: false)
final Time	masterTimeout()	Period to wait for a connection to the master node.
static PostStartBasicRequest	of(Function<PostStartBasicRequest.Builder,ObjectBuilder<PostStartBasicRequest>> fn)
final Time	timeout()	Period to wait for a response.

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<PostStartBasicRequest,PostStartBasicResponse,ErrorResponse> _ENDPOINT

Endpoint "license.post_start_basic".

Method Details

of

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

acknowledge

@Nullable
public final Boolean acknowledge()

whether the user has acknowledged acknowledge messages (default: false)

API name: acknowledge

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

timeout

@Nullable
public final Time timeout()

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

API name: timeout