Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.apikey

Class QueryApiKeyResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.xpack.core.security.action.apikey.QueryApiKeyResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public final class QueryApiKeyResponse
extends ActionResponse
implements ToXContentObject

Response for search API keys.
The result contains information about the API keys that were found.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	QueryApiKeyResponse.Item

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final QueryApiKeyResponse	EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QueryApiKeyResponse(long total, Collection<ApiKey> foundApiKeysInfos, Collection<Object[]> sortValues, Collection<String> ownerProfileUids, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
InternalAggregations	getAggregations()
List<QueryApiKeyResponse.Item>	getApiKeyInfoList()
long	getTotal()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

EMPTY

public static final QueryApiKeyResponse EMPTY

Constructor Details

QueryApiKeyResponse

public QueryApiKeyResponse(long total,
 Collection<ApiKey> foundApiKeysInfos,
 Collection<Object[]> sortValues,
 @Nullable
 Collection<String> ownerProfileUids,
 @Nullable
 InternalAggregations aggregations)

Method Details

getTotal

public long getTotal()

getApiKeyInfoList

public List<QueryApiKeyResponse.Item> getApiKeyInfoList()

getAggregations

public InternalAggregations getAggregations()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object