schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
hazelcast-config-5.3.json | min-std-deviation-millis | 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. | {"type": "integer"} |
hazelcast-config-5.3.json | heartbeat-interval-millis | Value of heartbeat interval in milliseconds. Overrides the hazelcast.heartbeat.interval.seconds system property. | {"type": "integer"} |
hazelcast-config-5.3.json | auto-remove-stale-data | 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. | {"type": "boolean", "default": true} |
hazelcast-config-5.3.json | base-dir | Specifies the directory where the Hot Restart data will be stored. This directory will be created automatically if it does not exist. | {"type": "string", "default": "hot-restart"} |
hazelcast-config-5.3.json | backup-dir | 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`. | {"type": "string"} |
hazelcast-config-5.3.json | parallelism | 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. | {"type": "integer", "minimum": 1, "default": 1} |
hazelcast-config-5.3.json | validation-timeout-seconds | Validation timeout for the Hot Restart process when validating the cluster members expected to join and the partition table on the whole cluster. | {"type": "integer", "minimum": 1, "default": 120} |
hazelcast-config-5.3.json | data-load-timeout-seconds | Data load timeout for the Hot Restart process. All members in the cluster should finish restoring their local data before this timeout period. | {"type": "integer", "minimum": 1, "default": 900} |
hazelcast-config-5.3.json | cluster-data-recovery-policy | 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. | {"enum": ["FULL_RECOVERY_ONLY", "PARTIAL_RECOVERY_MOST_RECENT", "PARTIAL_RECOVERY_MOST_COMPLETE"], "default": "FULL_RECOVERY_ONLY"} |
hazelcast-config-5.3.json | encryption-at-rest | 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. | {"type": "object", "properties": {"enabled": {"type": "boolean", "default": false}, "algorithm": {"type": "string", "default": "AES/CBC/PKCS5Padding"}, "salt": {"type": "string", "default": "thesalt"}, "key-size": {"type": "integer"}, "secure-store": {"type": "object", "oneOf": [{"additionalProperties": false, "properties": {"keystore": {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}, "type": {"type": "string", "default": "PKCS12"}, "password": {"type": "string"}, "current-key-alias": {"type": "string"}, "polling-interval": {"type": "integer", "minimum": 0, "default": 0}}, "required": ["path", "password"]}}}, {"additionalProperties": false, "properties": {"vault": {"type": "object", "additionalProperties": false, "properties": {"address": {"type": "string"}, "secret-path": {"type": "string"}, "token": {"type": "string"}, "polling-interval": {"type": "integer", "default": 0}, "ssl": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string", "examples": ["com.hazelcast.nio.ssl.BasicSSLContextFactory"]}, "properties": {"type": "object", "examples": [{"protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS"}]}}}}, "required": ["address", "secret-path", "token"]}}}]}}} |
hazelcast-config-5.3.json | algorithm | Symmetric encryption algorithm | {"type": "string", "default": "AES/CBC/PKCS5Padding"} |
hazelcast-config-5.3.json | 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. | {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}, "type": {"type": "string", "default": "PKCS12"}, "password": {"type": "string"}, "current-key-alias": {"type": "string"}, "polling-interval": {"type": "integer", "minimum": 0, "default": 0}}, "required": ["path", "password"]} |
hazelcast-config-5.3.json | type | For information about standard keystore types see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore | {"type": "string", "default": "PKCS12"} |
hazelcast-config-5.3.json | password | The keystore password | {"type": "string"} |
hazelcast-config-5.3.json | polling-interval | Interval (in seconds) for polling for changes in the KeyStore. 0 (default) means no polling | {"type": "integer", "minimum": 0, "default": 0} |
hazelcast-config-5.3.json | 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. | {"type": "object", "additionalProperties": false, "properties": {"address": {"type": "string"}, "secret-path": {"type": "string"}, "token": {"type": "string"}, "polling-interval": {"type": "integer", "default": 0}, "ssl": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string", "examples": ["com.hazelcast.nio.ssl.BasicSSLContextFactory"]}, "properties": {"type": "object", "examples": [{"protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS"}]}}}}, "required": ["address", "secret-path", "token"]} |
hazelcast-config-5.3.json | polling-interval | Interval (in seconds) for polling for changes to the encryption key. 0 (default) means polling disabled. | {"type": "integer", "default": 0} |
hazelcast-config-5.3.json | auto-remove-stale-data | 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. | {"type": "boolean", "default": true} |
hazelcast-config-5.3.json | base-dir | Specifies the directory where the Persistence data will be stored. This directory will be created automatically if it does not exist. | {"type": "string", "default": "persistence"} |
hazelcast-config-5.3.json | backup-dir | 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`. | {"type": "string"} |
hazelcast-config-5.3.json | parallelism | 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. | {"type": "integer", "minimum": 1, "default": 1} |
hazelcast-config-5.3.json | validation-timeout-seconds | Validation timeout for the restart process when validating the cluster members expected to join and the partition table on the whole cluster. | {"type": "integer", "minimum": 1, "default": 120} |
hazelcast-config-5.3.json | data-load-timeout-seconds | Data load timeout for the restart process. All members in the cluster should finish restoring their local data before this timeout period. | {"type": "integer", "minimum": 1, "default": 900} |
hazelcast-config-5.3.json | cluster-data-recovery-policy | 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. | {"enum": ["FULL_RECOVERY_ONLY", "PARTIAL_RECOVERY_MOST_RECENT", "PARTIAL_RECOVERY_MOST_COMPLETE"], "default": "FULL_RECOVERY_ONLY"} |
hazelcast-config-5.3.json | encryption-at-rest | 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. | {"type": "object", "properties": {"enabled": {"type": "boolean", "default": false}, "algorithm": {"type": "string", "default": "AES/CBC/PKCS5Padding"}, "salt": {"type": "string", "default": "thesalt"}, "key-size": {"type": "integer"}, "secure-store": {"type": "object", "oneOf": [{"additionalProperties": false, "properties": {"keystore": {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}, "type": {"type": "string", "default": "PKCS12"}, "password": {"type": "string"}, "current-key-alias": {"type": "string"}, "polling-interval": {"type": "integer", "minimum": 0, "default": 0}}, "required": ["path", "password"]}}}, {"additionalProperties": false, "properties": {"vault": {"type": "object", "additionalProperties": false, "properties": {"address": {"type": "string"}, "secret-path": {"type": "string"}, "token": {"type": "string"}, "polling-interval": {"type": "integer", "default": 0}, "ssl": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string", "examples": ["com.hazelcast.nio.ssl.BasicSSLContextFactory"]}, "properties": {"type": "object", "examples": [{"protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS"}]}}}}, "required": ["address", "secret-path", "token"]}}}]}}} |
hazelcast-config-5.3.json | algorithm | Symmetric encryption algorithm | {"type": "string", "default": "AES/CBC/PKCS5Padding"} |
hazelcast-config-5.3.json | 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. | {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}, "type": {"type": "string", "default": "PKCS12"}, "password": {"type": "string"}, "current-key-alias": {"type": "string"}, "polling-interval": {"type": "integer", "minimum": 0, "default": 0}}, "required": ["path", "password"]} |
hazelcast-config-5.3.json | type | For information about standard keystore types see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore | {"type": "string", "default": "PKCS12"} |
hazelcast-config-5.3.json | password | The keystore password | {"type": "string"} |
hazelcast-config-5.3.json | polling-interval | Interval (in seconds) for polling for changes in the KeyStore. 0 (default) means no polling | {"type": "integer", "minimum": 0, "default": 0} |
hazelcast-config-5.3.json | 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. | {"type": "object", "additionalProperties": false, "properties": {"address": {"type": "string"}, "secret-path": {"type": "string"}, "token": {"type": "string"}, "polling-interval": {"type": "integer", "default": 0}, "ssl": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string", "examples": ["com.hazelcast.nio.ssl.BasicSSLContextFactory"]}, "properties": {"type": "object", "examples": [{"protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS"}]}}}}, "required": ["address", "secret-path", "token"]} |
hazelcast-config-5.3.json | polling-interval | Interval (in seconds) for polling for changes to the encryption key. 0 (default) means polling disabled. | {"type": "integer", "default": 0} |
hazelcast-config-5.3.json | rebalance-delay-seconds | 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). | {"type": "integer", "minimum": 0, "default": 0} |
hazelcast-config-5.3.json | base-dir | Device base directory that will be used for tiered-store. | {"type": "string", "default": "tiered-store"} |
hazelcast-config-5.3.json | capacity | Device capacity, i.e., what is the soft upper bound capacity of the device. The default is 256 gigabytes. | {} |
hazelcast-config-5.3.json | block-size | Device block/sector size in bytes. The default is 4096. The minimum is 512. | {"type": "integer", "minimum": 512, "default": 4096} |
hazelcast-config-5.3.json | read-io-thread-count | Read IO thread count. The default is 4. | {"type": "integer", "minimum": 1, "default": 4} |
hazelcast-config-5.3.json | write-io-thread-count | Write IO thread count. The default is 4. | {"type": "integer", "minimum": 1, "default": 4} |
hazelcast-config-5.3.json | persistence-enabled | True if dynamic configuration persistence is enabled. | {"type": "boolean"} |
hazelcast-config-5.3.json | backup-dir | 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. | {"type": "string"} |
hazelcast-config-5.3.json | backup-count | How many backups will be kept. Default is 5. You can set this to zero to disable backups. | {"type": "integer", "minimum": 0} |
hazelcast-config-5.3.json | port | The ports which Hazelcast will use to communicate between cluster members. | {"type": "object", "additionalProperties": false, "properties": {"port": {"type": "integer", "default": 5701}, "port-count": {"type": "integer", "default": 100}, "auto-increment": {"type": "boolean", "default": true}}} |
hazelcast-config-5.3.json | port-count | 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. | {"type": "integer", "default": 100} |
hazelcast-config-5.3.json | auto-increment | 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. | {"type": "boolean", "default": true} |
hazelcast-config-5.3.json | public-address | 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. | {"type": "string"} |
hazelcast-config-5.3.json | reuse-address | 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. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | name | Name of the endpoint configuration. Only relevant when defining WAN server sockets. | {"type": "string"} |
hazelcast-config-5.3.json | interfaces | 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. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "interfaces": {"type": "array", "items": {"type": "string"}}}} |
hazelcast-config-5.3.json | ssl | 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. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string"}, "properties": {"type": "object"}}} |
hazelcast-config-5.3.json | socket-interceptor | 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. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "class-name": {"type": "string"}, "properties": {"type": "object"}}} |
hazelcast-config-5.3.json | symmetric-encryption | 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. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "algorithm": {"type": "string", "default": "PBEWithMD5AndDES"}, "salt": {"type": "string", "default": "thesalt"}, "password": {"type": "string", "default": "thepassword"}, "iteration-count": {"type": "integer", "minimum": 0, "default": 19}}} |
hazelcast-config-5.3.json | buffer-direct | Specifies whether direct or non-direct buffers should be allocated for the socket. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | tcp-no-delay | Specifies whether Nagle's algorithm should be disabled. The default value is true meaning that Nagle's algorithm is disabled. | {"type": "boolean", "default": true} |
hazelcast-config-5.3.json | keep-alive | Specifies whether TCP keep-alive should be enabled. | {"type": "boolean", "default": true} |
hazelcast-config-5.3.json | connect-timeout-seconds | Specifies the TCP timeout in seconds. | {"type": "integer", "minimum": 0, "default": 0} |
hazelcast-config-5.3.json | send-buffer-size-kb | Specifies the size of the send buffer. | {"type": "integer", "minimum": 0, "default": 128} |
hazelcast-config-5.3.json | receive-buffer-size-kb | Specifies the size of the receive buffer. | {"type": "integer", "default": 128} |
hazelcast-config-5.3.json | linger-seconds | Specifies the TCP linger seconds. | {"type": "integer", "default": 0} |
hazelcast-config-5.3.json | keep-idle-seconds | 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. | {"type": "integer", "default": 7200} |
hazelcast-config-5.3.json | keep-interval-seconds | Specifies the TCP keep-alive interval: the number of seconds between keep-alive probes. Valid values are 1 to 32767. | {"type": "integer", "default": 75} |
hazelcast-config-5.3.json | keep-count | 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. | {"type": "integer", "default": 8} |
hazelcast-config-5.3.json | cluster-name | 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. | {"type": "string"} |
hazelcast-config-5.3.json | batch-size | 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. | {"type": "integer", "default": 500} |
hazelcast-config-5.3.json | batch-max-delay-millis | 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. | {"type": "integer", "default": 1000} |
hazelcast-config-5.3.json | response-timeout-millis | 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. | {"type": "integer", "default": 60000} |
hazelcast-config-5.3.json | acknowledge-type | 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. | {"enum": ["ACK_ON_RECEIPT", "ACK_ON_OPERATION_COMPLETE"], "default": "ACK_ON_OPERATION_COMPLETE"} |
hazelcast-config-5.3.json | initial-publisher-state | 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"} |
hazelcast-config-5.3.json | snapshot-enabled | Sets if key-based coalescing is configured for this WAN publisher. When enabled, only the latest WanReplicationEvent of a key is sent to target. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | idle-max-park-ns | Sets the maximum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate. | {"type": "integer", "default": 250000000} |
hazelcast-config-5.3.json | idle-min-park-ns | Sets the minimum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate. | {"type": "integer", "default": 10000000} |
hazelcast-config-5.3.json | max-concurrent-invocations | 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. | {"type": "integer", "default": -1} |
hazelcast-config-5.3.json | discovery-period-seconds | Sets the period in seconds in which WAN tries to discover new target endpoints and reestablish connections to failed endpoints. | {"type": "integer", "default": 10} |
hazelcast-config-5.3.json | use-endpoint-private-address | 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. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | queue-full-behavior | 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. | {"enum": ["DISCARD_AFTER_MUTATION", "THROW_EXCEPTION", "THROW_EXCEPTION_ONLY_IF_REPLICATION_ACTIVE"], "default": "DISCARD_AFTER_MUTATION"} |
hazelcast-config-5.3.json | max-target-endpoints | 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. | {"type": "integer", "default": 2147483647} |
hazelcast-config-5.3.json | queue-capacity | 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. | {"type": "integer", "default": 10000} |
hazelcast-config-5.3.json | target-endpoints | Comma separated list of IP addresses of the target cluster members for which the WAN replication is implemented. | {"type": "string"} |
hazelcast-config-5.3.json | consistency-check-strategy | 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. | {"enum": ["NONE", "MERKLE_TREES"]} |
hazelcast-config-5.3.json | consumer | 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. | {"type": "object", "additionalProperties": false, "properties": {"class-name": {"type": "string"}, "properties": {"type": "object"}, "persist-wan-replicated-data": {"type": "boolean", "default": false}}} |
hazelcast-config-5.3.json | class-name | 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. | {"type": "string"} |
hazelcast-config-5.3.json | properties | Properties for the custom WAN consumer. These properties are accessible when initalizing the WAN consumer. | {"type": "object"} |
hazelcast-config-5.3.json | persist-wan-replicated-data | 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. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | class-cache-mode | 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"} |
hazelcast-config-5.3.json | provider-mode | 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. | {"enum": ["OFF", "LOCAL_CLASSES_ONLY", "LOCAL_AND_CACHED_CLASSES"], "default": "LOCAL_AND_CACHED_CLASSES"} |
hazelcast-config-5.3.json | blacklist-prefixes | 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. | {"type": "string"} |
hazelcast-config-5.3.json | whitelist-prefixes | 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". | {"type": "string"} |
hazelcast-config-5.3.json | provider-filter | 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. | {"type": "string"} |
hazelcast-config-5.3.json | statement-timeout-millis | Defines the timeout in milliseconds that is applied to queries without an explicit timeout. | {"type": "integer", "default": 0} |
hazelcast-config-5.3.json | catalog-persistence-enabled | 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. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | resubmission-mode | The configuration when to retry query that fails with reasons CONNECTION_PROBLEM, PARTITION_DISTRIBUTION, TOPOLOGY_CHANGE. | {"enum": ["NEVER", "RETRY_SELECTS", "RETRY_SELECTS_ALLOW_DUPLICATES", "RETRY_ALL"], "default": "NEVER"} |
hazelcast-config-5.3.json | ClientTpc | 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. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"]} |
hazelcast-config-5.3.json | enabled | Enables or disables the TPC-aware mode. | {"type": "boolean"} |
hazelcast-config-5.3.json | OutboundPorts | 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. | {"anyOf": [{"type": "array", "items": {}}, {"type": "object", "additionalProperties": {}}]} |
hazelcast-config-5.3.json | instance | Deprecated, use `/hazelcast/jet` to configure the fields directly. General configuration options pertaining to a Jet instance. | {"type": "object", "additionalProperties": false, "properties": {"cooperative-thread-count": {"type": "integer"}, "flow-control-period": {"type": "integer", "default": 100}, "backup-count": {"type": "integer", "default": 1, "maximum": 6}, "scale-up-delay-millis": {"type": "integer", "default": 10000}, "lossless-restart-enabled": {"type": "boolean", "default": false}, "max-processor-accumulated-records": {"type": "integer", "default": 9223372036854775807}}} |
hazelcast-config-5.3.json | cooperative-thread-count | 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. | {"type": "integer"} |
hazelcast-config-5.3.json | flow-control-period | 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. | {"type": "integer", "default": 100} |
hazelcast-config-5.3.json | backup-count | 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. | {"type": "integer", "default": 1, "maximum": 6} |
hazelcast-config-5.3.json | scale-up-delay-millis | 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. | {"type": "integer", "default": 10000} |
hazelcast-config-5.3.json | lossless-restart-enabled | 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. | {"type": "boolean", "default": false} |
hazelcast-config-5.3.json | max-processor-accumulated-records | 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. | {"type": "integer", "default": 9223372036854775807} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.