Package co.elastic.clients.elasticsearch.query_rules

Class ElasticsearchQueryRulesAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.query_rules.ElasticsearchQueryRulesAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchQueryRulesAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchQueryRulesAsyncClient>

Client for the query_rules namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteRuleResponse>	deleteRule(DeleteRuleRequest request)	Delete a query rule.
final CompletableFuture<DeleteRuleResponse>	deleteRule(Function<DeleteRuleRequest.Builder,ObjectBuilder<DeleteRuleRequest>> fn)	Delete a query rule.
CompletableFuture<DeleteRulesetResponse>	deleteRuleset(DeleteRulesetRequest request)	Delete a query ruleset.
final CompletableFuture<DeleteRulesetResponse>	deleteRuleset(Function<DeleteRulesetRequest.Builder,ObjectBuilder<DeleteRulesetRequest>> fn)	Delete a query ruleset.
CompletableFuture<GetRuleResponse>	getRule(GetRuleRequest request)	Get a query rule.
final CompletableFuture<GetRuleResponse>	getRule(Function<GetRuleRequest.Builder,ObjectBuilder<GetRuleRequest>> fn)	Get a query rule.
CompletableFuture<GetRulesetResponse>	getRuleset(GetRulesetRequest request)	Get a query ruleset.
final CompletableFuture<GetRulesetResponse>	getRuleset(Function<GetRulesetRequest.Builder,ObjectBuilder<GetRulesetRequest>> fn)	Get a query ruleset.
CompletableFuture<ListRulesetsResponse>	listRulesets()	Get all query rulesets.
CompletableFuture<ListRulesetsResponse>	listRulesets(ListRulesetsRequest request)	Get all query rulesets.
final CompletableFuture<ListRulesetsResponse>	listRulesets(Function<ListRulesetsRequest.Builder,ObjectBuilder<ListRulesetsRequest>> fn)	Get all query rulesets.
CompletableFuture<PutRuleResponse>	putRule(PutRuleRequest request)	Create or update a query rule.
final CompletableFuture<PutRuleResponse>	putRule(Function<PutRuleRequest.Builder,ObjectBuilder<PutRuleRequest>> fn)	Create or update a query rule.
CompletableFuture<PutRulesetResponse>	putRuleset(PutRulesetRequest request)	Create or update a query ruleset.
final CompletableFuture<PutRulesetResponse>	putRuleset(Function<PutRulesetRequest.Builder,ObjectBuilder<PutRulesetRequest>> fn)	Create or update a query ruleset.
CompletableFuture<TestResponse>	test(TestRequest request)	Test a query ruleset.
final CompletableFuture<TestResponse>	test(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)	Test a query ruleset.
ElasticsearchQueryRulesAsyncClient	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

ElasticsearchQueryRulesAsyncClient

public ElasticsearchQueryRulesAsyncClient(ElasticsearchTransport transport)

ElasticsearchQueryRulesAsyncClient

public ElasticsearchQueryRulesAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchQueryRulesAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchQueryRulesAsyncClient>

deleteRule

public CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest request)

Delete a query rule. Delete a query rule within a query ruleset.

See Also:

• Documentation on elastic.co

deleteRule

public final CompletableFuture<DeleteRuleResponse> deleteRule(Function<DeleteRuleRequest.Builder,ObjectBuilder<DeleteRuleRequest>> fn)

Delete a query rule. Delete a query rule within a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteRuleset

public CompletableFuture<DeleteRulesetResponse> deleteRuleset(DeleteRulesetRequest request)

Delete a query ruleset.

See Also:

• Documentation on elastic.co

deleteRuleset

public final CompletableFuture<DeleteRulesetResponse> deleteRuleset(Function<DeleteRulesetRequest.Builder,ObjectBuilder<DeleteRulesetRequest>> fn)

Delete a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

getRule

public CompletableFuture<GetRuleResponse> getRule(GetRuleRequest request)

Get a query rule. Get details about a query rule within a query ruleset.

See Also:

• Documentation on elastic.co

getRule

public final CompletableFuture<GetRuleResponse> getRule(Function<GetRuleRequest.Builder,ObjectBuilder<GetRuleRequest>> fn)

Get a query rule. Get details about a query rule within a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

getRuleset

public CompletableFuture<GetRulesetResponse> getRuleset(GetRulesetRequest request)

Get a query ruleset. Get details about a query ruleset.

See Also:

• Documentation on elastic.co

getRuleset

public final CompletableFuture<GetRulesetResponse> getRuleset(Function<GetRulesetRequest.Builder,ObjectBuilder<GetRulesetRequest>> fn)

Get a query ruleset. Get details about a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

listRulesets

public CompletableFuture<ListRulesetsResponse> listRulesets(ListRulesetsRequest request)

Get all query rulesets. Get summarized information about the query rulesets.

See Also:

• Documentation on elastic.co

listRulesets

public final CompletableFuture<ListRulesetsResponse> listRulesets(Function<ListRulesetsRequest.Builder,ObjectBuilder<ListRulesetsRequest>> fn)

Get all query rulesets. Get summarized information about the query rulesets.

Parameters:

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

See Also:

• Documentation on elastic.co

listRulesets

public CompletableFuture<ListRulesetsResponse> listRulesets()

Get all query rulesets. Get summarized information about the query rulesets.

See Also:

• Documentation on elastic.co

putRule

public CompletableFuture<PutRuleResponse> putRule(PutRuleRequest request)

Create or update a query rule. Create or update a query rule within a query ruleset.

See Also:

• Documentation on elastic.co

putRule

public final CompletableFuture<PutRuleResponse> putRule(Function<PutRuleRequest.Builder,ObjectBuilder<PutRuleRequest>> fn)

Create or update a query rule. Create or update a query rule within a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

putRuleset

public CompletableFuture<PutRulesetResponse> putRuleset(PutRulesetRequest request)

Create or update a query ruleset.

See Also:

• Documentation on elastic.co

putRuleset

public final CompletableFuture<PutRulesetResponse> putRuleset(Function<PutRulesetRequest.Builder,ObjectBuilder<PutRulesetRequest>> fn)

Create or update a query ruleset.

Parameters:

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

See Also:

• Documentation on elastic.co

test

public CompletableFuture<TestResponse> test(TestRequest request)

Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.

See Also:

• Documentation on elastic.co

test

public final CompletableFuture<TestResponse> test(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)

Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.

Parameters:

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

See Also:

• Documentation on elastic.co