Module org.elasticsearch.xcore

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

Class CreateApiKeyResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

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

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public final class CreateApiKeyResponse
extends ActionResponse
implements ToXContentObject

Response for the successful creation of an api key

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CreateApiKeyResponse(String name, String id, SecureString key, Instant expiration)
CreateApiKeyResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static CreateApiKeyResponse	fromXContent(XContentParser parser)
Instant	getExpiration()
String	getId()
SecureString	getKey()
String	getName()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

CreateApiKeyResponse

public CreateApiKeyResponse(String name,
 String id,
 SecureString key,
 Instant expiration)

CreateApiKeyResponse

public CreateApiKeyResponse(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

getName

public String getName()

getId

public String getId()

getKey

public SecureString getKey()

getExpiration

@Nullable
public Instant getExpiration()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromXContent

public static CreateApiKeyResponse fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object