Module org.elasticsearch.xcore

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

Class BaseUpdateApiKeyRequest

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

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Direct Known Subclasses:

BaseBulkUpdateApiKeyRequest, BaseSingleUpdateApiKeyRequest

public abstract class BaseUpdateApiKeyRequest
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 final CertificateIdentity	certificateIdentity
protected final TimeValue	expiration
protected final Map<String,Object>	metadata
protected final List<RoleDescriptor>	roleDescriptors

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
BaseUpdateApiKeyRequest(List<RoleDescriptor> roleDescriptors, Map<String,Object> metadata, TimeValue expiration, CertificateIdentity certificateIdentity)

Method Summary

Modifier and Type	Method	Description
CertificateIdentity	getCertificateIdentity()
TimeValue	getExpiration()
Map<String,Object>	getMetadata()
List<RoleDescriptor>	getRoleDescriptors()
abstract ApiKey.Type	getType()
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

roleDescriptors

@Nullable
protected final List<RoleDescriptor> roleDescriptors

metadata

@Nullable
protected final Map<String,Object> metadata

expiration

@Nullable
protected final TimeValue expiration

certificateIdentity

@Nullable
protected final CertificateIdentity certificateIdentity

Constructor Details

BaseUpdateApiKeyRequest

public BaseUpdateApiKeyRequest(@Nullable
 List<RoleDescriptor> roleDescriptors,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 TimeValue expiration,
 @Nullable
 CertificateIdentity certificateIdentity)

Method Details

getMetadata

public Map<String,Object> getMetadata()

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors()

getExpiration

public TimeValue getExpiration()

getCertificateIdentity

public CertificateIdentity getCertificateIdentity()

getType

public abstract ApiKey.Type getType()

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