Package co.elastic.clients.elasticsearch.license

Class GetLicenseRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.license.GetLicenseRequest

public class GetLicenseRequest
extends RequestBase

Get license information.

Get information about your Elastic license including its type, its status, when it was issued, and when it expires.

info If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetLicenseRequest,GetLicenseResponse,ErrorResponse>	_ENDPOINT	Endpoint "license.get".

Method Summary

Modifier and Type	Method	Description
final Boolean	acceptEnterprise()	Deprecated. 7.6.0
final Boolean	local()	Specifies whether to retrieve local information.
static GetLicenseRequest	of(Function<GetLicenseRequest.Builder,ObjectBuilder<GetLicenseRequest>> 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<GetLicenseRequest,GetLicenseResponse,ErrorResponse> _ENDPOINT

Endpoint "license.get".

Method Details

of

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

acceptEnterprise

@Deprecated
@Nullable
public final Boolean acceptEnterprise()

Deprecated.

7.6.0

If true, this parameter returns enterprise for Enterprise license types. If false, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x.

API name: accept_enterprise

local

@Nullable
public final Boolean local()

Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node.

API name: local