Module org.elasticsearch.xcore

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

Class CreateApiKeyRequest

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

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

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public final class CreateApiKeyRequest
extends AbstractCreateApiKeyRequest

Request class used for the creation of an API key. The request requires a name to be provided and optionally an expiration time and permission limitation can be provided.

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.elasticsearch.xpack.core.security.action.apikey.AbstractCreateApiKeyRequest

expiration, id, metadata, name, refreshPolicy, roleDescriptors

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
CreateApiKeyRequest()
CreateApiKeyRequest(String name, List<RoleDescriptor> roleDescriptors, TimeValue expiration)	Create API Key request constructor
CreateApiKeyRequest(String name, List<RoleDescriptor> roleDescriptors, TimeValue expiration, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
ApiKey.Type	getType()
void	setExpiration(TimeValue expiration)
void	setId()
void	setMetadata(Map<String,Object> metadata)
void	setName(String name)
void	setRoleDescriptors(List<RoleDescriptor> roleDescriptors)
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.xpack.core.security.action.apikey.AbstractCreateApiKeyRequest

getExpiration, getId, getMetadata, getName, getRefreshPolicy, getRoleDescriptors, setRefreshPolicy, writeTo

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

Constructor Details

CreateApiKeyRequest

public CreateApiKeyRequest()

CreateApiKeyRequest

public CreateApiKeyRequest(String name,
 @Nullable
 List<RoleDescriptor> roleDescriptors,
 @Nullable
 TimeValue expiration)

Create API Key request constructor

Parameters:

name - name for the API key

roleDescriptors - list of RoleDescriptors

expiration - to specify expiration for the API key

CreateApiKeyRequest

public CreateApiKeyRequest(String name,
 @Nullable
 List<RoleDescriptor> roleDescriptors,
 @Nullable
 TimeValue expiration,
 @Nullable
 Map<String,Object> metadata)

Method Details

getType

public ApiKey.Type getType()

Specified by:

getType in class AbstractCreateApiKeyRequest

setId

public void setId()

setName

public void setName(String name)

setExpiration

public void setExpiration(@Nullable
 TimeValue expiration)

setRoleDescriptors

public void setRoleDescriptors(@Nullable
 List<RoleDescriptor> roleDescriptors)

setMetadata

public void setMetadata(Map<String,Object> metadata)

validate

public ActionRequestValidationException validate()

Overrides:

validate in class AbstractCreateApiKeyRequest