Package co.elastic.clients.elasticsearch.query_rules

Class ElasticsearchQueryRulesClient

java.lang.Object

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

co.elastic.clients.elasticsearch.query_rules.ElasticsearchQueryRulesClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchQueryRulesClient
extends ApiClient<ElasticsearchTransport,ElasticsearchQueryRulesClient>

Client for the query_rules namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchQueryRulesClient

public ElasticsearchQueryRulesClient(ElasticsearchTransport transport)

ElasticsearchQueryRulesClient

public ElasticsearchQueryRulesClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchQueryRulesClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchQueryRulesClient>

deleteRule

public DeleteRuleResponse deleteRule(DeleteRuleRequest request)
                              throws IOException,
ElasticsearchException

Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRule

public final DeleteRuleResponse deleteRule(Function<DeleteRuleRequest.Builder,ObjectBuilder<DeleteRuleRequest>> fn)
                                    throws IOException,
ElasticsearchException

Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRuleset

public DeleteRulesetResponse deleteRuleset(DeleteRulesetRequest request)
                                    throws IOException,
ElasticsearchException

Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRuleset

public final DeleteRulesetResponse deleteRuleset(Function<DeleteRulesetRequest.Builder,ObjectBuilder<DeleteRulesetRequest>> fn)
                                          throws IOException,
ElasticsearchException

Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRule

public GetRuleResponse getRule(GetRuleRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRule

public final GetRuleResponse getRule(Function<GetRuleRequest.Builder,ObjectBuilder<GetRuleRequest>> fn)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRuleset

public GetRulesetResponse getRuleset(GetRulesetRequest request)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRuleset

public final GetRulesetResponse getRuleset(Function<GetRulesetRequest.Builder,ObjectBuilder<GetRulesetRequest>> fn)
                                    throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

listRulesets

public ListRulesetsResponse listRulesets(ListRulesetsRequest request)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

listRulesets

public final ListRulesetsResponse listRulesets(Function<ListRulesetsRequest.Builder,ObjectBuilder<ListRulesetsRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

listRulesets

public ListRulesetsResponse listRulesets()
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRule

public PutRuleResponse putRule(PutRuleRequest request)
                        throws IOException,
ElasticsearchException

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

IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRule

public final PutRuleResponse putRule(Function<PutRuleRequest.Builder,ObjectBuilder<PutRuleRequest>> fn)
                              throws IOException,
ElasticsearchException

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

IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRuleset

public PutRulesetResponse putRuleset(PutRulesetRequest request)
                              throws IOException,
ElasticsearchException

Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the xpack.applications.rules.max_rules_per_ruleset cluster setting.

IMPORTANT: Due to limitations within pinned queries, you can only select documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRuleset

public final PutRulesetResponse putRuleset(Function<PutRulesetRequest.Builder,ObjectBuilder<PutRulesetRequest>> fn)
                                    throws IOException,
ElasticsearchException

Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the xpack.applications.rules.max_rules_per_ruleset cluster setting.

IMPORTANT: Due to limitations within pinned queries, you can only select documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

test

public TestResponse test(TestRequest request)
                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

test

public final TestResponse test(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co