type: string

description: The profile name (embedded or located in the project)

description: The path to the profile file relative to the project root

type: object

description: A profile is some template set of checks to run with Qodana analysis

key: profile


description: A license to apply for license compatibility checks in Qodana

description: The license homepage

description: The SPDX ID of the license

key: license


description: The default running scenario

enum: default php-migration

description: The name of the script

description: The parameters to pass to the script

key: script


description: A license rule to apply for license compatibility checks in Qodana

type: array

description: The list of project license SPDX IDs

description: The list of prohibited dependency licenses for the project

description: The list of allowed dependency licenses for the project

key: licenseRule


description: A dependency to ignore for license checks in Qodana

description: The name of a dependency to ignore

key: dependencyIgnore


description: The name of a .NET solution inside the Qodana project

description: The name of a .NET project inside the Qodana project

description: The name of a configuration to be used for .NET solution or project

description: The name of a platform to be used for .NET solution or project

description: Configuration for .NET solutions and projects

key: dotnet


description: The inspections or paths to exclude from analysis

description: The path in which to disable the inspection, relative to the project root. Omitting the paths disables the inspection everywhere

description: The ID of the inspection to exclude, or 'All'

key: exclude


description: The inspections to run in addition to those from the profile

description: The ID of the inspection to be added

key: include


key: dot-net


description: Console command name

title: Command name

key: commands


description: CVar name

title: Variable name

key: cvars


description: Configures the properties of the SIL Kit Logging Service

description: Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt

enum: File Stdout

default: Info

enum: Critical Error Warn Info Debug Trace Off

key: Logging


description: Contains information that can be used to construct a formatted message that describes a result.

description: A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result.

description: An array of strings that will be used, in combination with a message format, to construct a result message.

key: formattedRuleMessage


description: A logical location of a construct that produced a result.

description: The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'resource', or 'type', if any of those accurately describe the construct.

description: Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

key: logicalLocation


description: The runtime environment of the analysis tool run.

type: integer

description: The process id for the analysis tool run.

description: The account that ran the analysis tool.

description: The working directory for the analysis rool run.

description: The command line used to invoke the tool.

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.

description: The contents of any response files specified on the tool's command line.

description: The machine that hosted the analysis tool run.

description: The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format: date-time

description: The fully qualified path to the analysis tool.

description: The date and time at which the run ended. See "Date/time properties" in the  SARIF spec for the required format.

description: Key/value pairs that provide additional information about the run.

description: A set of distinct strings that provide additional information.

key: invocation


required: value algorithm

description: A hash value of some file or collection of files, together with the algorithm used to compute the hash.

description: The name of the algorithm used to compute the hash value specified in the 'value' property.

description: The hash value of some file or collection of files, computed by the algorithm named in the 'algorithm' property.

key: hash


description: The analysis tool that was run.

description: The name of the tool.

description: The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

description: The tool version, in whatever format the tool natively provides.

description: The tool version in the format specified by Semantic Versioning 2.0.

description: The name of the tool along with its version and any other useful identifying information, such as its locale.

description: A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

description: Key/value pairs that provide additional information about the tool.

description: The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

key: tool


description: A region within a file where a result was detected.

description: The line number of the first character in the region.

description: The column number of the first character in the region.

description: The length of the region in bytes or characters.

description: The column number of the last character in the region.

description: The zero-based offset from the beginning of the file of the first byte or character in the region.

description: The line number of the last character in the region.

key: region


description: A function call within a stack trace.

description: The fully qualified name of the method or function that is executing.

description: The parameters of the call that is executing.

description: A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

description: The line of the location to which this stack frame refers.

description: The address of the method or function that is executing.

description: The uri of the source code file to which this stack frame refers.

format: uri

description: The name of the module that contains the code of this stack frame.

description: Key/value pairs that provide additional information about the stack frame.

description: A set of distinct strings that provide additional information.

description: The offset from the method or function that is executing.

description: The thread identifier of the stack frame.

description: A message relevant to this stack frame.

description: A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.

key: stackFrame


description: Describes an analysis rule.

description: Key/value pairs that provide additional information about the rule.

description: A rule identifier that is understandable to an end user.

description: A string that describes the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

description: A stable, opaque identifier for the rule.

default: warning

enum: note warning error

description: A value specifying the default severity level of the result.

description: A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.

description: A set of name/value pairs with arbitrary names. The value within each name/value pair shall consist of plain text interspersed with placeholders, which can be used to format a message in combination with an arbitrary number of additional string arguments.

description: A URI where the primary documentation for the rule can be found.

key: rule


description: The replacement of a single range of bytes in a file. Specifies the location within the file where the replacement is to be made, the number of bytes to remove at that location, and a sequence of bytes to insert at that location.

description: The MIME Base64-encoded byte sequence to be inserted at the byte offset specified by the 'offset' property, measured from the beginning of the file.

description: The number of bytes to delete, starting at the byte offset specified by offset, measured from the beginning of the file.

description: A non-negative integer specifying the offset in bytes from the beginning of the file at which bytes are to be removed, inserted or both. An offset of 0 shall denote the first byte in the file.

key: replacement


type: boolean

description:
Include/exclude this format in an AlternativeOutputFormats format listing
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The replacement for `http://` or `https://` in `baseURL`
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The identifier
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The weight
https://gohugo.io/templates/output-formats/#configure-output-formats

default: index

description:
The base filename for the list filenames
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Enable/disable .Permalink and .RelPermalink return the rendering output format
https://gohugo.io/templates/output-formats/#configure-output-formats

enum: application/javascript application/json application/manifest+json application/octet-stream application/pdf application/rss+xml application/toml application/typescript application/xml application/yaml font/otf font/ttf image/bmp image/gif image/jpeg image/png image/svg+xml image/webp text/calendar text/css text/csv text/html text/jsx text/plain text/tsx text/x-sass text/x-scss video/3gpp video/mp4 video/mpeg video/ogg video/webm video/x-msvideo

description:
The media type
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Enable/disable Go's plain text templates parser for the templates
https://gohugo.io/templates/output-formats/#configure-output-formats

default: alternate

description:
The path
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Enable/disable adding file extensions to urls
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The output format options
https://gohugo.io/templates/output-formats/#configure-output-formats

title: output format options

key: outputFormats


required: factory-id class-name

key: ClassWithFactoryId


description: Enables/disables the TCP_NODELAY socket option.

description: Enables/disables the SO_REUSEADDR socket option.

description: Enables/disables SO_LINGER with the specified linger time in seconds.

description: Enables/disables the SO_KEEPALIVE socket option.

description: Sets the SO_SNDBUF and SO_RCVBUF options to the specified value in KB for this Socket.

key: ClientSocketOptions


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


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

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.

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

description: Specifies the TCP linger seconds.

description: Specifies the size of the receive buffer.

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

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.

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

description: Specifies the size of the send buffer.

description: Specifies the TCP timeout in seconds.

key: SocketOptions


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


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.

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

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.

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

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

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.

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

default: cp-data

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.

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.

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

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.

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

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

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

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

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

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

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.

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

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

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

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


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.

default: BLOCK

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.

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


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

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.

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


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

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

key: Interfaces


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


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

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

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

key: PNCounter


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.

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

key: Sql


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

key: Listeners


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


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

default: ETERNAL

enum: ETERNAL OFF

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.

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.

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.

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


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.

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.

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

key: MemberAddressProvider


enum: READ WRITE READ_WRITE

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.

type: number

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.

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.

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

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.

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

description: Specifies whether this split brain protection is enabled.

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.

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.

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

key: SplitBrainProtection


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

default: true

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


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

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

key: EntryListener


enum: LRU LFU NONE RANDOM

key: Eviction


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: 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.\n * DISCARD_NEWEST: Message that was to be published is discarded.\n * BLOCK: The caller will wait until there is space in the Ringbuffer.\n * ERROR: The publish call fails immediately.

key: ClientReliableTopic


description: Configures SO_RCVBUF socket option for TPC sockets.

description: Configures SO_SNDBUF socket option for TPC sockets.

description: Configures the port range available for TPC sockets.

description: Socket configuration for TPC. In TPC, each eventloop has its own sockets.

key: TpcSocketConfig


description: 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 connecting to a member) class. Its configuration contains the class you implemented and socket interceptor properties. By default, it is disabled.

key: SocketInterceptor


key: InstanceTracking


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

key: ItemListener


required: username password

description: Defines a static UsernamePasswordCredentials instance as the member's identity. It has mandatory "username" and "password" attributes.

key: UsernamePasswordIdentity


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

key: AutoDetection


description: True if dynamic configuration persistence is enabled.

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

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


default: PutIfAbsentMergePolicy

examples: ExpirationTimeMergePolicy HyperLogLogMergePolicy HigherHitsMergePolicy PutIfAbsentMergePolicy DiscardMergePolicy LatestUpdateMergePolicy PassThroughMergePolicy LatestAccessMergePolicy

key: MergePolicyClassName


default: NEVER

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

key: ClientSql


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

description: The type of the DataConnection.

description: Name of the data connection configuration.

description: The "properties" used for configuring data connection

key: DataConnectionConfig


key: ConfigReplacers


enum: all create destroy modify read remove lock listen release acquire put add index intercept publish aggregate projection deploy submit cancel restart export-snapshot add-resources write instance member migration create-view drop-view create-type drop-type view-dataconnection create-dataconnection drop-dataconnection

key: SecurityPermissionAction


description: If set to true, creating Hazelcast client does not wait for connecting to the cluster.

description: Defines the configuration used when retrying to connect to the cluster.

description: Specifies how long to wait (backoff) after the first failure before retrying in milliseconds.

description: Specifies by how much to randomize backoffs.

description: 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 the failover client is used, the client will start trying to connect alternative clusters after 120000 ms. For any other value, both the failover and non-failover client will use that as it is.

description: Specifies the upper limit for the backoff in milliseconds.

description: Factor to multiply the backoff after a failed retry.

default: ON

enum: ASYNC ON OFF

description: 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 manner where all the waiting invocations receive a HazelcastClientOfflineException.

key: ConnectionStrategy


description: Fully qualified class name.

key: ClassNameObj


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. By default, it is disabled.

key: SSL


description: Enables or disables the TPC-aware mode.

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


description: Sequence lists the classes available in the client class path to load.

description: If set to true, user code deployment is enabled.

description: Sequence lists the jar files containing the classes to load.

key: ClientUserCodeDeployment


description: Default value is 128.

default: MEGABYTES

enum: BYTES KILOBYTES MEGABYTES GIGABYTES

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

key: Capacity


key: ClassFilter


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.

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.

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.

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.

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.

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.

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

description: 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 to allow good interleaving with other packets. Note that a single item cannot straddle packets, therefore the maximum packet size can exceed the value configured here by the size of a single data item. This setting has no effect on a non-distributed edge.

description: 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` further than the last acknowledged byte and the receive window is sized in proportion to the rate of processing at the receiver. Ack packets are sent in regular intervals (InstanceConfig#setFlowControlPeriodMs) and the `receive window multiplier` sets the factor of the linear relationship between the amount of data processed within one such interval and the size of the receive window. To put it another way, let us define an `ackworth` as the amount of data processed between two consecutive ack packets. The receive window multiplier determines the number of ackworths the sender can be ahead of the last acked byte. This setting has no effect on a non-distributed edge.

description: 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 processors executing the logic of each vertex, and since the queues are SPSC, there will be `senderParallelism input.txt receiverParallelism` queues representing the edge on each member. The edge capacity should strike a balance between performance and memory usage.

key: Jet


description: Enabled Hazelcast TPC. Disabled by default.

description: Configures the number of eventloops. It's equal to available processor count by default.

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

key: TpcConfig


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


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


required: class-name service

key: ProxyFactories


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.

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

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.

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.

description: Sets the bit-length of the sequence component

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

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

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


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


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


key: KerberosIdentity


description: Enables/disables Integrity Checker. Integrity Checker can be disabled to improve startup time.

key: IntegrityChecker


description: Fully qualified class name.

key: ClassNameWithProps


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


description: Sets the metrics collection frequency in seconds.

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.

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


description: Sets how many IDs are pre-fetched on the background when one call to FlakeIdGenerator#newId() is made.

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 600,000 (10 minutes).

key: ClientFlakeIdGenerator


required: encoding value

description: Defines a static TokenCredentials instance as the client's identity. It has a "value" and it can have also "encoding" defined.

key: TokenIdentity


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

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.

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.

default: persistence

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

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: 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: Validation timeout for the restart process when validating the cluster members expected to join and the partition table on the whole cluster.

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.

default: thesalt

required: path password

description: The keystore password

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

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

required: address secret-path token

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.

mutualAuthentication: REQUIRED

trustStorePassword: changeit

protocol: TLS

keyStoreType: JKS

trustStoreType: JKS

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

description: Symmetric encryption algorithm

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.

key: Persistence


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.

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

description: Timeout in milliseconds before declaring a failed ping.

description: Time in milliseconds between each ICMP ping.

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

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.

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.

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

key: FailureDetector


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

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.

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.

default: hot-restart

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

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`.

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

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.

description: The keystore password

description: Symmetric encryption algorithm

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


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


default: BINARY

enum: BINARY OBJECT NATIVE

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)

key: InMemoryFormat


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

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.

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

key: ManagementCenter


default: subtree

enum: object one-level subtree

key: LdapSearchScope


key: PartitionGroup


const: custom

description: 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-robin fashion.\n * "custom": The member the operations to be sent to is chosen by provided load balancer implementation. The implementation class name is specified in additional "class-name" key.

enum: random round-robin custom

key: LoadBalancer


title: Glob-like paths to be excluded.

key: rule


enum: tar zstd

description: BZIP2 Compression (.bz2)

description: GZIP Compression (.gzip)

description: None, (default)

description: Compress table data using these methods

key: CompressionType


description: All arguments have the same types

description: All even arguments have one type, odd arguments have another type

description: Arbitrary number of arguments of an common type out of a list of valid types

key: Variadic


description: A classifier element is a scoped classifier label (e.g. the element PII belongs to the classifier scope data)

description: The name of the label, use "*" to allow arbitrary strings as labels

description: A description of this classifier element

key: Label


enum: scalar aggregate window

key: FunctionKind


description: A function parameter

description: The required constant value of this parameter

description: The name of the parameter

description: The nullability of this column

description: The datatype of this parameter

description: The parameter may appear as identifier, without quote

description: An array of classifier references

description: A description of this parameter

key: Parameter


enum: sdf presto bigquery redshift

key: Dialect


required: datatypes type-variable

key: TypeBound


description: SQL queries can be parameterized via variables of type varchar. A variable definition binds the variable to the provided value.

description: The name of the variable

description: The value of this variable (using sql/yaml literals)

key: Variable


description: All derived tables are cached by default

description: External tables must be explicitly marked When using 'Create external table` SQL syntax

description: View

description: Ephemeral

description: Recursive warehouse tables must be  explicitly  marked

key: Materialization


description: Target classifier

description: Expected source classifier

key: Reclassify


enum: parquet csv json

description: Store table data in these formats

key: FileFormat


description: Pure - An pure function will always return the same output when given the same input.

description: Stable - A stable function may return different values given the same input across different queries but must return the same value for a given input within a query.

description: Volatile - A volatile function may change the return value from evaluation to evaluation. Multiple invocations of a volatile function may return different results when used in the same query.

description: A function's volatility, which defines the functions eligibility for certain optimizations

key: Volatility


description: These functions were used to produce the output column

description: The output column is computed by copying these upstream columns

description: The output column is computed by transforming these upstream columns

description: These upstream columns are indirectly used to produce the output (e.g. in WHERE or GROUP BY)

key: Lineage


required: binary extension format name

description: A function block defines the signature for user defined

description: Full path to the binary [e.g.: /usr/bin/python3]

description: The name of the plugin [e.g.: pyspark]

description: File extension to scan in the includes directories; must be unique [e.g.: .py]

description: Format of the output files; must be known to SDF [e.g.: spark-lp-json]

key: Plugin


description: A partition is a table column, used to describe to which partition this row belongs to

description: The format of the partition column [use strftime format for date/time] See (guide)[https://docs.sdf.com/guide/schedules]

description: The name of the partition column

description: A description of the partition column

key: Partition


required: branch git path rev

description: The relative path from this workspace to the referenced workspace, for a Git repo, from the root of the depot to the workspace

description: The Git repo

description: the Git revision

description: the Git branch

key: WorkspacePath


required: input output

description: The sql string corresponding to the input of this example

description: The output corresponding to running the input string

key: Example


required: datatype name

description: A function parameter

description: The required constant value of this parameter

description: The name of the parameter

description: The datatype of this parameter

description: The parameter may appear as identifier, without quote

description: An array of classifier references

description: A description of this parameter

key: OptionalParameter


enum: zero-or-one one zero-or-more

key: Cardinality


required: type path

description: Merge yaml file with yq command line tool pattern matching

description: Set the value of these items to the value. So `'license':MIT` would set the `license` property of the yaml file to 'MIT'

description: Merge type

description: YQ pattern of property to create if the property does not exist in target project file

description: YQ pattern of property to replace

description: A list of items to not create, copy, replace, or remove in target file

description: Path to file to merge

required: condition pattern

description: Configuration for property to replace if condition evaluates to truthy

description: YQ pattern of property to replace

description: The condition to evaluate for truthiness. If truthy will replace property matched by pattern

description: A set of properties to replace if the condition evaluates to truthy

key: mergeYaml


description: Merge file using git merge (use with varied reliability)

description: Path to file to merge

description: Merge type

key: mergeGit


description: Merge json file with jq command line tool pattern matching

description: Set the value of these items to the value. So `'.license':MIT` would set the `license` property of the json file to 'MIT'

description: Merge type

description: JQ pattern of property to create if the property does not exist in target project file

description: JQ pattern of property to replace

description: Path to file to merge

description: JQ pattern of property to replace

key: mergeJson


required: to names

description: The path to move the directory to

description: The directories to move

key: moveItems


description: The Environment variable name

description: List of Environment variable names to create in target project if they are not already created

key: mergeEnv


const: Debian

title: Name

default: all

enum: bookworm bullseye buster etch jessie lenny sid squeeze stretch wheezy all

title: DebianPlatformModel

key: DebianPlatformModel


const: Alpine

title: Name

title: AlpinePlatformModel

key: AlpinePlatformModel


const: vSphere

title: Name

title: vSpherePlatformModel

key: vSpherePlatformModel


const: IOS

title: Name

title: IOSPlatformModel

key: IOSPlatformModel


const: Cumulus

title: Name

title: CumulusPlatformModel

key: CumulusPlatformModel


const: OracleLinux

title: Name

title: OracleLinuxPlatformModel

key: OracleLinuxPlatformModel


const: opensuse

title: Name

title: opensusePlatformModel

key: opensusePlatformModel


const: Kali

title: Name

title: KaliPlatformModel

key: KaliPlatformModel


const: macOS

title: Name

enum: Big-Sur Catalina High-Sierra Mojave Monterey Sierra all

title: macOSPlatformModel

key: macOSPlatformModel


const: Ubuntu

title: Name

enum: artful bionic cosmic cuttlefish disco eoan focal groovy hirsute impish jammy lucid maverick natty oneiric precise quantal raring saucy trusty utopic vivid wily xenial yakkety zesty all

title: UbuntuPlatformModel

key: UbuntuPlatformModel


const: Amazon Linux

title: Name

title: Amazon Linux 2PlatformModel

key: AmazonLinuxPlatformModel


const: EL

title: Name

title: ELPlatformModel

key: ELPlatformModel


const: Amazon

title: Name

title: AmazonPlatformModel

key: AmazonPlatformModel


const: Windows

title: Name

title: WindowsPlatformModel

key: WindowsPlatformModel


const: GenericLinux

title: Name

title: GenericLinuxPlatformModel

key: GenericLinuxPlatformModel


const: Void Linux

title: Name

title: Void LinuxPlatformModel


const: MacOSX

title: Name

title: MacOSXPlatformModel

key: MacOSXPlatformModel


markdownDescription: See [Using collections in roles](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-roles) and [collection naming conventions](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_in_groups.html#naming-conventions)

title: Collections

key: collections


const: PAN-OS

title: Name

title: PAN-OSPlatformModel

key: PAN-OSPlatformModel


const: NetBSD

title: Name

title: NetBSDPlatformModel

key: NetBSDPlatformModel


const: GenericBSD

title: Name

title: GenericBSDPlatformModel

key: GenericBSDPlatformModel


const: eos

title: Name

title: eosPlatformModel

key: eosPlatformModel


const: Gentoo

title: Name

title: GentooPlatformModel

key: GentooPlatformModel


const: Junos

title: Name

title: JunosPlatformModel

key: JunosPlatformModel


const: NXOS

title: Name

title: NXOSPlatformModel

key: NXOSPlatformModel


const: Devuan

title: Name

enum: ascii beowulf ceres jessie all

title: DevuanPlatformModel

key: DevuanPlatformModel


const: GenericUNIX

title: Name

title: GenericUNIXPlatformModel

key: GenericUNIXPlatformModel


const: AIX

title: Name

title: AIXPlatformModel

key: AIXPlatformModel


const: HardenedBSD

title: Name

title: HardenedBSDPlatformModel

key: HardenedBSDPlatformModel


const: Solaris

title: Name

title: SolarisPlatformModel

key: SolarisPlatformModel


const: Synology

title: Name

title: SynologyPlatformModel

key: SynologyPlatformModel


const: DragonFlyBSD

title: Name

title: DragonFlyBSDPlatformModel

key: DragonFlyBSDPlatformModel


const: ClearLinux

title: Name

title: ClearLinuxPlatformModel

key: ClearLinuxPlatformModel


const: vCenter

title: Name

title: vCenterPlatformModel

key: vCenterPlatformModel


const: aos

title: Name

title: aosPlatformModel

key: aosPlatformModel


const: SLES

title: Name

title: SLESPlatformModel

key: SLESPlatformModel


const: Mageia

title: Name

title: MageiaPlatformModel

key: MageiaPlatformModel


title: Name

title: os10PlatformModel


const: DellOS

title: Name

title: DellOSPlatformModel

key: DellOSPlatformModel


const: OpenWrt

title: Name

title: OpenWrtPlatformModel

key: OpenWrtPlatformModel


const: ArchLinux

title: Name

title: ArchLinuxPlatformModel

key: ArchLinuxPlatformModel


const: TMOS

title: Name

title: TMOSPlatformModel

key: TMOSPlatformModel


const: FreeBSD

title: Name

title: FreeBSDPlatformModel

key: FreeBSDPlatformModel


const: Fedora

title: Name

title: FedoraPlatformModel

key: FedoraPlatformModel


const: SmartOS

title: Name

title: SmartOSPlatformModel

key: SmartOSPlatformModel


const: OpenBSD

title: Name

title: OpenBSDPlatformModel

key: OpenBSDPlatformModel


title: Threshold

key: threshold


title: Config

key: config


title: Enabled

key: enabled


description:
Format code ending at a given character offset (exclusive).
The range will extend forwards to the end of the selected statement.
This option cannot be used with --cursor-offset.

description:
Print (to stderr) where a cursor at the given position would move to after formatting.
This option cannot be used with --range-start and --range-end.

default: always

description: Always include parens. Example: `(x) => x`

description: Omit parens when possible. Example: `x => x`

description: Include parentheses around a sole arrow function parameter.

description: Add a plugin. Multiple plugins can be passed as separate `--plugin`s.

description: Trailing commas where valid in ES5 (objects, arrays, etc.)

description: No trailing commas.

description: Trailing commas wherever possible (including function arguments).

description: Print trailing commas wherever possible when multi-line.

description: Disable plugin autoloading.

description:
Custom directory that contains prettier plugins in node_modules subdirectory.
Overrides default behavior when plugins are searched relatively to the location of Prettier.
Multiple values are accepted.

default: lf

description: Line Feed only (\n), common on Linux and macOS as well as inside git repos

description: Carriage Return + Line Feed characters (\r\n), common on Windows

description: Carriage Return character only (\r), used very rarely

description:
Maintain existing
(mixed values within one file are normalised by looking at what's used after the first line)

description: Which end of line characters to apply.

default: as-needed

description: Only add quotes around object properties where required.

description: If at least one property in an object requires quotes, quote all properties.

description: Respect the input use of quotes in object properties.

description: Change when properties in objects are quoted.

description: Specify the input filepath. This will be used to do parser inference.

description:
Require either '@prettier' or '@format' to be present in the file's first docblock comment
in order for it to be formatted.

description:
Format code starting at a given character offset.
The range will extend backwards to the start of the first line containing the selected statement.
This option cannot be used with --cursor-offset.

description: Number of spaces per indentation level.

description: The line length where Prettier will try wrap.

description: Indent script and style tags in Vue files.

description: Flow

description: JavaScript

description: Flow

description: TypeScript

description: TypeScript

description: JavaScript

description: JavaScript

description: JavaScript

description: CSS

description: Less

description: SCSS

description: JSON

description: JSON.stringify

description: GraphQL

description: Markdown

description: MDX

description: Vue

description: YAML

description: Ember / Handlebars

description: HTML

description: Angular

description: Lightning Web Components

description: Custom parser

description: Which parser to use.

description: Enforce single attribute per line in HTML, Vue and JSX.

description: Put > of opening tags on the last line instead of on a new line.

default: css

description: Respect the default value of CSS display property.

description: Whitespaces are considered sensitive.

description: Whitespaces are considered insensitive.

description: How to handle whitespaces in HTML.

description: Insert @format pragma into file's first docblock comment.

description: Use single quotes in JSX.

description: Print spaces between brackets.

default: auto

description: Format embedded code if Prettier can automatically identify it.

description: Never automatically format embedded code.

description: Control how Prettier formats quoted code embedded in the file.

default: preserve

description: Wrap prose if it exceeds the print width.

description: Do not wrap prose.

description: Wrap prose as-is.

description: How to wrap prose.

description: Print semicolons.

description: Use single quotes instead of double quotes.

description: Whether parse the .editorconfig file in your project and convert its properties to the corresponding Prettier configuration. This configuration will be overridden by .prettierrc, etc.

description: Indent with tabs instead of spaces.

key: optionsDefinition


key: ChangelogSubgroup


key: Reddit


key: HomebrewDependency


key: DockerManifest


key: GitHubURLs


key: TemplatedExtraFileWithMode


enum: linux darwin

key: NixDependency


key: GoMod


key: NFPMScripts


key: NFPMDebTriggers


key: UPX


enum: all manifests images checksum source package archive binary sbom

key: Sign


enum: tar tgz tar.gz zip gz tar.xz txz binary

key: FormatOverride


key: Webhook


key: SnapcraftAppMetadata


key: ContentFileInfo


key: SnapcraftLayoutMetadata


key: SMTP


key: Teams


key: IgnoredBuild


key: Telegram


key: Fury


key: PullRequestBase


key: Mattermost


required: src dst

key: TemplateFile


key: SBOM


key: OpenCollective


key: SnapcraftExtraFiles


key: Ko


key: GitLabURLs


key: Discord


key: Hooks


required: kind name version

key: PatchTarget


key: FieldSpec


description: Contains the fieldPath to an object field

key: FieldSelector


key: Metadata


key: PatchTargetOptional


required: source targets

description: The source of the value

description: The kind of the referent

description: The group of the referent

description: The name of the referent

description: The namespace of the referent

description: The structured path to the source value

description: The version of the referent

description: The structured path to the source value

description: The structured path(s) to the target nodes

description: Include objects that match this

description: The namespace of the referent

description: The kind of the referent

description: The version of the referent

description: The group of the referent

description: The name of the referent

description: Exclude objects that match this

description: The namespace of the referent

description: The kind of the referent

description: The version of the referent

description: The group of the referent

description: The name of the referent

description: Exclude objects that match this

description: The N fields to write the value to

key: ReplacementsInline


key: Target


enum: merge override replace

key: HelmChart


description: GeneratorOptions modify behavior of all ConfigMap and Secret generators

description: Labels to add to all generated resources

description: Annotations to add to all generated resources

description: Immutable if true add to all generated resources

description: DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents

key: GeneratorOptions


enum: cassandra couchdb docker elasticsearch mariadb memcached mongodb mysql neo4j postgresql rabbitmq redis redis-server rethinkdb riak xvfb

key: service


enum: apt bundler cargo ccache cocoapods packages pip yarn npm

key: cache


enum: always never change

key: notificationFrequency


description: the vendoredDependencies fields allow you to configure vendored dependency scans. Vendored dependency scans are described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

description: If true, forces a re-scan of all vendored dependencies on every run. If false or not present, then we do not re-scan vendored dependencies that have been previously scanned. A vendored dependency has been previously scanned if a dependency with the same name and version has already been scanned by your organization. If no version is provided, then any change in the files being scanned will result in a rescan.

description: licenseScanPathFilters allows you to filter which files are scanned when doing a CLILicenseScan. This setting does not apply if you use the ArchiveUpload method of scanning vendoredDependencies.

description: A list of globs that will be used to filter paths. If there are any entries in the `exclude` list, then paths that match any of the `exclude` entries will not be scanned for licenses.

description: A list of globs that will be used to filter paths. If there are any entries in the `only` list, then only paths that match one or more of the globs in the `only` list will be scanned for licenses.

const: ArchiveUpload

description: Vendored dependencies are scanned by the "Archive Upload" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

const: CLILicenseScan

description: Vendored dependencies are scanned by the "CLI-side license scan" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

key: vendoredDependencies


description: The telemetry fields are used to configure telemetry data collection and it's destination.

const: full

description: Collects and sends ends telemetry data to server.

const: off

description: Does not send telemetry data to server.

description: project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch.

description: The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used.

key: telemetry


description: The project fields allow you to configure settings for the project you are interacting with through the FOSSA API.

description: The name field sets the projects visible name in the FOSSA dashboard. By default, this will be set to the project's ID.

description: The Jira Project Key to associate with your project for improved issue triage. Refer to https://docs.fossa.com/docs/atlassian-jira#linking-fossa-projects-to-jira-projects for more information.

description: The URL of your project that will appear in FOSSA. This URL is intended to be the URL to the repository of this project.

description: A list of labels that are assigned to the project

required: name release

description: The release associated with the release group

description: The name of release group.

description: The `name:` and `release:` of the release group's release to add your project to in the FOSSA dashboard. If you choose to associate a project with a release group, you **must** supply both name and release.

description: An external link that will appear in the FOSSA UI for this specific project.

description: The name of the team in your FOSSA organization to associate this project with.

description: The id of the policy in your FOSSA organization to associate this project with. Mutually excludes `project.policy`.

description:
The project ID defines a unique ID that the FOSSA API will use to reference this project. The project ID can be found in the UI on the project settings page listed as the `Project Locator` underneath the `Project Title` setting.

By default, it will use git remote origin url as project id if it's git repository. If it does not recognize version control system (vcs), project directory's name will be used.

key: project


description: Associated path with target type (if any)

const: bundler

description: For bundler targets (ruby)

const: cargo

description: For cargo targets (rust)

const: carthage

description: For carthage targets (ios, objective-c)

const: cocoapods

description: For cocoapod targets (ios, objective-c, swift)

const: composer

description: For composer targets (php)

const: conda

description: For conda targets

const: glide

description: For glide targets (golang)

const: godep

description: For godep targets (golang)

const: gradle

description: For gradle targets (kotlin and java)

const: leiningen

description: For leiningen targets (clojure)

const: maven

description: For maven targets (kotlin and java)

const: mix

description: For mix targets (elixir)

const: npm

description: For npm targets (javascript)

const: nimble

description: For nimble targets (nim)

const: pub

description: For pub targets (dart, flutter)

description: For rebar3 targets (erlang)

const: rpm

description: For rpm targets

const: renv

description: For renv targets (r)

const: scala

description: For scala targets

const: swift

description: For swift targets

const: yarn

description: For yarn targets (javascript)

const: repomanifest

description: For repomanifest

const: cabal

description: For cabal targets (haskell)

const: stack

description: For stack targets (haskell)

const: nuspec

description: For nuspec targets (dotnet)

const: packagereference

description: For package reference targets (dotnet)

const: paket

description: For paket targets (dotnet)

const: projectassetjson

description: For project asset json targets (dotnet)

const: pipenv

description: For pipenv targets (python)

const: poetry

description: For poetry targets (python)

const: setuptools

description: For setuptools targets (python)

const: perl

description: For perl targets (using *META.{json,yml})

const: pnpm

description: For pnpm targets (javascript)

const: pdm

description: For pdm targets (python)

description: Target (package manager)

key: targetFilter


description: Experimental preferences with fossa cli.

description: Gradle preferences for all targets

description: Configurations to only include in analysis (by default excludes any other configurations not listed)

key: experimental


description: The revision fields are used to help FOSSA differentiate between one upload for a project and another, just as GitHub uses commit hashes and branch names.

description: The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used.

description: project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch.

key: revision


description: One step in the command sequence

description: Allocate a pseudo-TTY

description: Working directory inside the container

description: A list of commands to execute within the container

description: Disables the `user` option and executes these commands with the hosts uid and gid.

description: Username or UID (format: <name|uid>[:<group|gid>])

description: Give extended privileges to the commands

description: Keep STDIN open even if not attached

key: Step


title: Tag

description: Use to specify one or more tags for queries whose results you want to include or exclude from display.

title: Tags

description: Use to identify a specific query whose results you want to include or exclude from display on LGTM.

title: ID

description: Use to specify a single level of severity (error, warning or recommendation) for queries whose results you want to include or exclude from display.

title: Severity

title: Query

key: queryItem


key: vcsMatcher


required: manifest update

description: GitOps 방식의 K8S Deploy를 위한 manifest repo 업데이트

description: 빌드 작업에서 manifest reop로 전달할 artifacts

description: manifest repo를 업데이트하기 위한 명령

required: repo branch

description: K8S manifest repo 정보

description: repo('owner/repo')

description: branch

key: git-ops


required: app-id release-group-tag

description: artifact로 지정된 .apk/.ipa 파일을 appcenter로 릴리즈

description: @<user>, @@<group>, corp@@<corpcode>

description: 테스터 지정(@<user>, @@<group>, corp@@<corpcode>)

description: App ID

description: 릴리즈 그룹에 대한 Tag 지정

key: app-center-release


required: name value

description: 환경변수 이름

description: 환경변수 값

description: 환경변수를 적용할 브랜치

key: env


description: 실행환경 설정

description: 실행환경 플랫폼

description: docker image

enum: docker mobil-keystore

description: 실행환경에서 사용할 기능 설정

default: small

enum: small medium large xlarge xxlarge xxxlarge

required: cpu memory

description: cpu (e.g. '1.0')

description: memory (e.g. '500Mi', '2Gi').

description: 실행에 사용할 리소스 크기 설정

key: run-on


description: 빌드 실행 조건

description: Push 이벤트에 의한 조건

description: commit message에 주어진 문자열을 포함한 경우만 빌드

description: Push 빌드의 branch 조건

description: Push 빌드의 tag 조건

description: PullRequest 이벤트에 의한 조건

description: Commit 조건

description: 커밋 메시지가 지정된 문자열을 포함하면 빌드를 실행

description: PR빌드의 target 브랜치 조건

default: opened synchronize reopened

description: PR 이벤트 타입

key: build-condition


description: BoltDB config section

description: TTL keys check interval in seconds. It's safe to use 1 second here, but can be a little costly to performance

description: file name for the db

description: Access permission for the DB file.

key: BoltDB


description: Boltdb jobs driver


description: Hashmap

key: Hashmap


enum: debug info warn error panic

description: Logging level

key: LogLevel


description: Hashmap with floats

key: Bucket


description: Kafka jobs driver

description: Mechanism used for the authentication

description: Username for authentication

description: SessionToken, if non-empty, is a session / security token to use for authentication. See the following link for more details: https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html

description: AWS Access key ID

description: Kafka brokers

description: Zid is an optional authorization ID to use in authenticating

description: UserAgent is the user agent to for the client to use when connecting to Kafka, overriding the default franz-go/<runtime.Version()>/<hostname>. Setting a UserAgent allows authorizing based on the aws:UserAgent condition key; see the following link for more details: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-useragent

description: AWS Secret Access key ID

description: Password for authentication

description: If true, suffixes the tokenauth=true extra attribute to the initial authentication message. Set this to true if the user and pass are from a delegation token. Optional for the SHA auth types. Empty by default

description: Kafka broker addresses


examples: stdout stderr /var/log/rr_errors.log

key: LogOutput


description: TCP server

description: Data packets delimiter. Every send should end either with EOF or with the delimiter

description: Chunks that RR uses to read the data. In MB. If you expect big payloads on a TCP server, to reduce `read` syscalls, would be a good practice to use a fairly big enough buffer

description: Address to listen

key: TCPServers


description: In-memory config section

key: Memory


description: Time duration

key: Duration


enum: development production raw

description: Logging mode

key: LogMode


enum: console json

description: Encoding format

key: LogEncoding


description: Host and port with tcp:// prefix

key: HostAndPortWithTCP


description: In-memory config section

description: Address of the memcached node

key: Memcached


description: NATS jobs driver

description: NATS server address


description: Host and port

key: HostAndPort


key: dependencyManagement


errorMessage: Not a valid workspace name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Workspace/#name

description: Identifier for the workspace configuration. Workspaces named 'default' will be used automatically by UI5 Tooling

title: Workspace Name

key: metadata


description: Ignore files, so that the linter doesn't process them.

title: Ignore

key: ignore


key: Toleration


required: apiGroup kind name

key: TypedLocalObjectReference


required: server path

key: NFSVolumeSource


key: RKETaint


required: service region url signing-region signing-method signing-name

key: ServiceOverride


key: SchedulerService


key: PersistentVolumeClaimVolumeSource


description: Virtual IP range that will be used by Kubernetes services

description: CIDR Range for Pods in cluster

key: KubeControllerService


description: Authorization mode used by kubernetes

description: Authorization mode options

key: AuthzConfig


required: diskName diskURI

key: AzureDiskVolumeSource


key: VirtualCenterConfig


required: Type IntVal StrVal

key: IntOrString


required: type qps burst

key: Limit


description: Fail if swap is enabled

description: Generate per node kubelet serving certificates created using kube-ca

description: Domain of the cluster (default: "cluster.local")

description: The image whose network/ipc namespaces containers in each pod will use

description: Cluster DNS service ip

key: KubeletService


required: endpoints path

key: GlusterfsVolumeSource


key: GitRepoVolumeSource


key: VsphereVirtualDiskVolumeSource


required: registry volume

key: QuobyteVolumeSource


key: PhotonPersistentDiskVolumeSource


key: GroupResources


key: GlobalVsphereOpts


description: Cloud provider type used with calico

key: CalicoNetworkProvider


key: AWSElasticBlockStoreVolumeSource