Module org.elasticsearch.xcore

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

Class GetApiKeyRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

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

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public final class GetApiKeyRequest
extends UntypedActionRequest

Request for get API key

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetApiKeyRequest.Builder

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

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

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Method Summary

Modifier and Type	Method	Description
boolean	activeOnly()
static GetApiKeyRequest.Builder	builder()
boolean	equals(Object o)
String	getApiKeyId()
String	getApiKeyName()
String	getRealmName()
String	getUserName()
int	hashCode()
boolean	ownedByAuthenticatedUser()
ActionRequestValidationException	validate()
boolean	withLimitedBy()
boolean	withProfileUid()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

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

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Method Details

getRealmName

public String getRealmName()

getUserName

public String getUserName()

getApiKeyId

public String getApiKeyId()

getApiKeyName

public String getApiKeyName()

ownedByAuthenticatedUser

public boolean ownedByAuthenticatedUser()

withLimitedBy

public boolean withLimitedBy()

activeOnly

public boolean activeOnly()

withProfileUid

public boolean withProfileUid()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static GetApiKeyRequest.Builder builder()