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)	Deletes a query rule within a query ruleset.
final DeleteRuleResponse	deleteRule(Function<DeleteRuleRequest.Builder,ObjectBuilder<DeleteRuleRequest>> fn)	Deletes a query rule within a query ruleset.
DeleteRulesetResponse	deleteRuleset(DeleteRulesetRequest request)	Deletes a query ruleset.
final DeleteRulesetResponse	deleteRuleset(Function<DeleteRulesetRequest.Builder,ObjectBuilder<DeleteRulesetRequest>> fn)	Deletes a query ruleset.
GetRuleResponse	getRule(GetRuleRequest request)	Returns the details about a query rule within a query ruleset
final GetRuleResponse	getRule(Function<GetRuleRequest.Builder,ObjectBuilder<GetRuleRequest>> fn)	Returns the details about a query rule within a query ruleset
GetRulesetResponse	getRuleset(GetRulesetRequest request)	Returns the details about a query ruleset
final GetRulesetResponse	getRuleset(Function<GetRulesetRequest.Builder,ObjectBuilder<GetRulesetRequest>> fn)	Returns the details about a query ruleset
ListRulesetsResponse	listRulesets()	Returns summarized information about existing query rulesets.
ListRulesetsResponse	listRulesets(ListRulesetsRequest request)	Returns summarized information about existing query rulesets.
final ListRulesetsResponse	listRulesets(Function<ListRulesetsRequest.Builder,ObjectBuilder<ListRulesetsRequest>> fn)	Returns summarized information about existing query rulesets.
PutRuleResponse	putRule(PutRuleRequest request)	Creates or updates a query rule within a query ruleset.
final PutRuleResponse	putRule(Function<PutRuleRequest.Builder,ObjectBuilder<PutRuleRequest>> fn)	Creates or updates a query rule within a query ruleset.
PutRulesetResponse	putRuleset(PutRulesetRequest request)	Creates or updates a query ruleset.
final PutRulesetResponse	putRuleset(Function<PutRulesetRequest.Builder,ObjectBuilder<PutRulesetRequest>> fn)	Creates or updates a query ruleset.
TestResponse	test(TestRequest request)	Creates or updates a query ruleset.
final TestResponse	test(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)	Creates or updates 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

Deletes a query rule within a query ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRule

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

Deletes a query rule within a query ruleset.

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

Deletes a query ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRuleset

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

Deletes a query ruleset.

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

Returns the 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

Returns the 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

Returns the 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

Returns the 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

Returns summarized information about existing 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

Returns summarized information about existing 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

Returns summarized information about existing query rulesets.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRule

public PutRuleResponse putRule(PutRuleRequest request)
                        throws IOException,
ElasticsearchException

Creates or updates a query rule within a query ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRule

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

Creates or updates a query rule within a query 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

Creates or updates a query ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRuleset

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

Creates or updates a query 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

Creates or updates a query ruleset.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

test

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

Creates or updates a query ruleset.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co