Package co.elastic.clients.elasticsearch.xpack

Class XpackInfoRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.xpack.XpackInfoRequest

public class XpackInfoRequest
extends RequestBase

Get information. The information provided by the API includes:

• Build information including the build number and timestamp.
• License information about the currently installed license.
• Feature information for the features that are currently enabled and available under the current license.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<XpackInfoRequest,XpackInfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "xpack.info".

Method Summary

Modifier and Type	Method	Description
final Boolean	acceptEnterprise()	If this param is used it must be set to true
final List<XPackCategory>	categories()	A comma-separated list of the information categories to include in the response.
final Boolean	human()	Defines whether additional human-readable information is included in the response.
static XpackInfoRequest	of(Function<XpackInfoRequest.Builder,ObjectBuilder<XpackInfoRequest>> 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<XpackInfoRequest,XpackInfoResponse,ErrorResponse> _ENDPOINT

Endpoint "xpack.info".

Method Details

of

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

acceptEnterprise

@Nullable
public final Boolean acceptEnterprise()

If this param is used it must be set to true

API name: accept_enterprise

categories

public final List<XPackCategory> categories()

A comma-separated list of the information categories to include in the response. For example, build,license,features.

API name: categories

human

@Nullable
public final Boolean human()

Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.

API name: human