Class CreateApiKeyRequest
java.lang.Object
org.elasticsearch.client.security.CreateApiKeyRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public final class CreateApiKeyRequest
extends Object
implements Validatable, org.elasticsearch.xcontent.ToXContentObject
Request to create API key
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionCreateApiKeyRequest
(String name, List<Role> roles, org.elasticsearch.core.TimeValue expiration, RefreshPolicy refreshPolicy) CreateApiKeyRequest
(String name, List<Role> roles, org.elasticsearch.core.TimeValue expiration, RefreshPolicy refreshPolicy, Map<String, Object> metadata) Create API Key request constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
org.elasticsearch.core.TimeValue
getName()
getRoles()
int
hashCode()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Constructor Details
-
CreateApiKeyRequest
public CreateApiKeyRequest(String name, List<Role> roles, @Nullable org.elasticsearch.core.TimeValue expiration, @Nullable RefreshPolicy refreshPolicy, @Nullable Map<String, Object> metadata) Create API Key request constructor- Parameters:
name
- name for the API keyroles
- list ofRole
sexpiration
- to specify expiration for the API keymetadata
- Arbitrary metadata for the API key
-
CreateApiKeyRequest
public CreateApiKeyRequest(String name, List<Role> roles, @Nullable org.elasticsearch.core.TimeValue expiration, @Nullable RefreshPolicy refreshPolicy)
-
-
Method Details
-
getName
-
getExpiration
public org.elasticsearch.core.TimeValue getExpiration() -
getRoles
-
getRefreshPolicy
-
getMetadata
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-