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 java.lang.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​(java.lang.String name, java.util.List<Role> roles, org.elasticsearch.common.unit.TimeValue expiration, RefreshPolicy refreshPolicy)
    Create API Key request constructor

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    org.elasticsearch.common.unit.TimeValue getExpiration()  
    java.lang.String getName()  
    RefreshPolicy getRefreshPolicy()  
    java.util.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​(java.lang.String name, java.util.List<Role> roles, @Nullable org.elasticsearch.common.unit.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 Details

    • getName

      public java.lang.String getName()

    • getExpiration

      public org.elasticsearch.common.unit.TimeValue getExpiration()

    • getRoles

      public java.util.List<Role> getRoles()

    • getRefreshPolicy

      public RefreshPolicy getRefreshPolicy()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

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

    • toXContent

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