Module org.elasticsearch.xcore

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

Class CloneApiKeyRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.LegacyActionRequest

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

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, TransportRequest

public final class CloneApiKeyRequest
extends LegacyActionRequest

Request for cloning an existing API key. The source key is identified by its encoded credential (Base64(id + ":" + secret)). The new key has the same role descriptors as the source, with a new name, id, and optional expiration and metadata.

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 interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
CloneApiKeyRequest()
CloneApiKeyRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
SecureString	getApiKey()
org.elasticsearch.core.TimeValue	getExpiration()
String	getId()
Map<String,Object>	getMetadata()
String	getName()
WriteRequest.RefreshPolicy	getRefreshPolicy()
ApiKeyCredentials	getSourceApiKey()	Parses the source API key credential into an ApiKeyCredentials instance.
void	setApiKey(SecureString apiKey)
void	setExpiration(org.elasticsearch.core.TimeValue expiration)
void	setMetadata(Map<String,Object> metadata)
void	setName(String name)
void	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

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

CloneApiKeyRequest

public CloneApiKeyRequest()

CloneApiKeyRequest

public CloneApiKeyRequest(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

getApiKey

public SecureString getApiKey()

setApiKey

public void setApiKey(SecureString apiKey)

getSourceApiKey

public ApiKeyCredentials getSourceApiKey()

Parses the source API key credential into an ApiKeyCredentials instance. The clone endpoint only supports REST API keys as the source.

Returns:

the parsed source API key credentials, or null if there is no API key

Throws:

IllegalArgumentException - if the api key is null, empty, or not valid (e.g. malformed Base64 or missing colon)

getId

public String getId()

getName

public String getName()

setName

public void setName(String name)

getExpiration

@Nullable
public org.elasticsearch.core.TimeValue getExpiration()

setExpiration

public void setExpiration(@Nullable
 org.elasticsearch.core.TimeValue expiration)

getMetadata

@Nullable
public Map<String,Object> getMetadata()

setMetadata

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

getRefreshPolicy

public WriteRequest.RefreshPolicy getRefreshPolicy()

setRefreshPolicy

public void setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest