Package com.hazelcast.config
Enum RestEndpointGroup
- java.lang.Object
-
- java.lang.Enum<RestEndpointGroup>
-
- com.hazelcast.config.RestEndpointGroup
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<RestEndpointGroup>
public enum RestEndpointGroup extends java.lang.Enum<RestEndpointGroup>
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 inRestApiConfig
configuration.- See Also:
RestApiConfig
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CLUSTER_READ
Group of operations for retrieving cluster state and its version.CLUSTER_WRITE
Operations which changes cluster or node state or their configurations.CP
Groups of HTTP REST APIs for CP subsystem interactionDATA
Group of HTTP REST APIs for data manipulation in the cluster (e.g.HEALTH_CHECK
Group of endpoints for HTTP health checking.HOT_RESTART
Deprecated.since 5.0 Please usePERSISTENCE
instead.PERSISTENCE
Group of HTTP REST APIs related to Persistence feature.WAN
Group of HTTP REST APIs related to WAN Replication feature.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.Collection<RestEndpointGroup>
getAllEndpointGroups()
int
getCode()
static RestEndpointGroup
getRestEndpointGroup(int code)
boolean
isEnabledByDefault()
Returns if this group is enabled by default.static RestEndpointGroup
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static RestEndpointGroup[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CLUSTER_READ
public static final RestEndpointGroup CLUSTER_READ
Group of operations for retrieving cluster state and its version.
-
CLUSTER_WRITE
public static final RestEndpointGroup CLUSTER_WRITE
Operations which changes cluster or node state or their configurations.
-
HEALTH_CHECK
public static final RestEndpointGroup HEALTH_CHECK
Group of endpoints for HTTP health checking.
-
PERSISTENCE
public static final RestEndpointGroup PERSISTENCE
Group of HTTP REST APIs related to Persistence feature.
-
HOT_RESTART
@Deprecated public static final RestEndpointGroup HOT_RESTART
Deprecated.since 5.0 Please usePERSISTENCE
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
Group of HTTP REST APIs related to WAN Replication feature.
-
DATA
public static final RestEndpointGroup DATA
Group of HTTP REST APIs for data manipulation in the cluster (e.g. IMap and IQueue operations).
-
CP
public static final RestEndpointGroup CP
Groups of HTTP REST APIs for CP subsystem interaction
-
-
Method Detail
-
values
public static RestEndpointGroup[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RestEndpointGroup c : RestEndpointGroup.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RestEndpointGroup valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getAllEndpointGroups
public static java.util.Collection<RestEndpointGroup> getAllEndpointGroups()
-
isEnabledByDefault
public boolean isEnabledByDefault()
Returns if this group is enabled by default.
-
getCode
public int getCode()
-
getRestEndpointGroup
public static RestEndpointGroup getRestEndpointGroup(int code)
-
-