schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
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 f...
{"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 c...
{"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:...
{"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 processo...
{"type": "integer", "default": 9223372036854775807}
hazelcast-config-5.3.json
queue-size
Sets the capacity of processor-to-processor concurrent queues. The value is rounded upwards to the next power of 2. When data needs to travel between two processors on the same cluster member, Jet sends it over a concurrent single-producer, single-consumer (SPSC) queue of fixed capacity. Since there are several process...
{"type": "integer", "default": 1024}
hazelcast-config-5.3.json
packet-size-limit
For a distributed edge, data is sent to a remote member via Hazelcast network packets. Each packet is dedicated to the data of a single edge, but may contain any number of data items. This setting limits the size of the packet in bytes. Packets should be large enough to drown out any fixed overheads, but small enough t...
{"type": "integer", "default": 16384}
hazelcast-config-5.3.json
receive-window-multiplier
Sets the scaling factor used by the adaptive receive window sizing function. For each distributed edge the receiving member regularly sends flow-control ("ack") packets to its sender which prevent it from sending too much data and overflowing the buffers. The sender is allowed to send the data one `receive window` furt...
{"type": "integer", "default": 3}
hazelcast-config-5.3.json
async-start
If set to true, creating Hazelcast client does not wait for connecting to the cluster.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
reconnect-mode
Defines the reconnection mode. The valid values are:\n * "ON": Enables reconnection in a blocking manner where all the waiting invocations are blocked until a cluster connection is established or failed. This is the default value.\n * "OFF": Disables the reconnection.\n * "ASYNC": Enables reconnection in a non-blocking...
{"enum": ["ASYNC", "ON", "OFF"], "default": "ON"}
hazelcast-config-5.3.json
connection-retry
Defines the configuration used when retrying to connect to the cluster.
{"type": "object", "additionalProperties": false, "properties": {"initial-backoff-millis": {"type": "integer", "default": 1000, "minimum": 0}, "max-backoff-millis": {"type": "integer", "minimum": 0, "default": 30000}, "multiplier": {"type": "number", "default": 1.05, "minimum": 1.0}, "cluster-connect-timeout-millis": {...
hazelcast-config-5.3.json
initial-backoff-millis
Specifies how long to wait (backoff) after the first failure before retrying in milliseconds.
{"type": "integer", "default": 1000, "minimum": 0}
hazelcast-config-5.3.json
max-backoff-millis
Specifies the upper limit for the backoff in milliseconds.
{"type": "integer", "minimum": 0, "default": 30000}
hazelcast-config-5.3.json
multiplier
Factor to multiply the backoff after a failed retry.
{"type": "number", "default": 1.05, "minimum": 1.0}
hazelcast-config-5.3.json
cluster-connect-timeout-millis
Timeout value in milliseconds for the client to give up to connect to the current cluster Depending on FailoverConfig, a client can shutdown or start trying on alternative cluster after reaching the timeout. Its default value is -1. For the default value, the client will not stop trying to connect to the cluster. If th...
{"type": "integer", "default": -1, "minimum": -1}
hazelcast-config-5.3.json
jitter
Specifies by how much to randomize backoffs.
{"type": "number", "default": 0, "minimum": 0, "maximum": 1}
hazelcast-config-5.3.json
enabled
If set to true, user code deployment is enabled.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
jarPaths
Sequence lists the jar files containing the classes to load.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
classNames
Sequence lists the classes available in the client class path to load.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
LoadBalancer
The load balancer can be configured with the "load-balancer" mapping. It has a scalar sub-node called "type". The valid values for the type of the load balancer are:\n * "random": The member the operations to be sent to is chosen randomly.\n * "round-robin": The member the operations to be sent to is chosen in a round-...
{"type": "object", "additionalProperties": false, "properties": {"type": {"enum": ["random", "round-robin", "custom"]}, "class-name": {"type": "string"}}, "anyOf": [{"not": {"properties": {"type": {"const": "custom"}}}}, {"required": ["class-name"]}]}
hazelcast-config-5.3.json
prefetch-count
Sets how many IDs are pre-fetched on the background when one call to FlakeIdGenerator#newId() is made.
{"type": "integer", "minimum": 1, "maximum": 100000, "default": 100}
hazelcast-config-5.3.json
prefetch-validity-millis
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 600,000 (10 minutes).
{"type": "integer", "minimum": 1, "default": 600000}
hazelcast-config-5.3.json
read-batch-size
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...
{"type": "integer", "default": 10, "minimum": 1}
hazelcast-config-5.3.json
topic-overload-policy
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...
{"default": "BLOCK", "enum": ["BLOCK", "DISCARD_OLDEST", "DISCARD_NEWEST"]}
hazelcast-config-5.3.json
UsernamePasswordIdentity
Defines a static UsernamePasswordCredentials instance as the member's identity. It has mandatory "username" and "password" attributes.
{"type": "object", "additionalProperties": false, "properties": {"username": {"type": "string"}, "password": {"type": "string"}}, "required": ["username", "password"]}
hazelcast-config-5.3.json
TokenIdentity
Defines a static TokenCredentials instance as the client's identity. It has a "value" and it can have also "encoding" defined.
{"type": "object", "additionalProperties": false, "properties": {"encoding": {"enum": ["none", "base64"]}, "value": {"type": "string"}}, "required": ["encoding", "value"]}
hazelcast-config-5.3.json
CredentialsFactoryIdentity
Specifies the name and properties of your class that you developed by implementing Hazelcast's Credentials interface. This element has a mandatory "class-name" attribute where you should define the factory class implementing ICredentialsFactory used to create Credentials objects. With the "properties" child property, ...
{}
hazelcast-config-5.3.json
cluster-members
This sequence lets you list the members in your cluster the client is connecting to.
{"type": "array", "items": {"type": "string"}}
hazelcast-config-5.3.json
smart-routing
If true, client will route the key based operations to owner of the key at the best effort. Note that it uses a cached version of com.hazelcast.core.PartitionService#getPartitions() and doesn't guarantee that the operation will always be executed on the owner. The cached table is updated every second.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
redo-operation
If true, client will redo the operations that were executing on the server and client lost the connection. This can be because of network, or simply because the member died. However it is not clear whether the application is performed or not. For idempotent operations this is harmless, but for non idempotent ones retry...
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
connection-timeout
Connection timeout is the timeout value in milliseconds for members to accept client connection requests. The following are the example configurations. Its default value is 5000.
{"type": "integer", "default": 5000, "minimum": 0}
hazelcast-config-5.3.json
enabled
Flag to enable icmp ping failure detector. When set to true, this client will use icmp ping failure detector to detect unavailable members.
{"type": "boolean", "default": false}
hazelcast-config-5.3.json
interval-milliseconds
Interval, in milliseconds, between each ping attempt. 1000ms (1 sec) is also the minimum interval allowed.
{"type": "integer", "default": 1000, "minimum": 1000}
hazelcast-config-5.3.json
timeout-milliseconds
Number of milliseconds until a ping attempt is considered failed if there was no reply.
{"type": "integer", "default": 1000}
hazelcast-config-5.3.json
max-attempts
Maximum number of ping attempts before the member gets suspected by the detector.
{"type": "integer", "default": 3}
hazelcast-config-5.3.json
ttl
Maximum number of hops the packets should go through. You can set to 0 to use your system���s default TTL.
{"type": "integer", "default": 255, "minimum": 0}
hazelcast-config-5.3.json
echo-fail-fast-on-startup
The client 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.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
hazelcast-cloud
Set its "enabled" sub-element to true for cluster discovery in the Hazelcast Cloud infrastructure. You need to define the mandatory "discovery-token" sub-node used by the discovery mechanism.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "discovery-token": {"type": "string"}}}
hazelcast-config-5.3.json
SocketInterceptor
Lets you add custom hooks to join and perform connection procedures (like a custom authentication protocol, 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 con...
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "class-name": {"type": "string"}, "properties": {"type": "object"}}}
hazelcast-config-5.3.json
AutoDetection
When enabled, it will walk through all available discovery strategies and detect the correct one for the current runtime environment. For example, it will automatically use the hazelcast-aws plugin if run on an AWS instance.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": "true"}}}
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. By default, it is disabled.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": false}, "factory-class-name": {"type": "string", "example": "com.hazelcast.nio.ssl.BasicSSLContextFactory"}, "properties": {"type": "object"}}}
hazelcast-config-5.3.json
tcp-no-delay
Enables/disables the TCP_NODELAY socket option.
{"default": true, "type": "boolean"}
hazelcast-config-5.3.json
keep-alive
Enables/disables the SO_KEEPALIVE socket option.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
reuse-address
Enables/disables the SO_REUSEADDR socket option.
{"type": "boolean", "default": true}
hazelcast-config-5.3.json
linger-seconds
Enables/disables SO_LINGER with the specified linger time in seconds.
{"type": "integer", "default": 3, "minimum": 0}
hazelcast-config-5.3.json
buffer-size
Sets the SO_SNDBUF and SO_RCVBUF options to the specified value in KB for this Socket.
{"type": "integer", "default": 128, "minimum": 0}
hazelcast-config-5.3.json
IntegrityChecker
Enables/disables Integrity Checker. Integrity Checker can be disabled to improve startup time.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"]}
hazelcast-config-5.3.json
name
Name of the data connection configuration.
{"type": "string"}
hazelcast-config-5.3.json
type
The type of the DataConnection.
{"type": "string"}
hazelcast-config-5.3.json
shared
true if an instance of the data connection will be shared. Depending on the implementation of the data connection, the shared instance may be single a thread-safe instance, or not thread-safe, but a pooled instance; false when on each usage a new instance of the underlying resource should be created.The default is true...
{"type": "boolean"}
hazelcast-config-5.3.json
properties
The "properties" used for configuring data connection
{"type": "object"}
hazelcast-config-5.3.json
TpcConfig
Hazelcast TPC is the next generation of Hazelcast built with thread per core architecture. It's still being developed and everything is subject to change. TPC is disabled by default.
{"type": "object", "properties": {"enabled": {"type": "boolean"}, "eventloop-count": {"type": "integer"}}, "required": ["enabled"]}
hazelcast-config-5.3.json
enabled
Enabled Hazelcast TPC. Disabled by default.
{"type": "boolean"}
hazelcast-config-5.3.json
eventloop-count
Configures the number of eventloops. It's equal to available processor count by default.
{"type": "integer"}
hazelcast-config-5.3.json
TpcSocketConfig
Socket configuration for TPC. In TPC, each eventloop has its own sockets.
{"type": "object", "properties": {"port-range": {"type": "string"}, "receive-buffer-size-kb": {"type": "integer"}, "send-buffer-size-kb": {"type": "integer"}}}
hazelcast-config-5.3.json
port-range
Configures the port range available for TPC sockets.
{"type": "string"}
hazelcast-config-5.3.json
receive-buffer-size-kb
Configures SO_RCVBUF socket option for TPC sockets.
{"type": "integer"}
hazelcast-config-5.3.json
send-buffer-size-kb
Configures SO_SNDBUF socket option for TPC sockets.
{"type": "integer"}
eslintrc.json
rule
ESLint rule 0 - turns the rule off 1 - turn the rule on as a warning (doesn't affect exit code) 2 - turn the rule on as an error (exit code is 1 when triggered)
{"type": "integer", "minimum": 0, "maximum": 2}
eslintrc.json
rule
ESLint rule "off" - turns the rule off "warn" - turn the rule on as a warning (doesn't affect exit code) "error" - turn the rule on as an error (exit code is 1 when triggered)
{"type": "string", "enum": ["off", "warn", "error"]}
eslintrc.json
comma-dangle
Require or disallow trailing commas
{}
eslintrc.json
for-direction
Enforce "for" loop update clause moving the counter in the right direction
{}
eslintrc.json
getter-return
Enforce return statements in getters
{}
eslintrc.json
no-await-in-loop
Disallow await inside of loops
{}
eslintrc.json
no-compare-neg-zero
Disallow comparing against -0
{}
eslintrc.json
no-cond-assign
Disallow assignment operators in conditional expressions
{}
eslintrc.json
no-console
Disallow the use of console
{}
eslintrc.json
no-constant-condition
Disallow constant expressions in conditions
{}
eslintrc.json
no-control-regex
Disallow control characters in regular expressions
{}
eslintrc.json
no-debugger
Disallow the use of debugger
{}
eslintrc.json
no-dupe-args
Disallow duplicate arguments in function definitions
{}
eslintrc.json
no-dupe-keys
Disallow duplicate keys in object literals
{}
eslintrc.json
no-duplicate-case
Disallow duplicate case labels
{}
eslintrc.json
no-empty
Disallow empty block statements
{}
eslintrc.json
no-empty-character-class
Disallow empty character classes in regular expressions
{}
eslintrc.json
no-ex-assign
Disallow reassigning exceptions in catch clauses
{}
eslintrc.json
no-extra-boolean-cast
Disallow unnecessary boolean casts
{}
eslintrc.json
no-extra-parens
Disallow unnecessary parentheses
{}
eslintrc.json
no-extra-semi
Disallow unnecessary semicolons
{}
eslintrc.json
no-func-assign
Disallow reassigning function declarations
{}
eslintrc.json
no-inner-declarations
Disallow function or var declarations in nested blocks
{}
eslintrc.json
no-invalid-regexp
Disallow invalid regular expression strings in RegExp constructors
{}
eslintrc.json
no-irregular-whitespace
Disallow irregular whitespace outside of strings and comments
{}
eslintrc.json
no-negated-in-lhs
Disallow negating the left operand in in expressions (deprecated)
{}
eslintrc.json
no-obj-calls
Disallow calling global object properties as functions
{}
eslintrc.json
no-prototype-builtins
Disallow calling some Object.prototype methods directly on objects
{}
eslintrc.json
no-regex-spaces
Disallow multiple spaces in regular expressions
{}
eslintrc.json
no-sparse-arrays
Disallow sparse arrays
{}
eslintrc.json
no-template-curly-in-string
Disallow template literal placeholder syntax in regular strings
{}
eslintrc.json
no-unexpected-multiline
Disallow confusing multiline expressions
{}
eslintrc.json
no-unreachable
Disallow unreachable code after return, throw, continue, and break statements
{}
eslintrc.json
no-unsafe-finally
Disallow control flow statements in finally blocks
{}
eslintrc.json
no-unsafe-negation
Disallow negating the left operand of relational operators
{}
eslintrc.json
use-isnan
Require calls to isNaN() when checking for NaN
{}
eslintrc.json
valid-jsdoc
Enforce valid JSDoc comments
{}
eslintrc.json
valid-typeof
Enforce comparing typeof expressions against valid strings
{}
eslintrc.json
accessor-pairs
Enforce getter and setter pairs in objects
{}
eslintrc.json
array-callback-return
Enforce return statements in callbacks of array methods
{}
eslintrc.json
block-scoped-var
Enforce the use of variables within the scope they are defined
{}