Package co.elastic.clients.elasticsearch.security.query_api_keys

Class ApiKeyQuery

java.lang.Object

co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyQuery

All Implemented Interfaces:

ApiKeyAggregationVariant, JsonpSerializable, OpenTaggedUnion<ApiKeyQuery.Kind,Object>, TaggedUnion<ApiKeyQuery.Kind,Object>

@JsonpDeserializable
public class ApiKeyQuery
extends Object
implements OpenTaggedUnion<ApiKeyQuery.Kind,Object>, ApiKeyAggregationVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiKeyQuery.Builder
static enum	ApiKeyQuery.Kind	ApiKeyQuery variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ApiKeyQuery>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
ApiKeyQuery(ApiKeyQueryVariant value)

Method Summary

Modifier and Type	Method	Description
ApiKeyAggregation.Kind	_apiKeyAggregationKind()	ApiKeyAggregation variant kind.
JsonData	_custom()	Get the custom plugin-defined variant value.
final String	_customKind()	Get the actual kind when _kind() equals ApiKeyQuery.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom ApiKeyQuery defined by a plugin?
final ApiKeyQuery.Kind	_kind()	Get the of the kind of variant held by this object.
BoolQuery	bool()	Get the bool variant value.
ExistsQuery	exists()	Get the exists variant value.
IdsQuery	ids()	Get the ids variant value.
boolean	isBool()	Is this variant instance of kind bool?
boolean	isExists()	Is this variant instance of kind exists?
boolean	isIds()	Is this variant instance of kind ids?
boolean	isMatch()	Is this variant instance of kind match?
boolean	isMatchAll()	Is this variant instance of kind match_all?
boolean	isPrefix()	Is this variant instance of kind prefix?
boolean	isRange()	Is this variant instance of kind range?
boolean	isSimpleQueryString()	Is this variant instance of kind simple_query_string?
boolean	isTerm()	Is this variant instance of kind term?
boolean	isTerms()	Is this variant instance of kind terms?
boolean	isWildcard()	Is this variant instance of kind wildcard?
MatchQuery	match()	Get the match variant value.
MatchAllQuery	matchAll()	Get the match_all variant value.
static ApiKeyQuery	of(Function<ApiKeyQuery.Builder,ObjectBuilder<ApiKeyQuery>> fn)
PrefixQuery	prefix()	Get the prefix variant value.
RangeQuery	range()	Get the range variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupApiKeyQueryDeserializer(ObjectDeserializer<ApiKeyQuery.Builder> op)
SimpleQueryStringQuery	simpleQueryString()	Get the simple_query_string variant value.
TermQuery	term()	Get the term variant value.
TermsQuery	terms()	Get the terms variant value.
String	toString()
WildcardQuery	wildcard()	Get the wildcard variant value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregationVariant

_toApiKeyAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ApiKeyQuery> _DESERIALIZER

Constructor Details

ApiKeyQuery

public ApiKeyQuery(ApiKeyQueryVariant value)

Method Details

_apiKeyAggregationKind

public ApiKeyAggregation.Kind _apiKeyAggregationKind()

ApiKeyAggregation variant kind.

Specified by:

_apiKeyAggregationKind in interface ApiKeyAggregationVariant

_kind

public final ApiKeyQuery.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<ApiKeyQuery.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<ApiKeyQuery.Kind,Object>

of

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

isBool

public boolean isBool()

Is this variant instance of kind bool?

bool

public BoolQuery bool()

Get the bool variant value.

Throws:

IllegalStateException - if the current variant is not of the bool kind.

isExists

public boolean isExists()

Is this variant instance of kind exists?

exists

public ExistsQuery exists()

Get the exists variant value.

Throws:

IllegalStateException - if the current variant is not of the exists kind.

isIds

public boolean isIds()

Is this variant instance of kind ids?

ids

public IdsQuery ids()

Get the ids variant value.

Throws:

IllegalStateException - if the current variant is not of the ids kind.

isMatch

public boolean isMatch()

Is this variant instance of kind match?

match

public MatchQuery match()

Get the match variant value.

Throws:

IllegalStateException - if the current variant is not of the match kind.

isMatchAll

public boolean isMatchAll()

Is this variant instance of kind match_all?

matchAll

public MatchAllQuery matchAll()

Get the match_all variant value.

Throws:

IllegalStateException - if the current variant is not of the match_all kind.

isPrefix

public boolean isPrefix()

Is this variant instance of kind prefix?

prefix

public PrefixQuery prefix()

Get the prefix variant value.

Throws:

IllegalStateException - if the current variant is not of the prefix kind.

isRange

public boolean isRange()

Is this variant instance of kind range?

range

public RangeQuery range()

Get the range variant value.

Throws:

IllegalStateException - if the current variant is not of the range kind.

isSimpleQueryString

public boolean isSimpleQueryString()

Is this variant instance of kind simple_query_string?

simpleQueryString

public SimpleQueryStringQuery simpleQueryString()

Get the simple_query_string variant value.

Throws:

IllegalStateException - if the current variant is not of the simple_query_string kind.

isTerm

public boolean isTerm()

Is this variant instance of kind term?

term

public TermQuery term()

Get the term variant value.

Throws:

IllegalStateException - if the current variant is not of the term kind.

isTerms

public boolean isTerms()

Is this variant instance of kind terms?

terms

public TermsQuery terms()

Get the terms variant value.

Throws:

IllegalStateException - if the current variant is not of the terms kind.

isWildcard

public boolean isWildcard()

Is this variant instance of kind wildcard?

wildcard

public WildcardQuery wildcard()

Get the wildcard variant value.

Throws:

IllegalStateException - if the current variant is not of the wildcard kind.

_isCustom

public boolean _isCustom()

Is this a custom ApiKeyQuery defined by a plugin?

_customKind

@Nullable
public final String _customKind()

Get the actual kind when _kind() equals ApiKeyQuery.Kind._Custom (plugin-defined variant).

Specified by:

_customKind in interface OpenTaggedUnion<ApiKeyQuery.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not ApiKeyQuery.Kind._Custom.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupApiKeyQueryDeserializer

protected static void setupApiKeyQueryDeserializer(ObjectDeserializer<ApiKeyQuery.Builder> op)