Package org.elasticsearch.client.security

Class CreateApiKeyRequest

java.lang.Object

org.elasticsearch.client.security.CreateApiKeyRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public final class CreateApiKeyRequest
extends Object
implements Validatable, ToXContentObject

Request to create API key

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
CreateApiKeyRequest(String name, List<Role> roles, TimeValue expiration, RefreshPolicy refreshPolicy)	Create API Key request constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TimeValue	getExpiration()
String	getName()
RefreshPolicy	getRefreshPolicy()
List<Role>	getRoles()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Constructor Detail

CreateApiKeyRequest

public CreateApiKeyRequest(@Nullable
                           String name,
                           List<Role> roles,
                           @Nullable
                           TimeValue expiration,
                           @Nullable
                           RefreshPolicy refreshPolicy)

Create API Key request constructor

Parameters:

name - name for the API key

roles - list of Roles

expiration - to specify expiration for the API key

Method Detail

getName

public String getName()

getExpiration

public TimeValue getExpiration()

getRoles

public List<Role> getRoles()

getRefreshPolicy

public RefreshPolicy getRefreshPolicy()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException