Package org.elasticsearch.client.security

Class CreateApiKeyRequest

java.lang.Object
org.elasticsearch.client.security.CreateApiKeyRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class CreateApiKeyRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request to create API key

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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, 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 Type
    Method
    Description
    boolean
    equals​(Object o)
     
    org.elasticsearch.core.TimeValue
    getExpiration()
     
    Map<String,​Object>
    getMetadata()
     
    String
    getName()
     
    RefreshPolicy
    getRefreshPolicy()
     
    List<Role>
    getRoles()
     
    int
    hashCode()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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.common.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 key
      roles - list of Roles
      expiration - to specify expiration for the API key
      metadata - 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

      public String getName()

    • getExpiration

      public org.elasticsearch.core.TimeValue getExpiration()

    • getRoles

      public List<Role> getRoles()

    • getRefreshPolicy

      public RefreshPolicy getRefreshPolicy()

    • getMetadata

      public Map<String,​Object> getMetadata()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException