Package com.hazelcast.config

Enum Class RestEndpointGroup

java.lang.Object
java.lang.Enum<RestEndpointGroup>
com.hazelcast.config.RestEndpointGroup
All Implemented Interfaces:
Serializable, Comparable<RestEndpointGroup>, Constable
@Deprecated(since="5.5", forRemoval=true) public enum RestEndpointGroup extends Enum<RestEndpointGroup>
Deprecated, for removal: This API element is subject to removal in a future version.
use RestConfig instead. Will be removed at 6.0.
Enum of REST endpoint groups. A REST group is predefined set of REST endpoints which can be enabled or disabled. Groups don't overlap - each Hazelcast REST endpoint belongs to exactly one group. Each group has a default value (isEnabledByDefault()) which controls if it will be included by default in RestApiConfig configuration.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CLUSTER_READ
    Deprecated, for removal: This API element is subject to removal in a future version.
    Group of operations for retrieving cluster state and its version.
    CLUSTER_WRITE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Operations which changes cluster or node state or their configurations.
    CP
    Deprecated, for removal: This API element is subject to removal in a future version.
    Groups of HTTP REST APIs for CP subsystem interaction
    DATA
    Deprecated, for removal: This API element is subject to removal in a future version.
    Group of HTTP REST APIs for data manipulation in the cluster (e.g.
    HEALTH_CHECK
    Deprecated, for removal: This API element is subject to removal in a future version.
    Group of endpoints for HTTP health checking.
    HOT_RESTART
    Deprecated.
    Please use PERSISTENCE instead.
    PERSISTENCE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Group of HTTP REST APIs related to Persistence feature.
    WAN
    Deprecated, for removal: This API element is subject to removal in a future version.
    Group of HTTP REST APIs related to WAN Replication feature.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Collection<RestEndpointGroup>
    getAllEndpointGroups()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static RestEndpointGroup
    getRestEndpointGroup(int code)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isEnabledByDefault()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns if this group is enabled by default.
    static RestEndpointGroup
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static RestEndpointGroup[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CLUSTER_READ

      public static final RestEndpointGroup CLUSTER_READ
      Deprecated, for removal: This API element is subject to removal in a future version.
      Group of operations for retrieving cluster state and its version.

    • CLUSTER_WRITE

      public static final RestEndpointGroup CLUSTER_WRITE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Operations which changes cluster or node state or their configurations.

    • HEALTH_CHECK

      public static final RestEndpointGroup HEALTH_CHECK
      Deprecated, for removal: This API element is subject to removal in a future version.
      Group of endpoints for HTTP health checking.

    • PERSISTENCE

      public static final RestEndpointGroup PERSISTENCE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Group of HTTP REST APIs related to Persistence feature.

    • HOT_RESTART

      @Deprecated(since="5.0") public static final RestEndpointGroup HOT_RESTART
      Deprecated.
      Please use PERSISTENCE instead. If this deprecated endpoint group is tried to be activated, we apply this change as it's made to RestEndpointGroup#PERSISTENCE.

    • WAN

      public static final RestEndpointGroup WAN
      Deprecated, for removal: This API element is subject to removal in a future version.
      Group of HTTP REST APIs related to WAN Replication feature.

    • DATA

      public static final RestEndpointGroup DATA
      Deprecated, for removal: This API element is subject to removal in a future version.
      Group of HTTP REST APIs for data manipulation in the cluster (e.g. IMap and IQueue operations).

    • CP

      public static final RestEndpointGroup CP
      Deprecated, for removal: This API element is subject to removal in a future version.
      Groups of HTTP REST APIs for CP subsystem interaction

  • Method Details

    • values

      public static RestEndpointGroup[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 RestEndpointGroup valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • getAllEndpointGroups

      public static Collection<RestEndpointGroup> getAllEndpointGroups()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isEnabledByDefault

      public boolean isEnabledByDefault()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns if this group is enabled by default.

    • getCode

      public int getCode()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRestEndpointGroup

      public static RestEndpointGroup getRestEndpointGroup(int code)
      Deprecated, for removal: This API element is subject to removal in a future version.