Package co.elastic.clients.elasticsearch.xpack

Class ElasticsearchXpackClient

java.lang.Object

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

co.elastic.clients.elasticsearch.xpack.ElasticsearchXpackClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchXpackClient
extends ApiClient<ElasticsearchTransport,ElasticsearchXpackClient>

Client for the xpack namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
XpackInfoResponse	info()	Get information.
XpackInfoResponse	info(XpackInfoRequest request)	Get information.
final XpackInfoResponse	info(Function<XpackInfoRequest.Builder,ObjectBuilder<XpackInfoRequest>> fn)	Get information.
XpackUsageResponse	usage()	Get usage information.
XpackUsageResponse	usage(XpackUsageRequest request)	Get usage information.
final XpackUsageResponse	usage(Function<XpackUsageRequest.Builder,ObjectBuilder<XpackUsageRequest>> fn)	Get usage information.
ElasticsearchXpackClient	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

ElasticsearchXpackClient

public ElasticsearchXpackClient(ElasticsearchTransport transport)

ElasticsearchXpackClient

public ElasticsearchXpackClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchXpackClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchXpackClient>

info

public XpackInfoResponse info(XpackInfoRequest request)
                       throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public final XpackInfoResponse info(Function<XpackInfoRequest.Builder,ObjectBuilder<XpackInfoRequest>> fn)
                             throws IOException,
ElasticsearchException

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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public XpackInfoResponse info()
                       throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public XpackUsageResponse usage(XpackUsageRequest request)
                         throws IOException,
ElasticsearchException

Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public final XpackUsageResponse usage(Function<XpackUsageRequest.Builder,ObjectBuilder<XpackUsageRequest>> fn)
                               throws IOException,
ElasticsearchException

Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public XpackUsageResponse usage()
                         throws IOException,
ElasticsearchException

Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co