Package com.hazelcast.config
Enum Class RestEndpointGroup
- All Implemented Interfaces:
Serializable
,Comparable<RestEndpointGroup>
,Constable
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 ConstantDescriptionGroup of operations for retrieving cluster state and its version.Operations which changes cluster or node state or their configurations.Groups of HTTP REST APIs for CP subsystem interactionGroup of HTTP REST APIs for data manipulation in the cluster (e.g.Group of endpoints for HTTP health checking.Deprecated.Group of HTTP REST APIs related to Persistence feature.Group of HTTP REST APIs related to WAN Replication feature. -
Method Summary
Modifier and TypeMethodDescriptionstatic Collection<RestEndpointGroup>
int
getCode()
static RestEndpointGroup
getRestEndpointGroup
(int code) boolean
Returns if this group is enabled by default.static RestEndpointGroup
Returns the enum constant of this class with the specified name.static RestEndpointGroup[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CLUSTER_READ
Group of operations for retrieving cluster state and its version. -
CLUSTER_WRITE
Operations which changes cluster or node state or their configurations. -
HEALTH_CHECK
Group of endpoints for HTTP health checking. -
PERSISTENCE
Group of HTTP REST APIs related to Persistence feature. -
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
Group of HTTP REST APIs related to WAN Replication feature. -
DATA
Group of HTTP REST APIs for data manipulation in the cluster (e.g. IMap and IQueue operations). -
CP
Groups of HTTP REST APIs for CP subsystem interaction
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getAllEndpointGroups
-
isEnabledByDefault
public boolean isEnabledByDefault()Returns if this group is enabled by default. -
getCode
public int getCode() -
getRestEndpointGroup
-
PERSISTENCE
instead.