Package com.algolia.model.search

Enum Class Acl

java.lang.Object
java.lang.Enum<Acl>
com.algolia.model.search.Acl
All Implemented Interfaces:
Serializable, Comparable<Acl>, Constable
public enum Acl extends Enum<Acl>
API key permissions: `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.

  • Enum Constant Details

    • ADD_OBJECT

      public static final Acl ADD_OBJECT

    • ANALYTICS

      public static final Acl ANALYTICS

    • BROWSE

      public static final Acl BROWSE

    • DELETE_OBJECT

      public static final Acl DELETE_OBJECT

    • DELETE_INDEX

      public static final Acl DELETE_INDEX

    • EDIT_SETTINGS

      public static final Acl EDIT_SETTINGS

    • LIST_INDEXES

      public static final Acl LIST_INDEXES

    • LOGS

      public static final Acl LOGS

    • PERSONALIZATION

      public static final Acl PERSONALIZATION

    • RECOMMENDATION

      public static final Acl RECOMMENDATION

    • SEE_UNRETRIEVABLE_ATTRIBUTES

      public static final Acl SEE_UNRETRIEVABLE_ATTRIBUTES

    • SETTINGS

      public static final Acl SETTINGS

    • USAGE

      public static final Acl USAGE

  • Method Details

    • values

      public static Acl[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Acl valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Acl>

    • fromValue

      public static Acl fromValue(String value)