Module org.elasticsearch.xcore

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

Class AbstractCreateApiKeyRequest

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.AbstractCreateApiKeyRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Direct Known Subclasses:

CreateApiKeyRequest, CreateCrossClusterApiKeyRequest

public abstract class AbstractCreateApiKeyRequest
extends UntypedActionRequest

Nested Class Summary

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
protected TimeValue	expiration
protected final String	id
protected Map<String,Object>	metadata
protected String	name
protected WriteRequest.RefreshPolicy	refreshPolicy
protected List<RoleDescriptor>	roleDescriptors

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
AbstractCreateApiKeyRequest()

Method Summary

Modifier and Type	Method	Description
TimeValue	getExpiration()
String	getId()
Map<String,Object>	getMetadata()
String	getName()
WriteRequest.RefreshPolicy	getRefreshPolicy()
List<RoleDescriptor>	getRoleDescriptors()
abstract ApiKey.Type	getType()
void	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
ActionRequestValidationException	validate()
final 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, equals, finalize, getClass, hashCode, 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

Field Details

id

protected final String id

name

protected String name

expiration

protected TimeValue expiration

metadata

protected Map<String,Object> metadata

roleDescriptors

protected List<RoleDescriptor> roleDescriptors

refreshPolicy

protected WriteRequest.RefreshPolicy refreshPolicy

Constructor Details

AbstractCreateApiKeyRequest

public AbstractCreateApiKeyRequest()

Method Details

getId

public String getId()

getName

public String getName()

getType

public abstract ApiKey.Type getType()

getExpiration

public TimeValue getExpiration()

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors()

getRefreshPolicy

public WriteRequest.RefreshPolicy getRefreshPolicy()

setRefreshPolicy

public void setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

getMetadata

public Map<String,Object> getMetadata()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException