description: Refresh interval for fetching from remote JWKS providers in seconds.


key: remote

description: Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval.

type: array

type: object

type: string

default: DEFAULT

type: boolean

default: false


key: issuer

description: Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss').


key: name

description: Name by which provider is referenced. Must be unique.


description: URL of JWKS service provider.


description: The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'.


List of certificates of the CA chain for the certificate.


The CA chain file path.


key: certificate

description: The certificate in PEM format.


The certificate file path.


key: privatekey

description: The private key for the certificate in PEM format.


The private key file path


description: Force new session for each request.


key: protocol

description: The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'.


The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format.


The file containing the validation CA certificates.


description: Verification which involves a server identity check to mitigate man in the middle attacks.


key: license

description: The encoded license.


The license file path.


key: level

description: Allowed values are: info, trace

enum: info trace

default: info


key: metrics

description: Configuration for metrics sending.

default: true


key: statsd

description: Use this to enable sending metrics using the statsd protocol.


key: enabled

description: Enable sending of statsd metrics. Default is 'true'


key: header

description:
If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.
Common values are 'X-Forwarded-For' or 'X-Client-IP'.
Warning: Make sure that internal_proxies is correctly configured for your setup.


description: List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header.


Specifies the passphrase for the passphrase based encryption mechanism (PBE).


The path of the passphrase file.


description: Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only.

type: integer


key: lifetime

description: Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated.


description: Name of the hosts running the Redis Server.


description:
Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:
- server mode if only one host is configured
- cluster mode if several hosts are configured

Allowed values are: server, cluster and disabled.

enum: server cluster disabled


description: Configuration file for StyleCop Analyzers

default: kind accessibility constant static readonly

enum: accessibility kind constant static readonly

default: insideNamespace

enum: allow require omit

default: allow

enum: camelCase PascalCase

default: PascalCase

enum: class interface struct delegate enum

default: PlaceholderCompany

default: Copyright (c) {companyName}. All rights reserved.

default: stylecop

enum: stylecop metadata

default: en-US


key: settings

description: The top-level object containing configuration properties for built-in rules.


key: indentation

description: Indentation configuration


key: indentationSize

description: Specifies the indentation size.


key: tabSize

description: Specifies the tab width.


key: useTabs

description: Specifies whether indentation should use hard tabs instead of spaces.


key: spacingRules

description: Configuration for spacing rules (SA1000-)


key: readabilityRules

description: Configuration for readability rules (SA1100-)


key: allowBuiltInTypeAliases

description: When true, diagnostics will not be reported for using aliases of built-in types.


key: orderingRules

description: Configuration for ordering rules (SA1200-)


key: elementOrder

description: Specifies the traits used for ordering elements within a document, along with their precedence.


key: items


key: systemUsingDirectivesFirst

description: When true, System using directives should be placed before other using directives.


key: usingDirectivesPlacement

description:
Specifies the desired placement of using directives.
insideNamespace: Place using directives inside the namespace definition
outsideNamespace: Place using directives outside the namespace definition
preserve: Allow using directives inside or outside the namespace definition


key: blankLinesBetweenUsingGroups

description:
Specifies if using groups should be separated by a blank line.
allow: A blank line is allowed, but not required
require: A blank line is required
omit: A blank line is not allowed


key: namingRules

description: Configuration for naming rules (SA1300-)


key: allowCommonHungarianPrefixes

description: Determines whether common Hungarian notation prefixes should be allowed.


key: allowedHungarianPrefixes

description: Allowed Hungarian notation prefixes.


key: allowedNamespaceComponents

description: Allowed namespace components, such as ones beginning with a lowercase letter.


key: includeInferredTupleElementNames

description: Specifies whether inferred tuple element names will be analyzed as well.


key: tupleElementNameCasing

description: Specifies the casing convention used for tuple element names.


key: maintainabilityRules

description: Configuration for ordering rules (SA1400-)


key: topLevelTypes

description: The set of type kinds which should be placed in separate files according to the type name.


key: layoutRules

description: Configuration for layout rules (SA1500-)


key: newlineAtEndOfFile

description:
Specifies the handling for newline characters which appear at the end of a file
allow: Files are allowed to end with a single newline character, but it is not required
require: Files are required to end with a single newline character
omit: Files may not end with a newline character


key: allowConsecutiveUsings

description: Specifies if SA1519 will allow consecutive using statements without braces


key: allowDoWhileOnClosingBrace

description: Specifies if SA1500 will allow the 'while' expression of a 'do'/'while' loop to be on the same line as the closing brace.


key: documentationRules

description: Configuration for documentation rules (SA1600-)


key: documentExposedElements

description: Specifies whether exposed elements need to be documented. When true, all publicly-exposed types and members require documentation.


key: documentInternalElements

description: Specifies whether internal elements need to be documented. When true, all internally-exposed types and members require documentation.


key: documentPrivateElements

description: Specifies whether private elements need to be documented. When true, all types and members except for declared private fields require documentation.


key: documentInterfaces

description: Specifies whether interface members need to be documented. When true, all interface members require documentation, regardless of accessibility.


key: documentPrivateFields

description: Specifies whether private fields need to be documented. When true, all fields require documentation, regardless of accessibility.


key: companyName

description: The name of the company which appears in file headers.


key: copyrightText

description: The copyright text which should appear in file headers.


key: variables

description: Replacement variables which may be used in the 'copyrightText' value.


key: xmlHeader

description: Determines whether the file header should be wrapped in the StyleCop-standard XML structure.


key: headerDecoration

description: The text used as decoration for the copyright header comment.


key: fileNamingConvention

description: Specifies the preferred naming convention for files. The default value "stylecop" uses the naming convention defined by StyleCop Classic, while "metadata" uses a file naming convention that matches the metadata names of types.


key: documentationCulture

description: The culture that should be used for documentation comments.


key: excludeFromPunctuationCheck

description: Specifies the top-level tags within XML documentation that will be excluded from punctuation analysis.


key: properties

description: The "properties" mapping lets you add properties to some of the Hazelcast elements used to configure some of the Hazelcast modules. You can define the name and value of these properties. You can use "properties" for the following Hazelcast configuration elements: \n * discovery-strategy \n * map-store \n * queue-store \n * wan-replication \n * ssl \n * service \n * login-module \n * security-object \n * socket-interceptor


key: cluster-name

description: Specifies the cluster name. It's sent as part of the client authentication message to Hazelcast member(s).


key: client-labels

description: The 'client-labels' sequence lets you define labels in your Java client, similar to the way it can be done for the members. Through the client labels, you can assign special roles for your clients and use these roles to perform some actions specific to those client connections. You can also group your clients using the client labels. These client groups can be blacklisted in the Hazelcast Management Center so that they can be prevented from connecting to a cluster. See the related section in the Hazelcast Management Center Reference Manual for more information on this topic.


key: backup-ack-to-client-enabled

description: The 'backup-ack-to-client-enabled' element lets you enable/disable backups ack to client. This feature reduces number of hops and increase performance for smart clients. It is enabled by default for smart clients. This config has no effect for unisocket clients.


key: hazelcast-client-failover

description: The Hazelcast client can configurations that the client is using to connect to a Hazelcast cluster in the case of a disconnect is listed under the "clients" array. You can list client configurations as many as you want.


key: scripting-enabled

description: Set to true to allow scripting on the member, false to disallow.


key: console-enabled

description: Set to true to allow console commands execution on the member, false to disallow.


key: data-access-enabled

description: Set to true to allow Management Center access to contents of Hazelcast data structures (for instance map entries), false to disallow. Management Center can't access the data if at least one member has the data access disabled.


key: NetworkJoin

description: This configuration lets you choose a discovery mechanism that Hazelcast will use to form a cluster. Hazelcast can find members by multicast, TCP/IP lists and by various discovery mechanisms provided by different cloud APIs.


key: multicast

description: Set its "enabled" attribute to true for discovery by multicast. It has another attribute ("loopback-mode-enabled") which enables or disables the loopback mode in the multicast discovery mechanism.


key: enabled

description: Specifies whether multicast discovery is enabled.


key: loopback-mode-enabled

description: Specifies if the loopback mode is enabled for multicast discovery.


key: loopbackModeEnabled

description: Alias for loopback-mode-enabled


key: multicast-group

description: Specifies the multicast group IP address when you want to create clusters within the same network.


key: multicast-port

description: Specifies the multicast socket port that the Hazelcast member listens to and sends discovery messages through.


key: multicast-time-to-live

description: Time-to-live value for multicast packets sent out to control the scope of multicasts.


key: multicast-timeout-seconds

description: Only when the members are starting up, this timeout (in seconds) specifies the period during which a member waits for a multicast response from another node. For example, if you set it as 60 seconds, each node will wait for 60 seconds until a leader node is selected.


key: trusted-interfaces

description: Includes IP addresses of trusted members. When a node wants to join to the cluster, its join request will be rejected if it is not a trusted member. You can give an IP addresses range using the wildcard (*) on the last digit of IP address (e.g. 192.168.1.* or 192.168.1.100-110).


description: Specifies whether the TCP/IP discovery is enabled or not.


key: connection-timeout-seconds

description: The maximum amount of time Hazelcast is going to try to connect to a well known member before giving up. Setting it to a too low value could mean that a member is not able to connect to a cluster. Setting it to a too high value means that member startup could slow down because of longer timeouts (e.g. when a well known member is not up). Increasing this value is recommended if you have many IPs listed and the members cannot properly build up the cluster.


key: required-member

description: IP address of the required member. Cluster will only be formed if the member with this IP address is found.


key: member

description: IP address(es) of one or more well known members. Once members are connected to these well known ones, all member addresses will be communicated with each other. You can also give comma separated IP addresses using the "members" element or list the members with the "member" element under "member-list".


key: members

description: Comma separated IP addresses of one or more well known members.


key: member-list

description: Sequence of IP address(es) of one or more well known members.


key: interface

description: IP address(es) of one or more well known members.


key: MemberAddressProvider

description: IMPORTANT\nThis configuration is not intended to provide addresses of other cluster members with which the Hazelcast instance will form a cluster. This is an SPI for advanced use in cases where the DefaultAddressPicker does not pick suitable addresses to bind to and publish to other cluster members. For instance, this could allow easier deployment in some cases when running on Docker, AWS or other cloud environments. That said, if you are just starting with Hazelcast, you will probably want to set the member addresses by using the tcp-ip or multicast configuration or adding a discovery strategy. Member address provider allows to plug in own strategy to customize:\n1. What address Hazelcast will bind to\n2. What address Hazelcast will advertise to other members on which they can bind to\nIn most environments you don't need to customize this and the default strategy will work just fine. However in some cloud environments the default strategy does not make the right choice and the member address provider delegates the process of address picking to external code.


description: Specifies whether the member address provider SPI is enabled or not.


key: class-name

description: The name of the class implementing the com.hazelcast.spi.MemberAddressProvider interface.


key: properties

description: The properties that will be provided when constructing the provided MemberAddressProvider. Hazelcast will first try instantiating the provided class by invoking a constructor accepting a single java.util.Properties instance. In the case where there is no such constructor and there are also no properties defined by this configuration, Hazelcast will exceptionally try to use the no-arg constructor.


key: Interfaces

description: You can define multiple interfaces. By default, it is disabled.


key: enabled

description: You need to set it to true to be able to use your defined interfaces.


key: FailureDetector

description: A failure detector is responsible to determine if a member in the cluster is unreachable or crashed. Please refer to https://docs.hazelcast.org/docs/latest/manual/html-single/index.html#failure-detector-configuration for the failure detectors implemented by Hazelcast.


key: icmp

description: ICMP can be used in addition to the other detectors. It operates at layer 3 and detects network and hardware issues more quickly.


key: timeout-milliseconds

description: Timeout in milliseconds before declaring a failed ping.


key: fail-fast-on-startup

description: Cluster Member will fail to start if it is unable to action an ICMP ping command when ICMP is enabled. Failure is usually due to OS level restrictions.


key: interval-milliseconds

description: Time in milliseconds between each ICMP ping.


key: max-attempts

description: Maximum number of consecutive failed attempts before declaring a member suspect.


key: parallel-mode

description: Run ICMP detection in parallel with the Heartbeat failure detector.


key: ttl

description: Maximum number of times the IP Datagram (ping) can be forwarded, in most cases all Hazelcast cluster members would be within one network switch/router therefore default of 0 is usually sufficient.


key: AwsDiscovery

description: Please refer to https://github.com/hazelcast/hazelcast-aws/#configuration for the configuration details.


description: Specifies whether AWS discovery is enabled or not.


key: GcpDiscovery

description: Please refer to https://github.com/hazelcast/hazelcast-gcp/#configuration for the configuration details.


description: Specifies whether Google Cloud Platform discovery is enabled or not.


key: AzureDiscovery

description: Please refer to https://github.com/hazelcast/hazelcast-azure/#configuring-at-hazelcast-side for the configuration details.


description: Specifies whether Microsoft Azure discovery is enabled or not.


key: KubernetesDiscovery


key: EurekaDiscovery

description: Please refer to https://github.com/hazelcast/hazelcast-eureka#hazelcast-configuration for the configuration details.


description: Specifies whether Eureka Service Registry discovery is enabled or not.


key: items

description: Set its "enabled" sub-element to true for discovery in various cloud infrastructures. You also need to set the value of "hazelcast.discovery.enabled" property to true. See the description of the "properties" element to learn how to do this. You can define multiple discovery strategies using the "discovery-strategy" sub-element and its properties. Please refer to http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#discovering-cluster-members to see the properties you can use.


key: public-address

description: Overrides the public address of a node. By default, a node selects its socket address as its public address. But behind a network address translation (NAT), two endpoints (nodes) may not be able to see/access each other. If both nodes set their public addresses to their defined addresses on NAT, then they can communicate with each other. In this case, their public addresses are not an address of a local network interface but a virtual address defined by NAT. This is optional to set and useful when you have a private cloud.


key: reuse-address

description: When you shutdown a cluster member, the server socket port will be in the TIME_WAIT state for the next couple of minutes. If you start the member right after shutting it down, you may not be able to bind it to the same port because it is in the TIME_WAIT state. If you set reuse-address to true, the TIME_WAIT state is ignored and you can bind the member to the same port again.


key: port

description: Specifies the ports that Hazelcast will use to communicate between cluster members.


key: port-count

description: By default, Hazelcast will try 100 ports to bind (i.e. the ports between 5701 and 5801). You can change the port count in such cases as having large instances on a single machine or you are willing to have only a few ports assigned.


key: auto-increment

description: By default, Hazelcast tries to find a port by automatically incrementing the port numbers. If you don't want this (for example, you want to use a specific port), set auto-increment to false. If it is set to false, the port-count attribute is ignored.


key: memcache-protocol

description: Allows to configure Memcache text protocol support in Hazelcast.


key: symmetric-encryption

description: Lets you encrypt the entire socket level communication among all Hazelcast members. This feature is available only in Hazelcast Enterprise.  Its configuration contains the encryption properties and the same configuration must be placed to all members. By default, it is disabled.


key: enabled

description: Indicates whether the advanced network configuration is enabled or not.


key: wan-server-socket-endpoint-config

description: Configures the server sockets used for the WAN replication's inbound WAN connections. Multiple WAN server sockets can be configured to allow configuring separate server sockets for each inbound WAN connection.


key: client-server-socket-endpoint-config

description: Configures the server socket used for the member-client communication.


key: member-server-socket-endpoint-config

description: Configures the server socket used for the member-member communication.


key: wan-endpoint-config

description: This element configures socket settings for the outgoing WAN connections.


key: rest-server-socket-endpoint-config

description: Controls access to Hazelcast HTTP REST API. The methods available through REST API are grouped to several REST endpoint groups, which can be specified in this section.

enum: endpoint-groups port public-address reuse-address name outbound-ports interfaces ssl socket-interceptor symmetric-encryption socket-options tpc-socket


key: split-brain-protection-ref

description: Adds the Split Brain Protection for this data-structure which you configure using the "split-brain-protection" element. You should set the "split-brain-protection-ref"'s value as the "split-brain-protection"'s name.


key: InMemoryFormat

description: Binary type that will be used for storing records. Possible values: BINARY (default): keys and values will be stored as binary data. OBJECT: values will be stored in their object forms. NATIVE: values will be stored in non-heap region of JVM (Hazelcast Enterprise only)

enum: BINARY OBJECT NATIVE

default: BINARY


key: unique-key-transformation

description: Defines an assortment of transformations which can be applied to unique-key values. OBJECT: Extracted unique key value is interpreted as an object value. Non-negative unique ID is assigned to every distinct object value. LONG: Extracted unique key value is interpreted as a whole integer value of byte, short, int or long type. The extracted value is upcasted to long (if necessary) and unique non-negative ID is assigned to every distinct value. RAW: Extracted unique key value is interpreted as a whole integer value of byte, short, int or long type. The extracted value is upcasted to long (if necessary) and the resulting value is used directly as an ID.

enum: OBJECT LONG RAW

default: OBJECT


key: page-size

description: Page size of the index B+ Tree. Default value is 16 kB.

unit: KILOBYTES


key: memory-tier

description: Memory tier.


key: capacity

description: Memory tier capacity, i.e., how much main memory should this tier consume at most. The default is 256 megabytes.


key: time-to-live-seconds

description: The maximum number of seconds for each entry to stay in the map.


key: read-backup-data

description: Sets if read-backup-data (reading local backup entries) is enabled for this map.


description: Sets whether hot restart is enabled on related data structure.


key: fsync

description: Sets whether disk write should be followed by an fsync() system call.


description: Sets whether persistence is enabled on related data structure.


description: 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. NOTE: 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 make sure that the configured capacity is at least greater than the partition count.


description: 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 exceeded.


key: initial-mode

description: LAZY: Default load mode where load is async; EAGER: load mode where load is blocked till all partitions are loaded.

enum: LAZY EAGER

default: LAZY


key: offload

description: Set true to offload map-store interacting code parts from partition threads, otherwise interaction is executed inside partition thread


key: write-delay-seconds

description: The number of seconds to delay before writing (storing) the dirty records.


key: write-batch-size

description: The number of operations to be included in each batch processing round.


key: write-coalescing

description: Setting writeCoalescing is meaningful if you are using write-behind MapStore. When writeCoalescing is true, only the latest store operation on a key in the writeDelaySeconds time-window will be reflected to MapStore.


key: class-name

description: The name for the MapStore implementation class


key: factory-class-name

description: The name for the MapStoreFactory implementation class


description: The maximum number of seconds for each entry to stay in the Near Cache (time to live). Entries that are older than timeToLiveSeconds will automatically be evicted from the Near Cache.


key: max-idle-seconds

description: The maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). Entries that are not read (touched) more than maxIdleSeconds value will get removed from the Near Cache. Accepts any integer between 0 and Integer#MAX_VALUE. The value 0 means Integer#MAX_VALUE. The default is 0.


key: invalidate-on-change

description: Sets if Near Cache entries are invalidated when the entries in the backing data structure are changed. When this setting is enabled, a Hazelcast instance with a Near Cache listens for cluster-wide changes on the entries of the backing data structure and invalidates its corresponding Near Cache entries. Changes done on the local Hazelcast instance always invalidate the Near Cache immediately.


key: cache-local-entries

description: Sets if local entries are also cached in the Near Cache. This is useful when the in-memory format of the Near Cache is different from the backing data structure. This setting has no meaning on Hazelcast clients, since they have no local entries.


key: local-update-policy

description: Defines how to reflect local updates to the Near Cache. Possible values:\n * INVALIDATE: Local put and local remove immediately invalidate Near Cache.\n * CACHE_ON_UPDATE: While local remove immediately invalidates Near Cache, local put adds new value to it.

default: INVALIDATE


key: republishing-enabled

description: Sets if incoming WAN events to this member should be republished (forwarded) to this WAN replication reference.


key: filters

description: Array of class names implementing the CacheWanEventFilter or MapWanEventFilter for filtering outbound WAN replication events. NOTE: EE only


key: additionalProperties

description: Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor.


key: extractor-class-name

description: Fully qualified class name of the extractor used to extract the value of the attribute.


key: entry-listeners

description: Adds listeners (listener classes) for the map entries using the "entry-listener" sub-elements


key: map-name

description: In client configurations it is used to identify the map to which this query cache belongs to.


key: include-value

description: Enables value caching.


key: predicate

description: Predicate to filter events which will be applied to the query cache.


key: populate

description: Flag to enable/disable initial population of the QueryCache.


key: serialize-keys

description: Defines if the Query Cache keys should be serialized or not. Keys are better to be serialized if they are mutable and need to be cloned via serialization. Default value is false.


key: delay-seconds

description: Minimum time in seconds that an event waits in the member's buffer.


key: batch-size

description: The batch size which will be used to determine number of events to be sent in a batch to QueryCache.


key: buffer-size

description: Maximum number of events which can be stored in a buffer of partition.


key: enabled

description: True if Tiered-Store is enabled, false otherwise.


key: memory-tier

description: Memory tier.


key: capacity

description: Memory tier capacity, i.e., how much main memory should this tier consume at most. The default is 256 megabytes.


key: disk-tier

description: Disk tier.

default: default-tiered-store-device


description: True to enable using disk as the second memory tier, false otherwise.


key: device-name

description: Name of the device for a given disk tier.


key: partition-attributes

description: List of key attributes to use for partitioning the data in the maps. Providing this list automatically sets the strategy to `com.hazelcast.partition.strategy.AttributePartitioningStrategy` regardless of the class name provided in the `partition-strategy` property.


description: True if you want the entry event to contain the item values.


key: local

description: True if you want to listen to the entries on the local member.


key: max-size

description: Maximum size of the set (item count). Its default value is 0, meaning Integer.MAX_VALUE.


key: statistics-enabled

description: True if statistics gathering is enabled on the set, false otherwise.


key: global-ordering-enabled

description: When it is set to true, all cluster members that listen to a topic will receive the messages in the same order they were published by all members. This way, Hazelcast guarantees that all members will see the in the same order. Its default value is false.


description: When you enable it, you can retrieve topic statistics such as total number of published and received messages. Its default value is true.


key: multi-threading-enabled

description: Enable multi-threaded message handling. When enabled any thread from events thread pool can be used for incoming message processing. Otherwise only one dedicated thread will be used to handle topic messages. Note: it can be enabled only in case when global ordering is disabled. Moreover, the local message ordering is not supported in this mode also. This means the messages produced by local publisher can be processed by several threads with no ordering guarantee.


description: Enables or disables statistics for this reliable topic. Collects the creation time, total number of published and received messages for each member locally.


key: topic-overload-policy

description: A policy to deal with an overloaded topic; so topic where there is no place to store new messages. This policy can only be used in combination with the com.hazelcast.core.HazelcastInstance#getReliableTopic(String). The reliable topic uses a com.hazelcast.ringbuffer.Ringbuffer to store the messages. A ringbuffer doesn't track where readers are, so it has no concept of a slow consumers. This provides many advantages like high performance reads, but it also gives the ability to the reader to re-read the same message multiple times in case of an error. A ringbuffer has a limited, fixed capacity. A fast producer may overwrite old messages that are still being read by a slow consumer. To prevent this, we may configure a time-to-live on the ringbuffer (see com.hazelcast.config.RingbufferConfig#setTimeToLiveSeconds(int). Once the time-to-live is configured, the TopicOverloadPolicy controls how the publisher is going to deal with the situation that a ringbuffer is full and the oldest item in the ringbuffer is not old enough to get overwritten. Keep in mind that this retention period (time-to-live) can keep messages from being overwritten, even though all readers might have already completed reading. Its default value is BLOCK. Available values are as follows: - DISCARD_OLDEST: Using this policy, a message that has not expired can be overwritten. No matter the retention period set, the overwrite will just overwrite the item. This can be a problem for slow consumers because they were promised a certain time window to process messages. But it will benefit producers and fast consumers since they are able to continue. This policy sacrifices the slow producer in favor of fast producers/consumers. - DISCARD_NEWEST: Message that was to be published is discarded. - BLOCK: The caller will wait until there is space in the Ringbuffer. - ERROR: The publish call fails immediately.

default: BLOCK


key: read-batch-size

description: Sets the read batch size. The ReliableTopic tries to read a batch of messages from the ringbuffer. It will get at least one, but if there are more available, then it will try to get more to increase throughput. The maximum read batch size can be influenced using the read batch size. Apart from influencing the number of messages to retrieve, the readBatchSize also determines how many messages will be processed by the thread running the MessageListener before it returns back to the pool to look for other MessageListeners that need to be processed. The problem with returning to the pool and looking for new work is that interacting with an executor is quite expensive due to contention on the work-queue. The more work that can be done without retuning to the pool, the smaller the overhead. If the readBatchSize is 10 and there are 50 messages available, 10 items are retrieved and processed consecutively before the thread goes back to the pool and helps out with the processing of other messages. If the readBatchSize is 10 and there are 2 items available, 2 items are retrieved and processed consecutively. If the readBatchSize is an issue because a thread will be busy too long with processing a single MessageListener and it can't help out other MessageListeners, increase the size of the threadpool so the other MessageListeners don't need to wait for a thread, but can be processed in parallel.


description: Number of items in the Ringbuffer. If no "time-to-live-seconds" is set, this value will always be equal to the capacity after the head completes the first loop around the ring. This is because no items are being expired.


key: time-to-live-seconds

description: Sets the time to live in seconds which is the maximum number of seconds for each item to stay in the ringbuffer before being removed. Entries that are older than time-to-live-seconds are removed from the ringbuffer on the next ringbuffer operation (read or write). Time to live can be disabled by setting time-to-live-seconds to 0. It means that items won't get removed because they expire. They may only be overwritten. When time-to-live-seconds is disabled and after the tail does a full loop in the ring, the ringbuffer size will always be equal to the capacity. The time-to-live-seconds can be any integer between 0 and Integer#MAX_VALUE. 0 means infinite. The default is 0.


key: in-memory-format

description: Sets the in-memory format. Setting the in-memory format controls the format of the stored item in the ringbuffer: - OBJECT: the item is stored in deserialized format (a regular object) - BINARY (default): the item is stored in serialized format (a binary blob) The object in-memory format is useful when: - the object stored in object format has a smaller footprint than in binary format - if there are readers using a filter. Since for every filter invocation, the object needs to be available in object format.

enum: OBJECT BINARY


key: class-name

description: Fully qualified class name.


key: factory-class-name

description: Fully qualified name of the RingbufferStoreFactory implementation class.


key: split-brain-protection-ref

description: Adds the Split Brain Protection for this data-structure which you configure using the "split-brain-protection" element. You should set the "split-brain-protection-ref"'s value as the "split-brain-protection"'s name.


key: prefetch-count

description: Sets how many IDs are pre-fetched on the background when one call to FlakeIdGenerator.newId() is made. Value must be in the range 1..100,000. This setting pertains only to newId() calls made on the member that configured it.


key: prefetch-validity-millis

description: Sets for how long the pre-fetched IDs can be used. If this time elapses, a new batch of IDs will be fetched. Time unit is milliseconds, default is 10 minutes. The IDs contain timestamp component, which ensures rough global ordering of IDs. If an ID is assigned to an object that was created much later, it will be much out of order. If you don't care about ordering, set this value to 0. This setting pertains only to newId() calls made on the member that configured it.


key: epoch-start

description: Sets the offset of timestamp component. Time unit is milliseconds, default is 1.1.2018 0:00 UTC. If you set the epoch start to a future instant, negative IDs will be generated until that time occurs.


key: node-id-offset

description: Sets the offset that will be added to the node ID assigned to cluster member for this generator. Might be useful in A/B deployment scenarios where you have cluster A which you want to upgrade. You create cluster B and for some time both will generate IDs and you want to have them unique. In this case, configure node ID offset for generators on cluster B.


key: bits-sequence

description: Sets the bit-length of the sequence component


key: bits-node-id

description: Sets the bit-length of node id component.


key: allowed-future-millis

description: Sets how far to the future is the generator allowed to go to generate IDs without blocking.


key: statistics-enabled

description: When you enable it, you can retrieve the Flake ID generators statistics.


description: When you enable it, you can retrieve queue statistics.


key: max-size

description: Maximum size of the queue. When a JVM's local queue size reaches the maximum, all put/offer operations will be blocked until the queue size of the JVM goes below this maximum. Its default value is 0, meaning Integer.MAX_VALUE


key: empty-queue-ttl

description: Used to purge unused or empty queues. If you define a value (time in seconds) for this element, then your queue will be destroyed if it stays empty or unused for that time.


key: queue-store

description: Includes configuration elements and attributes for your queue store implementation. When you want to load/store the distributed queue items from/to a persistent datastore, first implement Hazelcast's QueueStore interface and then configure it using this element


description: The fully qualified name of the QueueStore implementation you want to use


description: The fully qualified name of the QueueStoreFactory which will be created by Hazelcast to instantiate QueueStores.


key: binary

description: If you do not reach the queue store from an external application, you might prefer to insert the items in binary form. To do so, set this property to true and skip the deserialization step, which is a performance optimization.


key: memory-limit

description: Number of items after which Hazelcast will store items only to datastore. For example, if the memory limit is 1000, then the 1001st item will be put only to datastore. This feature is useful when you want to avoid out-of-memory conditions. If you want to always use memory, you can set it to Integer.MAX_VALUE.


key: bulk-load

description: Size of the bulks loaded from QueueStore when the queue is initialized.


key: priority-comparator-class-name

description: Fully-qualified comparator's class name to be used for the priority queue. If nothing is provided, then queue behaves as a FIFO queue.


key: include-value

description: Set to true if you want the item event to contain the item values.


description: The in-memory format being used for representing the multimap. If it is false, the OBJECT in-memory format will be used.


key: async-fillup

description: Specifies whether the replicated map is available for reads before the initial replication is completed. If false, no Exception will be thrown when the replicated map is not yet ready, but call is blocked until the initial replication is completed.


description: When you enable it, you can retrieve replicated map entry statistics such as creation time, expiration time, number of hits, key, value, etc.


description: When you enable it, you can retrieve cache entry statistics such as creation time, expiration time, number of hits, key, value, etc.


key: management-enabled

description: If set to true, JMX beans are enabled and collected statistics are provided. It doesn't automatically enable statistics collection.


key: read-through

description: If set to true, enables read-through behavior of the cache to an underlying configured javax.cache.integration.CacheLoader which is also known as lazy-loading.


key: write-through

description: If set to true, enables write-through behavior of the cache to an underlying configured javax.cache.integration.CacheWriter which passes any changed value to the external backend resource.


key: cache-loader-factory

description: Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.integration.CacheLoader instance to the cache.


key: cache-loader

description: Name of the cache loader class.


key: cache-writer-factory

description: Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.integration.CacheWriter instance to the cache.


key: cache-writer

description: Name of the cache writer class.


key: expiry-policy-factory

description: Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.expiry.ExpiryPolicy instance to the cache.


key: cache-entry-listeners

description: List of cache entry listeners.


key: old-value-required

description: If set to true, previously assigned values for the affected keys will be sent to the javax.cache.event.CacheEntryListener implementation. Setting this attribute to true creates additional traffic.


key: synchronous

description: If set to true, the javax.cache.event.CacheEntryListener implementation will be called in a synchronous manner.


key: cache-entry-listener-factory

description: Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.event.CacheEntryListener instance.


key: cache-entry-event-filter-factory

description: Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.event.CacheEntryEventFilter instance.


key: name

description: Name of the WAN replication configuration


key: republishing-enabled

description: When enabled, an incoming event to a member is forwarded to target cluster of that member.


key: filters

description: Filters to intercept WAN replication events before they are placed to WAN event replication queues by providing a filtering API. Just implement Hazelcast's CacheWanEventFilter interface to create your filters.


key: merge-policy-class-name

description: Resolve conflicts that occurred when target cluster already has the replicated entry key.


key: split-brain-protection-ref

description: Adds the split brain protection for this cache. The value should be a "split-brain-protection"'s name.


key: partition-lost-listeners

description: Adds the partition lost listeners that you created by implementing Hazelcast's PartitionLostListener interface.


key: hot-restart

description: Used to enable Hazelcast's Hot Restart 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.


key: fsync

description: Set as true if the writing to disk should be followed by an fsync() system call.


key: data-persistence

description: 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.


key: capacity

description: 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.


key: time-to-live-seconds

description: 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.


key: disable-per-entry-invalidation-events

description: 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.


key: class-name

description: Fully qualified class name.


key: management-center

description: Defines the Hazelcast Management Center related metrics configuration.


key: enabled

description: 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.


key: retention-seconds

description: 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).


description: The master-switch for the metrics collection. If this is set to false no metrics collection is done, regardless of the other settings.


key: jmx

description: Defines the JMX related metrics configuration.


description: 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.


key: collection-frequency-seconds

description: Sets the metrics collection frequency in seconds.


key: LiteMember

description: 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.


key: cp-member-count

description: 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".


key: group-size

description: 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".


key: session-time-to-live-seconds

description: 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".


key: session-heartbeat-interval-seconds

description: 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".


key: missing-cp-member-auto-removal-seconds

description: 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.


key: fail-on-indeterminate-operation-state

description: 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


key: persistence-enabled

description: 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.


key: base-dir

description: 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.

default: cp-data


key: data-load-timeout-seconds

description: 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.


key: cp-member-priority

description: The CP member priority. The CP groups' leadership will be eventually transferred to members with higher priorities within the CP group.


key: leader-election-timeout-in-millis

description: Leader election timeout in milliseconds. If a candidate cannot win majority of the votes in time, a new election round is initiated.


key: leader-heartbeat-period-in-millis

description: Period in milliseconds for a leader to send heartbeat messages to its followers.


key: max-missed-leader-heartbeat-count

description: Maximum number of missed leader heartbeats to trigger a new leader election.


key: append-request-max-entry-count

description: Maximum number of entries that can be sent in a single batch of append entries request.


key: commit-index-advance-count-to-snapshot

description: Number of new commits to initiate a new snapshot after the last snapshot.


description: Maximum number of uncommitted entries in the leader's Raft log before temporarily rejecting new requests of callers.


description: 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.


key: semaphores

description: Configurations for CP Semaphore instances. The CP Semaphores can be configured with mappings under keys as their names.


key: jdk-compatible

description: 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.


key: initial-permits

description: Number of permits to initialize the Semaphore. If a positive value is set, the Semaphore is initialized with the given number of permits.


key: locks

description: Configurations for FencedLock instances. The FencedLocks can be configured with mappings under keys as their names.


key: lock-acquire-limit

description: 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.


key: BackupCount

description: 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.


key: AsyncBackupCount

description: 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.


key: List

description: Name-value pairs of list configurations


key: statistics-enabled

description: When you enable it, you can retrieve list statistics.


key: max-size

description: Maximum size of the list (item count). 0 means Integer.MAX_VALUE.


key: split-brain-protection-ref

description: Adds the Split Brain Protection for this data-structure. You should set this value as a "split-brain-protection"'s name.


key: enabled

description: Set to true to enable Hazelcast's security features.


key: realms

description: 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.

enum: jaas tls ldap kerberos simple

enum: REQUIRED REQUISITE SUFFICIENT OPTIONAL

default: REQUIRED

enum: attribute reverse direct

default: reverse

required: username password

enum: username-password kerberos token credentials-factory


key: jaas

description: Defines JAAS authentication - i.e. list of login-module descriptions and optional "properties"


key: tls

description: TLS defines X.509 based authentication (for cases when SSL mutual authentication is configured in Hazelcast network configuration)


key: member-authentication

description: Maps member authentication to a realm name.


key: client-authentication

description: Maps client authentication to a realm name.


key: client-permission-policy

description: 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.


key: security-interceptors

description: Specifies the security interceptor class that you developed by implementing Hazelcast's SecurityInterceptor interface to intercept every remote operation executed by a client.


key: client-block-unmapped-actions

description: Specifies whether to block (true) or allow (false) actions, submitted as tasks in an Executor from the clients and have no permission mappings.


key: client-permissions

description: 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.

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

enum: RECEIVE SEND NONE


key: unit

description: Unit can be bytes, kilobytes, megabytes and gigabytes. Default unit is MEGABYTES.

enum: BYTES KILOBYTES MEGABYTES GIGABYTES

default: MEGABYTES


key: value

description: Default value is 128.

type: number


key: NativeMemory

description: This feature is available only in Hazelcast Enterprise HD.

enum: STANDARD POOLED

default: POOLED


description: Set as true to enable the High-Density Memory Store usage.


key: allocator-type

description: 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


key: size

description: Deprecated, use 'capacity' instead.


key: min-block-size

description: 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.


key: page-size

description: 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)


key: metadata-space-percentage

description: 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.


key: persistent-memory-directory

description: 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.


key: CrdtReplication

description: 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


key: max-concurrent-replication-targets

description: 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.


key: replication-period-millis

description: 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.


key: replica-count

description: Number of replicas on which the CRDT state will be kept.


key: split-brain-protection-ref

description: Adds the Split Brain Protection for this data-structure which you configure using the "split-brain-protection" element.


key: statistics-enabled

description: When you enable it, you can retrieve the PN counter statistics.


key: Listeners

description: Configuration used to register the listeners that you created by implementing Hazelcast's MembershipListener, DistributedObjectListener, MigrationListener and PartitionLostListener interfaces.


key: MemberAttributes

description: 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.


key: portable-version

description: 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.


key: use-native-byte-order

description: Set as true if you want to use the native byte order of the underlying platform.


key: byte-order

description: Specifies the byte order that the serialization will use.


key: enable-compression

description: Set as true to enable compression when default Java serialization is used. Its default value is false.


key: enable-shared-object

description: Set as true to enable shared object when default Java serialization is used.


key: allow-unsafe

description: Set as true to allow the usage of unsafe.


key: data-serializable-factories

description: Lists your class implementations of Hazelcast's DataSerializableFactory. Each factory has the required


key: portable-factories

description: 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.


key: global-serializer

description: 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


key: override-java-serialization

description: If you set it as true, the Java serialization step will be handled by the global serializer, not by the Java Serializable or Externalizable


key: serializers

description: Lists the serializers (classes) that you implement using Hazelcast's StreamSerializer, ByteArraySerializer etc.

required: type-class class-name


key: type-class

description: The type of the class that will be serialized via this implementation.


key: class-name

description: The class name of the serializer implementation.


key: check-class-def-errors

description: 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


key: java-serialization-filter

description: Allows to configure blacklisting and whitelisting for deserialized classes when Java serialization is used.


key: compact-serialization

description: Contains configuration elements and attributes for the compact serialization.


description: Contains the Compact serializers to be registered.


key: serializer

description: Fully qualified class name of the Compact serializer.


key: classes

description: Contains the classes to be serialized with Compact serialization, which will override any other serialization mechanisms.


key: class

description: Fully qualified name of the class.


key: enabled

description: Specifies whether this split brain protection is enabled.


key: minimum-cluster-size

description: 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.


key: protect-on

description: Specifies for which operations the split brain protection will be applied. Available values are READ, WRITE and READ_WRITE.

enum: READ WRITE READ_WRITE


key: function-class-name

description: 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.


key: listeners

description: 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.


key: heartbeat-tolerance-millis

description: Overrides the hazelcast.max.no.heartbeat.seconds system property.


key: acceptable-heartbeat-pause-millis

description: 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.


key: suspicion-threshold

description: 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.


key: max-sample-size

description: Number of samples to use for calculations. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.sample.size system property.


key: min-std-deviation-millis

description: Minimum standard deviation (in milliseconds) to use for the normal distribution used when calculating phi. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.min.std.dev.millis system propery.


key: heartbeat-interval-millis

description: Value of heartbeat interval in milliseconds. Overrides the hazelcast.heartbeat.interval.seconds system property.


key: auto-remove-stale-data

description: Sets whether or not automatic removal of stale Hot Restart data is enabled. When a member terminates or crashes when cluster state is ACTIVE, remaining members redistributes data among themselves and data persisted on terminated member's storage becomes stale. That terminated member cannot rejoin the cluster without removing Hot Restart data. When auto-removal of stale Hot Restart data is enabled, while restarting that member, Hot Restart data is automatically removed and it joins the cluster as a completely new member. Otherwise, Hot Restart data should be removed manually.


key: base-dir

description: Specifies the directory where the Hot Restart data will be stored. This directory will be created automatically if it does not exist.

default: hot-restart


key: backup-dir

description: Specifies the directory where the Hot backup data will be stored. If this element is not defined, hot backup will be disabled. If a directory is defined which does not exist, it will be created on first backup. To avoid clashing data on multiple backups, each backup has a unique sequence ID which determines the name of the directory which will contain all hot restart data. This unique directory is created as a subdirectory of the configured `backup-dir`.


key: parallelism

description: Level of parallelism in Hot Restart Persistence. There will be this many IO threads, each writing in parallel to its own files. During the Hot Restart procedure, this many IO threads will be reading the files and this many Rebuilder threads will be rebuilding the Hot Restart metadata.


key: validation-timeout-seconds

description: Validation timeout for the Hot Restart process when validating the cluster members expected to join and the partition table on the whole cluster.


key: data-load-timeout-seconds

description: Data load timeout for the Hot Restart process. All members in the cluster should finish restoring their local data before this timeout period.


key: cluster-data-recovery-policy

description: Specifies the data recovery policy that will be respected during Hot Restart cluster start. Valid values are:\n FULL_RECOVERY_ONLY: Starts the cluster only when all expected members are present and correct. Otherwise, it fails. This is the default value.\n PARTIAL_RECOVERY_MOST_RECENT: Starts the cluster with the members which have most up-to-date partition table and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.\n PARTIAL_RECOVERY_MOST_COMPLETE: Starts the cluster with the largest group of members which have the same partition table version and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.


key: encryption-at-rest

description: Specifies the (optional) encryption settings for Hot Restart persistence. It has the required attribute "enabled" to specify whether encryption is enabled. In addition to that, it specifies the symmetric cipher to use (such as AES/CBC/PKCS5Padding), the encryption salt, the key size for generating encryption keys and, in the "secure-store" sub-element, the configuration of the Secure Store that it will be used to retrieve the encryption keys.\n "keystore": Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.\n "vault": Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) <ssl> configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.

default: thesalt

required: path password

protocol: TLS

mutualAuthentication: REQUIRED

keyStoreType: JKS

trustStorePassword: changeit

trustStoreType: JKS

required: address secret-path token


key: algorithm

description: Symmetric encryption algorithm


key: keystore

description: Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.


key: type

description: For information about standard keystore types see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore


key: password

description: The keystore password


key: polling-interval

description: Interval (in seconds) for polling for changes in the KeyStore. 0 (default) means no polling


key: vault

description: Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) "ssl" configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.


description: Interval (in seconds) for polling for changes to the encryption key. 0 (default) means polling disabled.


description: Specifies the directory where the Persistence data will be stored. This directory will be created automatically if it does not exist.

default: persistence


description: Specifies the directory where the Persistence backup data will be stored. If this element is not defined, backup will be disabled. If a directory is defined which does not exist, it will be created on first backup. To avoid clashing data on multiple backups, each backup has a unique sequence ID which determines the name of the directory which will contain all persistence data. This unique directory is created as a subdirectory of the configured `backup-dir`.


description: Level of parallelism in Persistence. There will be this many IO threads, each writing in parallel to its own files. During the restart procedure, this many IO threads will be reading the files and this many Rebuilder threads will be rebuilding the Persistence metadata.


description: Validation timeout for the restart process when validating the cluster members expected to join and the partition table on the whole cluster.


description: Data load timeout for the restart process. All members in the cluster should finish restoring their local data before this timeout period.


description: Specifies the data recovery policy that will be respected during restart cluster start. Valid values are:\n FULL_RECOVERY_ONLY: Starts the cluster only when all expected members are present and correct. Otherwise, it fails. This is the default value.\n PARTIAL_RECOVERY_MOST_RECENT: Starts the cluster with the members which have most up-to-date partition table and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.\n PARTIAL_RECOVERY_MOST_COMPLETE: Starts the cluster with the largest group of members which have the same partition table version and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.


description: Specifies the (optional) encryption settings for persistence. It has the required attribute "enabled" to specify whether encryption is enabled. In addition to that, it specifies the symmetric cipher to use (such as AES/CBC/PKCS5Padding), the encryption salt, the key size for generating encryption keys and, in the "secure-store" sub-element, the configuration of the Secure Store that it will be used to retrieve the encryption keys.\n "keystore": Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.\n "vault": Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) <ssl> configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.


key: rebalance-delay-seconds

description: Time (in seconds) to wait before triggering automatic partition rebalancing after a member leaves the cluster unexpectedly. Unexpectedly in this context means that a member leaves the cluster by means other than graceful shutdown: programmatic termination (eg LifecycleService.terminate()), a process crash or network partition. Default is 0, which means rebalancing is triggered immediately. Setting this to a higher value will allow some time for members that are gone to rejoin the cluster. The benefit is that partition rebalancing in this case will be avoided, saving the burden of migrating partition data over the network. Do not use this option if your cluster also stores in-memory data. This option stops the cluster from migrating in-memory data. As a result any data that is not persisted will be lost if the member restarts within the configured delay, including backups. While members are gone, operations on partitions for which the owner is missing may fail immediately or will be retried until the member rejoins or operation timeout is exceeded. Notice that this delay only applies when cluster members leave the cluster; when the cluster is being scaled up and members are being added, partition rebalancing will be triggered immediately (subject to limitations imposed by the current cluster state).


description: Device base directory that will be used for tiered-store.

default: tiered-store


key: capacity

description: Device capacity, i.e., what is the soft upper bound capacity of the device. The default is 256 gigabytes.


key: block-size

description: Device block/sector size in bytes. The default is 4096. The minimum is 512.


key: read-io-thread-count

description: Read IO thread count. The default is 4.


key: write-io-thread-count

description: Write IO thread count. The default is 4.


key: persistence-enabled

description: True if dynamic configuration persistence is enabled.


key: backup-dir

description: Directory for dynamic configuration persistence file backups. Each new backup will be created inside this directory. Can be an absolute or relative path to the node startup directory. If not set, new folder will be created at the node startup directory.


key: backup-count

description: How many backups will be kept. Default is 5. You can set this to zero to disable backups.


key: port

description: The ports which Hazelcast will use to communicate between cluster members.


key: port-count

description: The default value is 100, meaning that Hazelcast will try to bind 100 ports. If you set the value of port as 5701, as members join the cluster, Hazelcast tries to find ports between 5701 and 5801. You can change the port count in cases like having large instances on a single machine or you are willing to have only a few ports assigned.


key: auto-increment

description: If port is set to 5701, Hazelcast will try to find free ports between 5701 and 5801. Normally, you will not need to change this value, but it comes in handy when needed. You may also want to choose to use only one port. In that case, you can disable the auto-increment feature of port by setting its value as false.


key: public-address

description: Overrides the public address of a node. By default, a node selects its socket address as its public address. But behind a network address translation (NAT), two endpoints (nodes) may not be able to see/access each other. If both nodes set their public addresses to their defined addresses on NAT, then they can communicate with each other. In this case, their public addresses are not an address of a local network interface but a virtual address defined by NAT. This is optional to set and useful when you have a private cloud.


key: reuse-address

description: When you shutdown a cluster member, the server socket port will be in the TIME_WAIT state for the next couple of minutes. If you start the member right after shutting it down, you may not be able to bind it to the same port because it is in the TIME_WAIT state. If you set reuse-address to true, the TIME_WAIT state is ignored and you can bind the member to the same port again.


key: name

description: Name of the endpoint configuration. Only relevant when defining WAN server sockets.


key: interfaces

description: Specifies which network interfaces Hazelcast should use. You need to set its "enabled" sub-element to true to be able to use your defined interfaces. By default, it is disabled. You can define multiple interfaces using a nested "interfaces" sequence.


key: ssl

description: Lets you configure SSL using the SSL context factory. This feature is available only in Hazelcast Enterprise. To be able to use it, encryption should NOT be enabled and you should first implement your SSLContextFactory class. Its configuration contains the factory class and SSL properties.


key: socket-interceptor

description: Lets you add custom hooks to join and perform connection procedures (like identity checking using Kerberos, etc.). This feature is available only in Hazelcast Enterprise. To be able to use it, you should first implement the MemberSocketInterceptor (for members joining to a cluster) or SocketInterceptor (for clients connecting to a member) class. Its configuration contains the class you implemented and socket interceptor properties.


key: symmetric-encryption

description: Lets you encrypt the entire socket level communication among all Hazelcast members. This feature is available only in Hazelcast Enterprise.  Its configuration contains the encryption properties and the same configuration must be placed to all members.

default: thepassword


key: buffer-direct

description: Specifies whether direct or non-direct buffers should be allocated for the socket.


key: tcp-no-delay

description: Specifies whether Nagle's algorithm should be disabled. The default value is true meaning that Nagle's algorithm is disabled.


key: keep-alive

description: Specifies whether TCP keep-alive should be enabled.


key: connect-timeout-seconds

description: Specifies the TCP timeout in seconds.


key: send-buffer-size-kb

description: Specifies the size of the send buffer.


key: receive-buffer-size-kb

description: Specifies the size of the receive buffer.


key: linger-seconds

description: Specifies the TCP linger seconds.


key: keep-idle-seconds

description: Specifies the TCP Keep-Alive idle time: the number of seconds of idle time before keep-alive initiates a probe. Valid values are 1 to 32767.


key: keep-interval-seconds

description: Specifies the TCP keep-alive interval: the number of seconds between keep-alive probes. Valid values are 1 to 32767.


key: keep-count

description: Specifies the TCP Keep-Alive count: the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side. Valid values are 1 to 127.


key: cluster-name

description: Sets the cluster name used as an endpoint cluster name for authentication on the target endpoint. If there is no separate publisher ID property defined, this cluster name will also be used as a WAN publisher ID. This ID is then used for identifying the publisher in a WanReplicationConfig.


key: batch-size

description: Changes the maximum size of events that are sent to the target cluster in a single batch. The batch of events is not sent until this size is reached.


key: batch-max-delay-millis

description: If the number of events generated does not reach the "batch-size", they are sent to the target cluster after a certain amount of time is passed. You can set this time in milliseconds using this element.


key: response-timeout-millis

description: After a replication event is sent to the target cluster, the source member waits for a confirmation that says the event has reached the target. If confirmation is not received for a period of `response-timeout-millis`, the event is resent to the target cluster.


key: acknowledge-type

description: Acknowledgment type for each target cluster when the events are replicated. You can set it to the following values: \n * ACK_ON_RECEIPT: Guarantees that events are received by the target cluster. It does not guarantee that the received event is actually applied, but it is faster. \n * ACK_ON_OPERATION_COMPLETE (default): Guarantees that the event is both received and applied by the target cluster. It is more time consuming, but it is the best way if you have strong consistency requirements.


key: initial-publisher-state

description: Defines the initial state in which a WAN publisher is started. \n * REPLICATING (default): State where both enqueuing new events is allowed, enqueued events are replicated to the target cluster and WAN sync is enabled. \n * PAUSED: State where new events are enqueued but they not are dequeued. Some events which have been dequeued before the state was switched may still be replicated to the target cluster but further events will not be replicated. WAN sync is enabled. \n * STOPPED:  State where neither new events are enqueued nor dequeued. As with the PAUSED state, some events might still be replicated after the publisher has switched to this state. WAN sync is enabled.

enum: REPLICATING PAUSED STOPPED

default: REPLICATING


key: snapshot-enabled

description: Sets if key-based coalescing is configured for this WAN publisher. When enabled, only the latest WanReplicationEvent of a key is sent to target.


key: idle-max-park-ns

description: Sets the maximum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate.


key: idle-min-park-ns

description: Sets the minimum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate.


key: max-concurrent-invocations

description: Sets the maximum number of WAN event batches being sent to the target cluster concurrently. Setting this property to anything less than 2 will only allow a single batch of events to be sent to each target endpoint and will maintain causality of events for a single partition. Setting this property to 2 or higher will allow multiple batches of WAN events to be sent to each target endpoint. Since this allows reordering or batches due to network conditions, causality and ordering of events for a single partition is lost and batches for a single partition are now sent randomly to any available target endpoint. This, however, does present faster WAN replication for certain scenarios such as replicating immutable, independent map entries which are only added once and where ordering of when these entries are added is not necessary. Keep in mind that if you set this property to a value which is less than the target endpoint count, you will lose performance as not all target endpoints will be used at any point in time to process WAN event batches. So, for instance, if you have a target cluster with 3 members (target endpoints) and you want to use this property, it makes sense to set it to a value higher than 3. Otherwise, you can simply disable it by setting it to less than 2 in which case WAN will use the default replication strategy and adapt to the target endpoint count while maintaining causality.


key: discovery-period-seconds

description: Sets the period in seconds in which WAN tries to discover new target endpoints and reestablish connections to failed endpoints.


key: use-endpoint-private-address

description: Sets whether the WAN connection manager should connect to the endpoint on the private address returned by the discovery SPI. By default this property is false which means the WAN connection manager will always use the public address.


key: queue-full-behavior

description: Policy to be applied when WAN Replication event queues are full. You can set it to the following values: \n - DISCARD_AFTER_MUTATION (default): The new WAN events generated are dropped and not replicated to the target cluster.


key: max-target-endpoints

description: The maximum number of endpoints that WAN will connect to when using a discovery mechanism to define endpoints. This property has no effect when static endpoint addresses are defined using target-endpoints.


key: queue-capacity

description: Size of the queue of events. If you exceed this queue size, then the oldest, not yet replicated updates might get lost. Therefore, if you have a large rate of put/update/remove operations, you should increase queue capacity.


key: target-endpoints

description: Comma separated list of IP addresses of the target cluster members for which the WAN replication is implemented.


key: consistency-check-strategy

description: Sets the strategy for checking consistency of data between source and target cluster. Any inconsistency will not be reconciled, it will be merely reported via the usual mechanisms (e.g. statistics, diagnostics). The user must initiate WAN sync to reconcile there differences. For the check procedure to work properly, the target cluster should support the chosen strategy.


key: consumer

description: Config for processing WAN events received from a target cluster. You can configure certain behaviour when processing incoming WAN events or even configure your own implementation for a WAN consumer. A custom WAN consumer allows you to define custom processing logic and is usually used in combination with a custom WAN publisher. A custom consumer is optional and you may simply omit defining it which will cause the default processing logic to be used.


key: class-name

description: Sets the fully qualified class name of the class implementing a custom WAN consumer (WanConsumer). If you don't define a class name, the default processing logic for incoming WAN events will be used.


key: properties

description: Properties for the custom WAN consumer. These properties are accessible when initalizing the WAN consumer.


key: persist-wan-replicated-data

description: When true, an incoming event over WAN replication can be persisted to a database for example, otherwise it will not be persisted. Default value is true.


key: class-cache-mode

description: Controls the local caching behavior for the classes loaded from the remote class repository. Available values are as follows:\n * ETERNAL: Cache the loaded classes locally. This is the default value and suitable when you load long-living objects, such as domain objects stored in a map. \n * OFF: Do not cache the loaded classes locally.

enum: ETERNAL OFF

default: ETERNAL


key: provider-mode

description: Controls how the classes are served to the other cluster members. Available values are as follows: \n * LOCAL_AND_CACHED_CLASSES: Serve classes loaded from both local classpath and from other members. This is the default value. \n * LOCAL_CLASSES_ONLY: Serve classes from the local classpath only. Classes loaded from other members will be used locally, but they are not served to other members. \n * OFF: Never serve classes to other members.


key: blacklist-prefixes

description: Comma separated name prefixes of classes/packages to be prevented from dynamic class loading. For example, if you set it as "com.foo", remote loading of all classes from the "com.foo" package will be blacklisted, including the classes from all its sub-packages. If you set it as "com.foo.Class", then the "Class" and all classes having the "Class" as prefix in the "com.foo" package will be blacklisted.


key: whitelist-prefixes

description: Comma separated name prefixes of classes/packages only from which the classes will be loaded. It allows to quickly configure remote loading only for classes from selected packages. It can be used together with blacklisting. For example, you can whitelist the prefix "com.foo" and blacklist the prefix "com.foo.secret".


key: provider-filter

description: Filter to constraint members to be used for a class loading request when a class is not available locally. The value is in the format "HAS_ATTRIBUTE:foo". When it is set as "HAS_ATTRIBUTE:foo", the class loading request will only be sent to the members which have "foo" as a member attribute.


key: statement-timeout-millis

description: Defines the timeout in milliseconds that is applied to queries without an explicit timeout.


key: catalog-persistence-enabled

description: Sets whether SQL Catalog persistence is enabled for the node. With SQL Catalog persistence enabled you can restart the whole cluster without losing schema definition objects (such as MAPPINGs, TYPEs, VIEWs and DATA CONNECTIONs). The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Feature is disabled by default. If you enable this option in open-source, the member will fail to start, you need Enterprise to run it and obtain a license from Hazelcast.


key: resubmission-mode

description: The configuration when to retry query that fails with reasons CONNECTION_PROBLEM, PARTITION_DISTRIBUTION, TOPOLOGY_CHANGE.

default: NEVER


key: ClientTpc

description: Configures the client for TPC, which is the next generation Hazelcast that uses thread-per-core model. TPC-aware clients will maintain connections to all cores of all cluster members. The client will route partition-specific invocations to the correct core of the correct member in the best effort basis. This configuration is introduced as BETA, and it might be subject to changes, or it can be removed in future releases without a prior notice.


key: enabled

description: Enables or disables the TPC-aware mode.


key: OutboundPorts

description: By default, Hazelcast lets the system pick up an ephemeral port during socket bind operation. But security policies/firewalls may require you to restrict outbound ports to be used by Hazelcast-enabled applications. You can specify these ports under the element "outbound-ports". You can give a single port number, comma separated multiple ports or port ranges.


key: instance

description: Deprecated, use `/hazelcast/jet` to configure the fields directly. General configuration options pertaining to a Jet instance.


key: cooperative-thread-count

description: the number of threads each cluster member will use to execute Jet jobs. This refers only to threads executing `cooperative` processors; each `blocking` processor is assigned its own thread. By default it is the same as the number of available processors.


key: flow-control-period

description: While executing a Jet job there is the issue of regulating the rate at which one member of the cluster sends data to another member. The receiver will regularly report to each sender how much more data it is allowed to send over a given DAG edge. This property sets the length (in milliseconds) of the interval between flow-control ("ack") packets.


key: backup-count

description: Sets the number of backups that Jet will maintain for the job metadata and snapshots. Each backup is on another cluster member; all backup write operations must complete before the overall write operation can complete. The maximum allowed number of backups is 6 and the default is 1. For example, if you set the backup count to 2, Jet will replicate all the job metadata and snapshot data to two other members. If one or two members of the cluster fail, Jet can recover the data from the snapshot and continue executing the job on the remaining members without loss.


key: scale-up-delay-millis

description: Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster. Has no effect on jobs with auto scaling disabled.


key: lossless-restart-enabled

description: Sets whether lossless job restart is enabled for the node. With lossless restart you can restart the whole cluster without losing the jobs and their state. The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Note: the snapshots exported using `Job#exportSnapshot` will also have Hot Restart storage enabled. Feature is disabled by default. If you enable this option in open-source, the member will fail to start, you need Enterprise to run it and obtain a license from Hazelcast.


key: max-processor-accumulated-records

description: Specifies the maximum number of records that can be accumulated by any single processor instance. Operations like grouping, sorting or joining require certain amount of records to be accumulated before they can proceed. You can set this option to reduce the probability of `OutOfMemoryError`. It applies to each processor instance separately, hence the effective limit of records accumulated by each cluster member is influenced by the vertex's `localParallelism` and the number of jobs in the cluster. Currently, this option limits: number of items sorted by the sort operation, number of distinct keys accumulated by aggregation operations, number of entries in each hash-join lookup table, number of entries in stateful transforms and number of distinct items in distinct operation. The limit does not apply to streaming aggregations.