schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
hazelcast-config-5.3.json
data-persistence
Used to enable Hazelcast's Persistence feature for the cache. It is available only in Hazelcast Enterprise HD. Set its "enabled" to true to enable the feature. By default, it is disabled.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "fsync": {"type": "boolean", "default": false}}}
hazelcast-config-5.3.json
fsync
Set as true if the writing to disk should be followed by an fsync() system call.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
capacity
The capacity of the event journal. The capacity is the total number of items that the event journal can hold at any moment. The actual number of items contained in the journal can be lower. The capacity is shared equally between all partitions. This is done by assigning each partition capacity / partitionCount available slots in the event journal. Because of this, the effective total capacity may be somewhat lower and you must take into account that the configured capacity is at least greater than the partition count.
{"type": "integer", "minimum": 0, "default": 10000}
hazelcast-config-5.3.json
time-to-live-seconds
Sets the time to live in seconds. Time to live is the time the event journal retains items before removing them from the journal. The events are removed on journal read and write actions, not while the journal is idle. Time to live can be disabled by setting timeToLiveSeconds to 0. This means that the events never expire but they can be overwritten when the capacity of the journal is exceeed. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite.
{"type": "integer", "minimum": 0, "default": 0}
hazelcast-config-5.3.json
disable-per-entry-invalidation-events
Disables invalidation events for each entry; but full-flush invalidation events are still enabled. Full-flush invalidation means the invalidation of events for all entries when clear is called.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
class-name
Fully qualified class name.
{"type": "string"}
hazelcast-config-5.3.json
class-name
Fully qualified class name.
{"type": "string"}
hazelcast-config-5.3.json
management-center
Defines the Hazelcast Management Center related metrics configuration.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": true}, "retention-seconds": {"type": "integer", "minimum": 1, "default": 5}}}
hazelcast-config-5.3.json
enabled
Controls whether the metrics collected are exposed to Hazelcast Management Center. Please note that the metrics are polled by the Hazelcast Management Center, hence the members need to buffer the collected metrics between two polls. The aim for this switch is to reduce memory consumption of the metrics system if the Hazelcast Management Center is not used.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
retention-seconds
Sets the number of seconds the metrics will be retained on the instance. More retention means more heap memory, but allows for longer client hiccups without losing a value (for example to restart the Management Center).
{"type": "integer", "minimum": 1, "default": 5}
hazelcast-config-5.3.json
enabled
The master-switch for the metrics collection. If this is set to false no metrics collection is done, regardless of the other settings.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
jmx
Defines the JMX related metrics configuration.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": true}}}
hazelcast-config-5.3.json
enabled
Controls whether the metrics collected are exposed to through JMX. It is enabled by default. In order to expose the metrics, the metrics system need to be enabled via the enabled master-switch attribute.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
collection-frequency-seconds
Sets the metrics collection frequency in seconds.
{"type": "integer", "minimum": 1, "default": 5}
hazelcast-config-5.3.json
LiteMember
When you want to use a Hazelcast member as a lite member, set this element's "enabled" attribute to true in that member's YAML configuration. Lite members do not store data, do not have partitions and are used mainly to execute tasks and register listeners.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"]}
hazelcast-config-5.3.json
cp-member-count
Number of CP Members to initialize the CP Subsystem. The CP subsystem is enabled when a positive value is set. After the CP subsystem is initialized successfully, more CP members can be added at run-time and number of active CP members can go beyond the configured CP member count. Number of CP members can be smaller than total size of the Hazelcast cluster. For instance, you can run 5 CP members in a 20-member Hazelcast cluster. If set, must be greater than or equal to "group-size".
{"default": 0, "anyOf": [{"const": 0}, {"type": "integer", "minimum": 3}]}
hazelcast-config-5.3.json
group-size
Number of CP members to run CP groups. If set, it must be an odd number between 3 and 7. Otherwise, "cp-member-count" is respected. If set, must be smaller than or equal to "cp-member-count".
{"anyOf": [{"const": 0}, {"type": "integer", "minimum": 3, "maximum": 7, "not": {"multipleOf": 2}}]}
hazelcast-config-5.3.json
session-time-to-live-seconds
Duration for a CP session to be kept alive after the last received heartbeat. The session will be closed if there is no new heartbeat this duration. Session TTL must be decided wisely. If a very low value is set, CP session of a Hazelcast instance can be closed prematurely if the instance temporarily loses connectivity to the CP subsystem because of a network partition or a GC pause. In such an occasion, all CP resources of this Hazelcast instance, such as FencedLock or ISemaphore, are released. On the other hand, if a very large value is set, CP resources can remain assigned to an actually crashed Hazelcast instance for too long and liveliness problems can occur. The CP subsystem offers an API, CPSessionManagementService, to deal with liveliness issues related to CP sessions. In order to prevent premature session expires, session TTL configuration can be set a relatively large value and CPSessionManagementService#forceCloseSession() can be manually called to close CP session of a crashed Hazelcast instance. Must be greater than "session-heartbeat-interval-seconds", and smaller than or equal to "missing-cp-member-auto-removal-seconds".
{"type": "integer", "minimum": 1, "default": 300}
hazelcast-config-5.3.json
session-heartbeat-interval-seconds
Interval for the periodically-committed CP session heartbeats. A CP session is started on a CP group with the first session-based request of a Hazelcast instance. After that moment, heartbeats are periodically committed to the CP group. Must be smaller than "session-time-to-live-seconds".
{"type": "integer", "minimum": 1, "default": 5}
hazelcast-config-5.3.json
missing-cp-member-auto-removal-seconds
Duration to wait before automatically removing a missing CP member from the CP subsystem. When a CP member leaves the cluster, it is not automatically removed from the CP subsystem, since it could be still alive and left the cluster because of a network partition. On the other hand, if a missing CP member is actually crashed, it creates a danger for its CP groups, because it will be still part of majority calculations. This situation could lead to losing majority of CP groups if multiple CP members leave the cluster over time. With the default configuration, missing CP members will be automatically removed from the CP subsystem after 4 hours. This feature is very useful in terms of fault tolerance when CP member count is also configured to be larger than group size. In this case, a missing CP member will be safely replaced in its CP groups with other available CP members in the CP subsystem. This configuration also implies that no network partition is expected to be longer than the configured duration. Must be greater than or equal to "session-time-to-live-seconds". If a missing CP member comes back alive after it is automatically removed from the CP subsystem with this feature, that CP member must be terminated manually. The default is 4 hours.
{"type": "integer", "minimum": 0, "default": 14400}
hazelcast-config-5.3.json
fail-on-indeterminate-operation-state
Offers a choice between at-least-once and at-most-once execution of the operations on top of the Raft consensus algorithm. It is disabled by default and offers at-least-once execution guarantee. If enabled, it switches to at-most-once execution guarantee. When you invoke an API method on a CP data structure proxy, it replicates an internal operation to the corresponding CP group. After this operation is committed to majority of this CP group by the Raft leader node, it sends a response for the public API call. If a failure causes loss of the response, then the calling side cannot determine if the operation is committed on the CP group or not. In this case, if this configuration is disabled, the operation is replicated again to the CP group, and hence could be committed multiple times. If it is enabled, the public API call fails with com.hazelcast.core.IndeterminateOperationStateException
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
persistence-enabled
Flag to denote whether or not CP Subsystem Persistence is enabled. If enabled, CP members persist their local CP data to stable storage and can recover from crashes.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
base-dir
Base directory to store all CP data when persistence-enabled is true. This directory can be shared between multiple CP members. Each CP member creates a unique directory for itself under the base directory. This is especially useful for cloud environments where CP members generally use a shared filesystem.
{"type": "string", "default": "cp-data"}
hazelcast-config-5.3.json
data-load-timeout-seconds
Timeout duration for CP members to restore their data from disk. CP member fails its startup if it cannot complete its CP data restore rocess in the configured duration.
{"type": "integer", "minimum": 1, "default": 120}
hazelcast-config-5.3.json
cp-member-priority
The CP member priority. The CP groups' leadership will be eventually transferred to members with higher priorities within the CP group.
{"type": "integer", "default": 0}
hazelcast-config-5.3.json
leader-election-timeout-in-millis
Leader election timeout in milliseconds. If a candidate cannot win majority of the votes in time, a new election round is initiated.
{"type": "integer", "default": 2000, "minimum": 1}
hazelcast-config-5.3.json
leader-heartbeat-period-in-millis
Period in milliseconds for a leader to send heartbeat messages to its followers.
{"type": "integer", "default": 5000, "minimum": 1}
hazelcast-config-5.3.json
max-missed-leader-heartbeat-count
Maximum number of missed leader heartbeats to trigger a new leader election.
{"type": "integer", "default": 5, "minimum": 1}
hazelcast-config-5.3.json
append-request-max-entry-count
Maximum number of entries that can be sent in a single batch of append entries request.
{"type": "integer", "default": 100, "minimum": 1}
hazelcast-config-5.3.json
commit-index-advance-count-to-snapshot
Number of new commits to initiate a new snapshot after the last snapshot.
{"type": "integer", "default": 10000, "minimum": 1}
hazelcast-config-5.3.json
uncommitted-entry-count-to-reject-new-appends
Maximum number of uncommitted entries in the leader's Raft log before temporarily rejecting new requests of callers.
{"type": "integer", "default": 100, "minimum": 1}
hazelcast-config-5.3.json
append-request-backoff-timeout-in-millis
Timeout in milliseconds for append request backoff. After the leader sends an append request to a follower, it will not send a subsequent append request until the follower responds to the former request or this timeout occurs.
{"type": "integer", "minimum": 1, "default": 100}
hazelcast-config-5.3.json
semaphores
Configurations for CP Semaphore instances. The CP Semaphores can be configured with mappings under keys as their names.
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"jdk-compatible": {"type": "boolean", "default": false}, "initial-permits": {"type": "integer", "minimum": 0, "default": 0}}}}
hazelcast-config-5.3.json
jdk-compatible
Enables / disables JDK compatibility of the CP ISemaphore. When it is JDK compatible, just as in the Semaphore#release() method, a permit can be released without acquiring it first, because acquired permits are not bound to threads. However, there is no auto-cleanup of acquired permits upon Hazelcast server / client failures. If a permit holder fails, its permits must be released manually. When JDK compatibility is disabled, a HazelcastInstance must acquire permits before releasing them and it cannot release a permit that it has mot acquired. It means, you can acquire a permit from one thread and release it from another thread using the same HazelcastInstance, but not different HazelcastInstances. In this mode, acquired permits are automatically released upon failure of the holder HazelcastInstance. So there is a minor behavioral difference to the Semaphore#release() method.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
initial-permits
Number of permits to initialize the Semaphore. If a positive value is set, the Semaphore is initialized with the given number of permits.
{"type": "integer", "minimum": 0, "default": 0}
hazelcast-config-5.3.json
locks
Configurations for FencedLock instances. The FencedLocks can be configured with mappings under keys as their names.
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"lock-acquire-limit": {"type": "integer", "default": 0, "minimum": 0}}}}
hazelcast-config-5.3.json
lock-acquire-limit
Maximum number of reentrant lock acquires. Once a caller acquires the lock this many times, it will not be able to acquire the lock again, until it makes at least one unlock() call. By default, no upper bound is set for the number of reentrant lock acquires, which means that once a caller acquires a FencedLock, all of its further lock() calls will succeed. However, for instance, if you set lock-acquire-limit to 2, once a caller acquires the lock, it will be able to acquire it once more, but its third lock() call will not succeed. If lock-acquire-limit is set to 1, then the lock becomes non-reentrant.
{"type": "integer", "default": 0, "minimum": 0}
hazelcast-config-5.3.json
BackupCount
Number of synchronous backups. For example, if 1 is set as the backup count, then all entries of the map will be copied to another JVM for fail-safety. 0 means no sync backup. The sum of backup-count and async-backup-count can't be larger than than 6.
{"type": "integer", "minimum": 0, "default": 1, "maximum": 6}
hazelcast-config-5.3.json
AsyncBackupCount
The number of asynchronous backups. 0 means no backups. The sum of backup-count and async-backup-count can't be larger than than 6.
{"type": "integer", "minimum": 0, "default": 0, "maximum": 6}
hazelcast-config-5.3.json
List
Name-value pairs of list configurations
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"statistics-enabled": {"type": "boolean", "default": true}, "max-size": {"type": "integer", "default": 0}, "backup-count": {}, "async-backup-count": {}, "item-listeners": {"type": "array", "items": {}}, "split-brain-protection-ref": {"type": "string"}, "merge-policy": {}}}}
hazelcast-config-5.3.json
statistics-enabled
When you enable it, you can retrieve list statistics.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
max-size
Maximum size of the list (item count). 0 means Integer.MAX_VALUE.
{"type": "integer", "default": 0}
hazelcast-config-5.3.json
split-brain-protection-ref
Adds the Split Brain Protection for this data-structure. You should set this value as a "split-brain-protection"'s name.
{"type": "string"}
hazelcast-config-5.3.json
enabled
Set to true to enable Hazelcast's security features.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
realms
Defines set of named security realms. Security realms are named security configurations which can be referenced from Hazelcast security configuration. Currently, the realms support configuring "authentication", and/or "identity". Only one type of authentication configuration and one type of identity configuration is allowed per the realm.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "authentication": {"type": "object", "propertyNames": {"enum": ["jaas", "tls", "ldap", "kerberos", "simple"]}, "maxProperties": 1, "minProperties": 1, "properties": {"jaas": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"class-name": {"type": "string"}, "usage": {"enum": ["REQUIRED", "REQUISITE", "SUFFICIENT", "OPTIONAL"], "default": "REQUIRED"}, "properties": {"type": "object"}}, "required": ["class-name"]}}, "tls": {"type": "object", "additionalProperties": false, "properties": {"roleAttribute": {"type": "string"}}}, "ldap": {"type": "object", "additionalProperties": false, "properties": {"url": {"type": "string"}, "socket-factory-class-name": {"type": "string"}, "parse-dn": {"type": "boolean"}, "role-context": {"type": "string"}, "role-filter": {"type": "string"}, "role-mapping-attribute": {"type": "string"}, "role-mapping-mode": {"enum": ["attribute", "reverse", "direct"], "default": "reverse"}, "role-name-attribute": {"type": "string"}, "role-recursion-max-depth": {"type": "integer", "minimum": 0}, "role-search-scope": {}, "user-name-attribute": {"type": "string"}, "system-user-dn": {"type": "string"}, "system-user-password": {"type": "string"}, "password-attribute": {"type": "string"}, "user-context": {"type": "string"}, "user-filter": {"type": "string"}, "user-search-scope": {}, "system-authentication": {"type": "string"}, "security-realm": {"type": "string"}}}, "simple": {"type": "object", "additionalProperties": true, "properties": {"role-separator": {"type": "string"}, "users": {"type": "array", "items": {"additionalProperties": false, "properties": {"username": {"type": "string"}, "password": {"type": "string"}, "roles": {"type": "array", "items": {"type": "string"}}}, "required": ["username", "password"]}}}}}}, "identity": {"type": "object", "propertyNames": {"enum": ["username-password", "kerberos", "token", "credentials-factory"]}, "minProperties": 1, "maxProperties": 1, "properties": {"username-password": {}, "token": {}, "credentials-factory": {}}}}}}
hazelcast-config-5.3.json
jaas
Defines JAAS authentication - i.e. list of login-module descriptions and optional "properties"
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"class-name": {"type": "string"}, "usage": {"enum": ["REQUIRED", "REQUISITE", "SUFFICIENT", "OPTIONAL"], "default": "REQUIRED"}, "properties": {"type": "object"}}, "required": ["class-name"]}}
hazelcast-config-5.3.json
tls
TLS defines X.509 based authentication (for cases when SSL mutual authentication is configured in Hazelcast network configuration)
{"type": "object", "additionalProperties": false, "properties": {"roleAttribute": {"type": "string"}}}
hazelcast-config-5.3.json
member-authentication
Maps member authentication to a realm name.
{"type": "object", "additionalProperties": false, "properties": {"realm": {"type": "string"}}, "required": ["realm"]}
hazelcast-config-5.3.json
client-authentication
Maps client authentication to a realm name.
{"type": "object", "additionalProperties": false, "properties": {"realm": {"type": "string"}}, "required": ["realm"]}
hazelcast-config-5.3.json
client-permission-policy
Specifies the name and properties of your class that you developed by implementing Hazelcast's IPermissionPolicy interface, which is the default permission policy (com.hazelcast.security.IPermissionPolicy). This policy defines the client authorization specifications.
{}
hazelcast-config-5.3.json
security-interceptors
Specifies the security interceptor class that you developed by implementing Hazelcast's SecurityInterceptor interface to intercept every remote operation executed by a client.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
client-block-unmapped-actions
Specifies whether to block (true) or allow (false) actions, submitted as tasks in an Executor from the clients and have no permission mappings.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
client-permissions
Lists the client permissions that can be accessed by the client permission policy. For each permission, you need to provide the end points and actions to be permitted. Also, the name and principal for each permission should be given using the "name" and "principal" attributes. Please see http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#permissions for all permissions and actions.
{"type": "object", "propertyNames": {"enum": ["on-join-operation", "all", "config", "transaction", "map", "queue", "topic", "multimap", "list", "set", "flake-id-generator", "lock", "atomic-long", "countdown-latch", "semaphore", "executor-service", "durable-executor-service", "cardinality-estimator", "scheduled-executor", "cache", "user-code-deployment", "pn-counter", "atomic-reference", "ring-buffer", "reliable-topic", "replicatedmap", "management", "job", "connector", "sql"]}, "properties": {"on-join-operation": {"enum": ["RECEIVE", "SEND", "NONE"]}, "all": {}, "config": {}, "transaction": {}}, "additionalProperties": {"type": "array", "items": {}}}
hazelcast-config-5.3.json
unit
Unit can be bytes, kilobytes, megabytes and gigabytes. Default unit is MEGABYTES.
{"enum": ["BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES"], "default": "MEGABYTES"}
hazelcast-config-5.3.json
value
Default value is 128.
{"type": "number", "default": 128, "minimum": 1}
hazelcast-config-5.3.json
NativeMemory
This feature is available only in Hazelcast Enterprise HD.
{"properties": {"enabled": {"type": "boolean", "default": false}, "allocator-type": {"enum": ["STANDARD", "POOLED"], "default": "POOLED"}, "size": {}, "capacity": {}, "min-block-size": {"type": "integer", "default": 16, "minimum": 1, "enum": [1, 2, 4, 6, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536]}, "page-size": {"type": "integer", "default": 4194304, "minimum": 1}, "metadata-space-percentage": {"type": "number", "default": 12.5, "minimum": 1}, "persistent-memory-directory": {"type": "string"}}}
hazelcast-config-5.3.json
enabled
Set as true to enable the High-Density Memory Store usage.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
allocator-type
Type of the memory allocator. The default value is POOLED. Available values are as follows: \n- STANDARD: Allocates/frees the memory using default OS memory manager, \n- POOLED: Manages memory blocks in thread local pools
{"enum": ["STANDARD", "POOLED"], "default": "POOLED"}
hazelcast-config-5.3.json
size
Deprecated, use 'capacity' instead.
{}
hazelcast-config-5.3.json
min-block-size
Minimum size of the blocks in bytes to split and fragment a page block to assign to an allocation request.\n It is used only by the POOLED memory allocator. The value has to be power of two. Default value is 16.
{"type": "integer", "default": 16, "minimum": 1, "enum": [1, 2, 4, 6, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536]}
hazelcast-config-5.3.json
page-size
Size of the page in bytes to allocate memory as a block. \n It is used only by the POOLED memory allocator. Its default value is 1 << 22 (about 4 MB)
{"type": "integer", "default": 4194304, "minimum": 1}
hazelcast-config-5.3.json
metadata-space-percentage
Percentage of the allocated native memory that is used for the metadata such as indexes, offsets, etc. \n It is used only by the POOLED memory allocator. Its default value is 12.5.
{"type": "number", "default": 12.5, "minimum": 1}
hazelcast-config-5.3.json
persistent-memory-directory
Specifies the directory where the non-volatile memory (e.g. Intel Optane) is mounted. \n If this element is not defined, the RAM is used as a native memory. \n This directory will be created automatically if it does not exist.\n To avoid collisions, every member of the cluster will create its own subfolder to work with the non-volatile memory.
{"type": "string"}
hazelcast-config-5.3.json
CrdtReplication
Configures the replication mechanism for all CRDT implementations.\n The CRDT states are replicated in rounds (the period is configurable) and \n in each round the state is replicated up to the configured number of members
{"type": "object", "additionalProperties": false, "properties": {"max-concurrent-replication-targets": {"type": "integer", "minimum": 1, "default": 1}, "replication-period-millis": {"type": "integer", "minimum": 1, "default": 1000}}}
hazelcast-config-5.3.json
max-concurrent-replication-targets
The maximum number of target members that we replicate the CRDT states to in one period. \n A higher count will lead to states being disseminated more rapidly at the expense of burst-like behaviour - \n one update to a CRDT will lead to a sudden burst in the number of replication messages in a short time interval.
{"type": "integer", "minimum": 1, "default": 1}
hazelcast-config-5.3.json
replication-period-millis
The period between two replications of CRDT states in milliseconds. \n A lower value will increase the speed at which changes are disseminated to other cluster members at the expense of burst-like behaviour - \n less updates will be batched together in one replication message and \n one update to a CRDT may cause a sudden burst of replication messages in a short time interval. \n The value must be a positive non-null integer.
{"type": "integer", "minimum": 1, "default": 1000}
hazelcast-config-5.3.json
replica-count
Number of replicas on which the CRDT state will be kept.
{"type": "integer", "minimum": 1, "maximum": 2147483647, "default": 2147483647}
hazelcast-config-5.3.json
split-brain-protection-ref
Adds the Split Brain Protection for this data-structure which you configure using the "split-brain-protection" element.
{"type": "string"}
hazelcast-config-5.3.json
statistics-enabled
When you enable it, you can retrieve the PN counter statistics.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
Listeners
Configuration used to register the listeners that you created by implementing Hazelcast's MembershipListener, DistributedObjectListener, MigrationListener and PartitionLostListener interfaces.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
MemberAttributes
You can define member attributes for your Hazelcast members to tag your members according to your business logic requirements. Configuration element's name is "member-attributes". You can list each member attribute by their name. For each attribute, you need to provide its type and value.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"type": {"type": "string"}, "value": true}, "required": ["value"]}}
hazelcast-config-5.3.json
portable-version
Version of the portable serialization. Portable version is used to differentiate two of the same classes that have changes such as a new field or a new field type.
{"type": "integer"}
hazelcast-config-5.3.json
use-native-byte-order
Set as true if you want to use the native byte order of the underlying platform.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
byte-order
Specifies the byte order that the serialization will use.
{"enum": ["BIG_ENDIAN", "LITTLE_ENDIAN"], "default": "BIG_ENDIAN"}
hazelcast-config-5.3.json
enable-compression
Set as true to enable compression when default Java serialization is used. Its default value is false.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
enable-shared-object
Set as true to enable shared object when default Java serialization is used.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
allow-unsafe
Set as true to allow the usage of unsafe.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
data-serializable-factories
Lists your class implementations of Hazelcast's DataSerializableFactory. Each factory has the required
{"type": "array", "items": {}}
hazelcast-config-5.3.json
portable-factories
Lists your class implementations of Hazelcast's PortableFactory. Each factory has the required "factory-id" attribute that you should give as the ID of your factory.
{"type": "array", "items": {}}
hazelcast-config-5.3.json
global-serializer
Global serializer should be defined with "global-serializer" element. It has an optional boolean "override-java-serialization" attribute. If you set it as true, the Java serialization step will be handled by the global serializer, not by the Java Serializable or Externalizable
{"type": "object", "additionalProperties": false, "properties": {"class-name": {"type": "string"}, "override-java-serialization": {"type": "boolean", "default": false}}, "required": ["class-name"]}
hazelcast-config-5.3.json
override-java-serialization
If you set it as true, the Java serialization step will be handled by the global serializer, not by the Java Serializable or Externalizable
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
serializers
Lists the serializers (classes) that you implement using Hazelcast's StreamSerializer, ByteArraySerializer etc.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"type-class": {"type": "string"}, "class-name": {"type": "string"}}, "required": ["type-class", "class-name"]}}
hazelcast-config-5.3.json
type-class
The type of the class that will be serialized via this implementation.
{"type": "string"}
hazelcast-config-5.3.json
class-name
The class name of the serializer implementation.
{"type": "string"}
hazelcast-config-5.3.json
check-class-def-errors
If set to true, serialization system will check the class definitions error at the start of serialization process and throw a Serialization Exception with the error definition.s
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
java-serialization-filter
Allows to configure blacklisting and whitelisting for deserialized classes when Java serialization is used.
{"type": "object", "additionalProperties": false, "properties": {"defaults-disabled": {"type": "boolean", "default": false}, "whitelist": {}, "blacklist": {}}}
hazelcast-config-5.3.json
compact-serialization
Contains configuration elements and attributes for the compact serialization.
{"type": "object", "additionalProperties": false, "properties": {"serializers": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"serializer": {"type": "string"}}}}, "classes": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"class": {"type": "string"}}}}}}
hazelcast-config-5.3.json
serializers
Contains the Compact serializers to be registered.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"serializer": {"type": "string"}}}}
hazelcast-config-5.3.json
serializer
Fully qualified class name of the Compact serializer.
{"type": "string"}
hazelcast-config-5.3.json
classes
Contains the classes to be serialized with Compact serialization, which will override any other serialization mechanisms.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"class": {"type": "string"}}}}
hazelcast-config-5.3.json
class
Fully qualified name of the class.
{"type": "string"}
hazelcast-config-5.3.json
enabled
Specifies whether this split brain protection is enabled.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
minimum-cluster-size
The minimum number of members required in a cluster for the cluster to remain in an operational state. If the number of members is below the defined minimum at any time, the operations are rejected and the rejected operations return a SplitBrainProtectionException to their callers.
{"type": "integer", "minimum": 2}
hazelcast-config-5.3.json
protect-on
Specifies for which operations the split brain protection will be applied. Available values are READ, WRITE and READ_WRITE.
{"enum": ["READ", "WRITE", "READ_WRITE"], "default": "READ_WRITE"}
hazelcast-config-5.3.json
function-class-name
Name of the class that you develop by implementing Hazelcast's SplitBrainProtectionFunction interface to conclude the absence/presence of your split brain protection. This function is triggered when any change happens to the member list.
{"type": "string"}
hazelcast-config-5.3.json
listeners
Provides the list of split brain protection listeners that you can register to be notified about split brain protection results. Split brain protection listeners are local to the member that they are registered, so they receive only events occurred on that local member.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
heartbeat-tolerance-millis
Overrides the hazelcast.max.no.heartbeat.seconds system property.
{"type": "integer"}
hazelcast-config-5.3.json
acceptable-heartbeat-pause-millis
Default duration in milliseconds corresponding to number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly. Overrides the hazelcast.max.no.heartbeat.seconds system property.
{"type": "integer"}
hazelcast-config-5.3.json
suspicion-threshold
Threshold for suspicion (��) level. A low threshold is prone to generate many wrong suspicions but ensures a quick detection in the event of a real crash. Conversely, a high threshold generates fewer mistakes but needs more time to detect actual crashes. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.threshold system property.
{"type": "number"}
hazelcast-config-5.3.json
max-sample-size
Number of samples to use for calculations. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.sample.size system property.
{"type": "integer"}