key: queue-size

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: packet-size-limit

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.

type: integer


key: receive-window-multiplier

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.


key: async-start

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

type: boolean


key: reconnect-mode

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.

enum: ASYNC ON OFF

default: ON


key: connection-retry

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

type: object

type: number


key: initial-backoff-millis

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


key: max-backoff-millis

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


key: multiplier

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


key: cluster-connect-timeout-millis

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.


key: jitter

description: Specifies by how much to randomize backoffs.


key: enabled

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


key: jarPaths

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

type: array

type: string


key: classNames

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


key: LoadBalancer

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

const: custom


key: prefetch-count

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


key: prefetch-validity-millis

description: Sets for how long the pre-fetched IDs can be used. If this time elapses, a new batch of IDs will be fetched. Time unit is milliseconds, default is 600,000 (10 minutes).


key: read-batch-size

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


key: topic-overload-policy

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

default: BLOCK


key: UsernamePasswordIdentity

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

required: username password


key: TokenIdentity

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

required: encoding value


key: CredentialsFactoryIdentity

description: Specifies the name and properties of your class that you developed by implementing Hazelcast's Credentials interface. This element has a mandatory "class-name" attribute where you should define the factory class implementing ICredentialsFactory used to create Credentials objects. With the "properties" child property, you can define properties for the factory class.


key: cluster-members

description: This sequence lets you list the members in your cluster the client is connecting to.


key: smart-routing

description: If true, client will route the key based operations to owner of the key at the best effort. Note that it uses a cached version of com.hazelcast.core.PartitionService#getPartitions() and doesn't guarantee that the operation will always be executed on the owner. The cached table is updated every second.


key: redo-operation

description: If true, client will redo the operations that were executing on the server and client lost the connection. This can be because of network, or simply because the member died. However it is not clear whether the application is performed or not. For idempotent operations this is harmless, but for non idempotent ones retrying can cause to undesirable effects. Note that the redo can perform on any member. If false, the operation will throw a RuntimeException that is wrapping a java.io.IOException.


key: connection-timeout

description: Connection timeout is the timeout value in milliseconds for members to accept client connection requests. The following are the example configurations. Its default value is 5000.


description: Flag to enable icmp ping failure detector. When set to true, this client will use icmp ping failure detector to detect unavailable members.


key: interval-milliseconds

description: Interval, in milliseconds, between each ping attempt. 1000ms (1 sec) is also the minimum interval allowed.


key: timeout-milliseconds

description: Number of milliseconds until a ping attempt is considered failed if there was no reply.


key: max-attempts

description: Maximum number of ping attempts before the member gets suspected by the detector.


key: ttl

description: Maximum number of hops the packets should go through. You can set to 0 to use your system���s default TTL.


key: echo-fail-fast-on-startup

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


key: hazelcast-cloud

description: Set its "enabled" sub-element to true for cluster discovery in the Hazelcast Cloud infrastructure. You need to define the mandatory "discovery-token" sub-node used by the discovery mechanism.


key: SocketInterceptor

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

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.

default: true


key: SSL

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


key: tcp-no-delay

description: Enables/disables the TCP_NODELAY socket option.


key: keep-alive

description: Enables/disables the SO_KEEPALIVE socket option.


key: reuse-address

description: Enables/disables the SO_REUSEADDR socket option.


key: linger-seconds

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


key: buffer-size

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


key: IntegrityChecker

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


key: name

description: Name of the data connection configuration.


key: type

description: The type of the DataConnection.


key: shared

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.


key: properties

description: The "properties" used for configuring data connection


key: TpcConfig

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

description: Enabled Hazelcast TPC. Disabled by default.


key: eventloop-count

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


key: TpcSocketConfig

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


key: port-range

description: Configures the port range available for TPC sockets.


key: receive-buffer-size-kb

description: Configures SO_RCVBUF socket option for TPC sockets.


key: send-buffer-size-kb

description: Configures SO_SNDBUF socket option for TPC sockets.


key: rule

description:
ESLint rule

0 - turns the rule off
1 - turn the rule on as a warning (doesn't affect exit code)
2 - turn the rule on as an error (exit code is 1 when triggered)


description:
ESLint rule

"off" - turns the rule off
"warn" - turn the rule on as a warning (doesn't affect exit code)
"error" - turn the rule on as an error (exit code is 1 when triggered)

enum: off warn error


key: comma-dangle

description: Require or disallow trailing commas


key: for-direction

description: Enforce "for" loop update clause moving the counter in the right direction


key: getter-return

description: Enforce return statements in getters


key: no-await-in-loop

description: Disallow await inside of loops


key: no-compare-neg-zero

description: Disallow comparing against -0


key: no-cond-assign

description: Disallow assignment operators in conditional expressions


key: no-console

description: Disallow the use of console


key: no-constant-condition

description: Disallow constant expressions in conditions


key: no-control-regex

description: Disallow control characters in regular expressions


key: no-debugger

description: Disallow the use of debugger


key: no-dupe-args

description: Disallow duplicate arguments in function definitions


key: no-dupe-keys

description: Disallow duplicate keys in object literals


key: no-duplicate-case

description: Disallow duplicate case labels


key: no-empty

description: Disallow empty block statements


key: no-empty-character-class

description: Disallow empty character classes in regular expressions


key: no-ex-assign

description: Disallow reassigning exceptions in catch clauses


key: no-extra-boolean-cast

description: Disallow unnecessary boolean casts


key: no-extra-parens

description: Disallow unnecessary parentheses


key: no-extra-semi

description: Disallow unnecessary semicolons


key: no-func-assign

description: Disallow reassigning function declarations


key: no-inner-declarations

description: Disallow function or var declarations in nested blocks


key: no-invalid-regexp

description: Disallow invalid regular expression strings in RegExp constructors


key: no-irregular-whitespace

description: Disallow irregular whitespace outside of strings and comments


key: no-negated-in-lhs

description: Disallow negating the left operand in in expressions (deprecated)


key: no-obj-calls

description: Disallow calling global object properties as functions


key: no-prototype-builtins

description: Disallow calling some Object.prototype methods directly on objects


key: no-regex-spaces

description: Disallow multiple spaces in regular expressions


key: no-sparse-arrays

description: Disallow sparse arrays


key: no-template-curly-in-string

description: Disallow template literal placeholder syntax in regular strings


key: no-unexpected-multiline

description: Disallow confusing multiline expressions


key: no-unreachable

description: Disallow unreachable code after return, throw, continue, and break statements


key: no-unsafe-finally

description: Disallow control flow statements in finally blocks


key: no-unsafe-negation

description: Disallow negating the left operand of relational operators


key: use-isnan

description: Require calls to isNaN() when checking for NaN


key: valid-jsdoc

description: Enforce valid JSDoc comments


key: valid-typeof

description: Enforce comparing typeof expressions against valid strings


key: accessor-pairs

description: Enforce getter and setter pairs in objects


key: array-callback-return

description: Enforce return statements in callbacks of array methods


key: block-scoped-var

description: Enforce the use of variables within the scope they are defined


key: class-methods-use-this

description: Enforce that class methods utilize this


key: complexity

description: Enforce a maximum cyclomatic complexity allowed in a program


key: consistent-return

description: Require return statements to either always or never specify values


key: curly

description: Enforce consistent brace style for all control statements


key: default-case

description: Require default cases in switch statements


key: dot-location

description: Enforce consistent newlines before and after dots


key: dot-notation

description: Enforce dot notation whenever possible


key: eqeqeq

description: Require the use of === and !==


key: guard-for-in

description: Require for-in loops to include an if statement


key: no-alert

description: Disallow the use of alert, confirm, and prompt


key: no-caller

description: Disallow the use of arguments.caller or arguments.callee


key: no-case-declarations

description: Disallow lexical declarations in case clauses


key: no-div-regex

description: Disallow division operators explicitly at the beginning of regular expressions


key: no-else-return

description: Disallow else blocks after return statements in if statements


key: no-empty-function

description: Disallow empty functions


key: no-empty-pattern

description: Disallow empty destructuring patterns


key: no-eq-null

description: Disallow null comparisons without type-checking operators


key: no-eval

description: Disallow the use of eval()


key: no-extend-native

description: Disallow extending native types


key: no-extra-bind

description: Disallow unnecessary calls to .bind()


key: no-extra-label

description: Disallow unnecessary labels


key: no-fallthrough

description: Disallow fallthrough of case statements


key: no-floating-decimal

description: Disallow leading or trailing decimal points in numeric literals


key: no-global-assign

description: Disallow assignments to native objects or read-only global variables


key: no-implicit-coercion

description: Disallow shorthand type conversions


key: no-implicit-globals

description: Disallow var and named function declarations in the global scope


key: no-implied-eval

description: Disallow the use of eval()-like methods


key: no-invalid-this

description: Disallow this keywords outside of classes or class-like objects


key: no-iterator

description: Disallow the use of the __iterator__ property


key: no-labels

description: Disallow labeled statements


key: no-lone-blocks

description: Disallow unnecessary nested blocks


key: no-loop-func

description: Disallow function declarations and expressions inside loop statements


key: no-magic-numbers

description: Disallow magic numbers


key: no-multi-spaces

description: Disallow multiple spaces


key: no-multi-str

description: Disallow multiline strings


key: no-new

description: Disallow new operators outside of assignments or comparisons


key: no-new-func

description: Disallow new operators with the Function object


key: no-new-wrappers

description: Disallow new operators with the String, Number, and Boolean objects


key: no-octal

description: Disallow octal literals


key: no-octal-escape

description: Disallow octal escape sequences in string literals


key: no-param-reassign

description: Disallow reassigning function parameters


key: no-proto

description: Disallow the use of the __proto__ property


key: no-redeclare

description: Disallow var redeclaration


key: no-restricted-properties

description: Disallow certain properties on certain objects


key: no-return-assign

description: Disallow assignment operators in return statements


key: no-return-await

description: Disallow unnecessary return await


key: no-script-url

description: Disallow javascript: urls


key: no-self-assign

description: Disallow assignments where both sides are exactly the same


key: no-self-compare

description: Disallow comparisons where both sides are exactly the same


key: no-sequences

description: Disallow comma operators


key: no-throw-literal

description: Disallow throwing literals as exceptions


key: no-unmodified-loop-condition

description: Disallow unmodified loop conditions


key: no-unused-expressions

description: Disallow unused expressions


key: no-unused-labels

description: Disallow unused labels


key: no-useless-call

description: Disallow unnecessary calls to .call() and .apply()


key: no-useless-concat

description: Disallow unnecessary concatenation of literals or template literals


key: no-useless-escape

description: Disallow unnecessary escape characters


key: no-useless-return

description: Disallow redundant return statements


key: no-void

description: Disallow void operators


key: no-warning-comments

description: Disallow specified warning terms in comments


key: no-with

description: Disallow with statements


key: prefer-promise-reject-errors

description: Require using Error objects as Promise rejection reasons


key: radix

description: Enforce the consistent use of the radix argument when using parseInt()


key: require-await

description: Disallow async functions which have no await expression


key: vars-on-top

description: Require var declarations be placed at the top of their containing scope


key: wrap-iife

description: Require parentheses around immediate function invocations


key: yoda

description: Require or Disallow "Yoda" conditions


key: strict

description: require or disallow strict mode directives


key: init-declarations

description: Require or disallow initialization in var declarations


key: no-catch-shadow

description: Disallow catch clause parameters from shadowing variables in the outer scope


key: no-delete-var

description: Disallow deleting variables


key: no-label-var

description: Disallow labels that share a name with a variable


key: no-restricted-globals

description: Disallow specified global variables


key: no-shadow

description: Disallow var declarations from shadowing variables in the outer scope


key: no-shadow-restricted-names

description: Disallow identifiers from shadowing restricted names


key: no-undef

description: Disallow the use of undeclared variables unless mentioned in /*global */ comments


key: no-undefined

description: Disallow the use of undefined as an identifier


key: no-undef-init

description: Disallow initializing variables to undefined


key: no-unused-vars

description: Disallow unused variables


key: no-use-before-define

description: Disallow the use of variables before they are defined


key: callback-return

description: Require return statements after callbacks


key: global-require

description: Require require() calls to be placed at top-level module scope


key: handle-callback-err

description: Require error handling in callbacks


key: no-buffer-constructor

description: Disallow use of the Buffer() constructor


key: no-mixed-requires

description: Disallow require calls to be mixed with regular var declarations


key: no-new-require

description: Disallow new operators with calls to require


key: no-path-concat

description: Disallow string concatenation with __dirname and __filename


key: no-process-env

description: Disallow the use of process.env


key: no-process-exit

description: Disallow the use of process.exit()


key: no-restricted-modules

description: Disallow specified modules when loaded by require


key: no-sync

description: Disallow synchronous methods


key: array-bracket-newline

description: Enforce line breaks after opening and before closing array brackets


key: array-bracket-spacing

description: Enforce consistent spacing inside array brackets


key: array-element-newline

description: Enforce line breaks after each array element


key: block-spacing

description: Enforce consistent spacing inside single-line blocks


key: brace-style

description: Enforce consistent brace style for blocks


key: camelcase

description: Enforce camelcase naming convention


key: capitalized-comments

description: Enforce or disallow capitalization of the first letter of a comment


key: comma-dangle

description: Require or disallow trailing commas


key: comma-spacing

description: Enforce consistent spacing before and after commas


key: comma-style

description: Enforce consistent comma style


key: computed-property-spacing

description: Enforce consistent spacing inside computed property brackets


key: consistent-this

description: Enforce consistent naming when capturing the current execution context


key: eol-last

description: Enforce at least one newline at the end of files


key: func-call-spacing

description: Require or disallow spacing between function identifiers and their invocations


key: func-name-matching

description: Require function names to match the name of the variable or property to which they are assigned


key: func-names

description: Require or disallow named function expressions


key: func-style

description: Enforce the consistent use of either function declarations or expressions


key: function-call-argument-newline

description: Enforce line breaks between arguments of a function call


key: function-paren-newline

description: Enforce consistent line breaks inside function parentheses


key: id-blacklist

description: Disallow specified identifiers


key: id-length

description: Enforce minimum and maximum identifier lengths


key: id-match

description: Require identifiers to match a specified regular expression


key: implicit-arrow-linebreak

description: Enforce the location of arrow function bodies


key: indent

description: Enforce consistent indentation


key: indent-legacy

description: Enforce consistent indentation (legacy, deprecated)


key: jsx-quotes

description: Enforce the consistent use of either double or single quotes in JSX attributes


key: key-spacing

description: Enforce consistent spacing between keys and values in object literal properties


key: keyword-spacing

description: Enforce consistent spacing before and after keywords


key: line-comment-position

description: Enforce position of line comments


key: lines-between-class-members

description: Require or disallow an empty line between class members


key: linebreak-style

description: Enforce consistent linebreak style


key: lines-around-comment

description: Require empty lines around comments


key: lines-around-directive

description: Require or disallow newlines around directives


key: max-depth

description: Enforce a maximum depth that blocks can be nested


key: max-len

description: Enforce a maximum line length


key: max-lines

description: Enforce a maximum number of lines per file


key: max-nested-callbacks

description: Enforce a maximum depth that callbacks can be nested


key: max-params

description: Enforce a maximum number of parameters in function definitions


key: max-statements

description: Enforce a maximum number of statements allowed in function blocks


key: max-statements-per-line

description: Enforce a maximum number of statements allowed per line


key: multiline-comment-style

description: Enforce a particular style for multiline comments


key: multiline-ternary

description: Enforce newlines between operands of ternary expressions


key: new-cap

description: Require constructor function names to begin with a capital letter


key: newline-after-var

description: Require or disallow an empty line after var declarations


key: newline-before-return

description: Require an empty line before return statements


key: newline-per-chained-call

description: Require a newline after each call in a method chain


key: new-parens

description: Require parentheses when invoking a constructor with no arguments


key: no-array-constructor

description: Disallow Array constructors


key: no-bitwise

description: Disallow bitwise operators


key: no-continue

description: Disallow continue statements


key: no-inline-comments

description: Disallow inline comments after code


key: no-lonely-if

description: Disallow if statements as the only statement in else blocks


key: no-mixed-operators

description: Disallow mixed binary operators


key: no-mixed-spaces-and-tabs

description: Disallow mixed spaces and tabs for indentation


key: no-multi-assign

description: Disallow use of chained assignment expressions


key: no-multiple-empty-lines

description: Disallow multiple empty lines


key: no-negated-condition

description: Disallow negated conditions


key: no-nested-ternary

description: Disallow nested ternary expressions


key: no-new-object

description: Disallow Object constructors


key: no-plusplus

description: Disallow the unary operators ++ and --


key: no-restricted-syntax

description: Disallow specified syntax


key: no-tabs

description: Disallow tabs in file


key: no-ternary

description: Disallow ternary operators


key: no-trailing-spaces

description: Disallow trailing whitespace at the end of lines


key: no-underscore-dangle

description: Disallow dangling underscores in identifiers


key: no-unneeded-ternary

description: Disallow ternary operators when simpler alternatives exist


key: no-whitespace-before-property

description: Disallow whitespace before properties


key: nonblock-statement-body-position

description: Enforce the location of single-line statements


key: object-curly-newline

description: Enforce consistent line breaks inside braces


key: object-curly-spacing

description: Enforce consistent spacing inside braces


key: object-property-newline

description: Enforce placing object properties on separate lines


key: one-var

description: Enforce variables to be declared either together or separately in functions


key: one-var-declaration-per-line

description: Require or disallow newlines around var declarations


key: operator-assignment

description: Require or disallow assignment operator shorthand where possible


key: operator-linebreak

description: Enforce consistent linebreak style for operators


key: padded-blocks

description: Require or disallow padding within blocks


key: padding-line-between-statements

description: Require or disallow padding lines between statements


key: quote-props

description: Require quotes around object literal property names


key: quotes

description: Enforce the consistent use of either backticks, double, or single quotes


key: require-jsdoc

description: Require JSDoc comments


key: semi

description: Require or disallow semicolons instead of ASI


key: semi-spacing

description: Enforce consistent spacing before and after semicolons


key: semi-style

description: Enforce location of semicolons


key: sort-keys

description: Requires object keys to be sorted


key: sort-vars

description: Require variables within the same declaration block to be sorted


key: space-before-blocks

description: Enforce consistent spacing before blocks


key: space-before-function-paren

description: Enforce consistent spacing before function definition opening parenthesis


key: spaced-comment

description: Enforce consistent spacing after the // or /* in a comment


key: space-infix-ops

description: Require spacing around operators


key: space-in-parens

description: Enforce consistent spacing inside parentheses


key: space-unary-ops

description: Enforce consistent spacing before or after unary operators


key: switch-colon-spacing

description: Enforce spacing around colons of switch statements


key: template-tag-spacing

description: Require or disallow spacing between template tags and their literals


key: unicode-bom

description: Require or disallow Unicode byte order mark (BOM)


key: wrap-regex

description: Require parenthesis around regex literals


key: arrow-body-style

description: Require braces around arrow function bodies


key: arrow-parens

description: Require parentheses around arrow function arguments


key: arrow-spacing

description: Enforce consistent spacing before and after the arrow in arrow functions


key: constructor-super

description: Require super() calls in constructors


key: generator-star-spacing

description: Enforce consistent spacing around * operators in generator functions


key: no-class-assign

description: Disallow reassigning class members


key: no-confusing-arrow

description: Disallow arrow functions where they could be confused with comparisons


key: no-const-assign

description: Disallow reassigning const variables


key: no-dupe-class-members

description: Disallow duplicate class members


key: no-duplicate-imports

description: Disallow duplicate module imports


key: no-new-symbol

description: Disallow new operators with the Symbol object


key: no-restricted-imports

description: Disallow specified modules when loaded by import


key: no-this-before-super

description: Disallow this/super before calling super() in constructors


key: no-useless-computed-key

description: Disallow unnecessary computed property keys in object literals


key: no-useless-constructor

description: Disallow unnecessary constructors


key: no-useless-rename

description: Disallow renaming import, export, and destructured assignments to the same name


key: no-var

description: Require let or const instead of var


key: object-shorthand

description: Require or disallow method and property shorthand syntax for object literals


key: prefer-arrow-callback

description: Require arrow functions as callbacks


key: prefer-const

description: Require const declarations for variables that are never reassigned after declared


key: prefer-destructuring

description: Require destructuring from arrays and/or objects


key: prefer-numeric-literals

description: Disallow parseInt() in favor of binary, octal, and hexadecimal literals


key: prefer-reflect

description: Require Reflect methods where applicable


key: prefer-rest-params

description: Require rest parameters instead of arguments


key: prefer-spread

description: Require spread operators instead of .apply()


key: prefer-template

description: Require template literals instead of string concatenation


key: require-yield

description: Require generator functions to contain yield


key: rest-spread-spacing

description: Enforce spacing between rest and spread operators and their expressions


key: sort-imports

description: Enforce sorted import declarations within modules


key: symbol-description

description: Require symbol descriptions


key: template-curly-spacing

description: Require or disallow spacing around embedded expressions of template strings


key: yield-star-spacing

description: Require or disallow spacing around the * in yield* expressions


key: ecmaFeatures

description: By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.


key: experimentalObjectRestSpread

description: Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)


key: globalReturn

description: allow return statements in the global scope


key: impliedStrict

description: enable global strict mode (if ecmaVersion is 5 or greater)


key: jsx

description: enable JSX


key: env

description: An environment defines global variables that are predefined.


key: amd

description: defines require() and define() as global variables as per the amd spec


key: applescript

description: AppleScript global variables


key: atomtest

description: Atom test helper globals


key: browser

description: browser global variables


key: commonjs

description: CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)


key: shared-node-browser

description: Globals common to both Node and Browser


key: embertest

description: Ember test helper globals


description: enable all ECMAScript 6 features except for modules


key: greasemonkey

description: GreaseMonkey globals


key: jasmine

description: adds all of the Jasmine testing global variables for version 1.3 and 2.0


key: jest

description: Jest global variables


key: jquery

description: jQuery global variables


key: meteor

description: Meteor global variables


key: mocha

description: adds all of the Mocha test global variables


key: mongo

description: MongoDB global variables


key: nashorn

description: Java 8 Nashorn global variables


key: node

description: Node.js global variables and Node.js scoping


key: phantomjs

description: PhantomJS global variables


key: prototypejs

description: Prototype.js global variables


key: protractor

description: Protractor global variables


key: qunit

description: QUnit global variables


key: serviceworker

description: Service Worker global variables


key: shelljs

description: ShellJS global variables


key: webextensions

description: WebExtensions globals


key: worker

description: web workers global variables


key: extends

description: If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.


key: globals

description: Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.

enum: readonly writable off


key: additionalProperties

description: The values false|"readable" and true|"writeable" are deprecated, they are equivalent to "readonly" and "writable", respectively.


key: noInlineConfig

description: Prevent comments from changing config or rules


key: parserOptions

description: The JavaScript language options to be supported

enum: script module

default: script


key: ecmaVersion

description: Set to 3, 5, 6, 7, 8, 9, 10, 11 (default), 12, 13, 14 or "latest" to specify the version of ECMAScript syntax you want to use. You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13) or 2023 (same as 14) to use the year-based naming. "latest" always enables the latest supported ECMAScript version.


key: sourceType

description: set to "script" (default) or "module" if your code is in ECMAScript modules


key: plugins

description: ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.


key: root

description: By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.


key: ignorePatterns

description: Tell ESLint to ignore specific files and directories. Each value uses the same pattern as the `.eslintignore` file.


key: rules

description: ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.


key: settings

description: ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.


key: overrides

description: Allows to override configuration for files and folders, specified by glob patterns


key: files

description: Glob pattern for files to apply 'overrides' configuration, relative to the directory of the config file


key: excludedFiles

description: If a file matches any of the 'excludedFiles' glob patterns, the 'overrides' configuration won't apply


key: processor

description: To specify a processor, specify the plugin name and processor name joined by a forward slash


Any property starting with 'x_' is valid.


key: version

description: File version (always the first entry in the object) and must be a positive integer.


key: file

description: An optional name of the generated code that this source map is associated with.


key: sourceRoot

description: An optional source root, useful for relocating source files on a server or removing repeated values in the 'sources' entry.  This value is prepended to the individual entries in the 'source' field.


key: sources

description: A list of original sources used by the 'mappings' entry.


key: sourcesContent

description: An optional list of source content, useful when the 'source' can�t be hosted. The contents are listed in the same order as the sources in line 5. 'null' may be used if some original sources should be retrieved by name.


key: names

description: A list of symbol names used by the 'mappings' entry.


key: mappings

description: A string with the encoded mapping data.


description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema: a standard format for the output of static analysis tools.

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

format: date-time

required: artifactLocation replacements

format: uri-reference

required: configuration descriptor

required: id sourceNodeId targetNodeId

format: uri

enum: notApplicable pass fail review open informational


key: address

description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).


key: absoluteAddress

description: The address expressed as a byte offset from the start of the addressable region.


key: relativeAddress

description: The address expressed as a byte offset from the absolute address of the top-most parent object.


key: length

description: The number of bytes in this range of addresses.


key: kind

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.


key: name

description: A name that is associated with the address, e.g., '.text'.


key: fullyQualifiedName

description: A human-readable fully qualified name that is associated with the address.


key: offsetFromParent

description: The byte offset of this address from the absolute or relative address of the parent object.


key: index

description: The index within run.addresses of the cached object for this address.


key: parentIndex

description: The index within run.addresses of the parent object.


key: properties

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


key: artifact

description: A single artifact. In some cases, this artifact might be nested within another artifact.


key: description

description: A short description of the artifact.


key: location

description: The location of the artifact.


description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.


key: offset

description: The offset in bytes of the artifact within its containing artifact.


description: The length of the artifact in bytes.


key: roles

description: The role or roles played by the artifact in the analysis.


key: mimeType

description: The MIME type (RFC 2045) of the artifact.


key: contents

description: The contents of the artifact.


key: encoding

description: Specifies the encoding for an artifact object that refers to a text file.


key: sourceLanguage

description: Specifies the source language for any artifact object that refers to a text file that contains source code.


key: hashes

description: A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.


key: lastModifiedTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.


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


key: artifactChange

description: A change to a single artifact.


key: artifactLocation

description: The location of the artifact to change.


key: replacements

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.


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


key: artifactContent

description: Represents the contents of an artifact.


key: text

description: UTF-8-encoded content from a text artifact.


key: binary

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.


key: rendered

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).


key: properties

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


description: Specifies the location of an artifact.


key: uri

description: A string containing a valid relative or absolute URI.


key: uriBaseId

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.


key: index

description: The index within the run artifacts array of the artifact object associated with the artifact location.


key: description

description: A short description of the artifact location.


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


key: attachment

description: An artifact relevant to a result.


description: A message describing the role played by the attachment.


description: The location of the attachment.


key: regions

description: An array of regions of interest within the attachment.


key: rectangles

description: An array of rectangles specifying areas of interest within the image.


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


key: codeFlow

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.


key: message

description: A message relevant to the code flow.


key: threadFlows

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.


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


key: configurationOverride

description: Information about how a specific rule or notification was reconfigured at runtime.


key: configuration

description: Specifies how the rule or notification was configured during the scan.


key: descriptor

description: A reference used to locate the descriptor whose configuration was overridden.


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


key: conversion

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.


key: tool

description: A tool object that describes the converter.


key: invocation

description: An invocation object that describes the invocation of the converter.


key: analysisToolLogFiles

description: The locations of the analysis tool's per-run log files.


key: properties

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


key: edge

description: Represents a directed edge in a graph.


key: id

description: A string that uniquely identifies the edge within its graph.


key: label

description: A short description of the edge.


key: sourceNodeId

description: Identifies the source node (the node at which the edge starts).


key: targetNodeId

description: Identifies the target node (the node at which the edge ends).


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


key: edgeTraversal

description: Represents the traversal of a single edge during a graph traversal.


key: edgeId

description: Identifies the edge being traversed.


key: message

description: A message to display to the user as the edge is traversed.


key: finalState

description: The values of relevant expressions after the edge has been traversed.


key: stepOverEdgeCount

description: The number of edge traversals necessary to return from a nested graph.


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


key: kind

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.


description: A message that describes the exception.


key: stack

description: The sequence of function calls leading to the exception.


key: innerExceptions

description: An array of exception objects each of which is considered a cause of this exception.


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


key: schema

description: The URI of the JSON schema corresponding to the version of the external property file format.


key: version

description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with a separate run.


key: graphs

description: An array of graph objects that will be merged with a separate run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with a separate run.


key: artifacts

description: An array of artifact objects that will be merged with a separate run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with a separate run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with a separate run.


key: results

description: An array of result objects that will be merged with a separate run.


key: taxonomies

description: Tool taxonomies that will be merged with a separate run.


key: driver

description: The analysis tool object that will be merged with a separate run.


key: extensions

description: Tool extensions that will be merged with a separate run.


key: policies

description: Tool policies that will be merged with a separate run.


key: translations

description: Tool translations that will be merged with a separate run.


key: addresses

description: Addresses that will be merged with a separate run.


key: webRequests

description: Requests that will be merged with a separate run.


key: webResponses

description: Responses that will be merged with a separate run.


key: properties

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


key: location

description: The location of the external property file.


key: guid

description: A stable, unique identifier for the external property file in the form of a GUID.


key: itemCount

description: A non-negative integer specifying the number of items contained in the external property file.


description: Key/value pairs that provide additional information about the external property file.


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: conversion

description: An external property file containing a run.conversion object to be merged with the root log file.


key: graphs

description: An array of external property files containing a run.graphs object to be merged with the root log file.


key: externalizedProperties

description: An external property file containing a run.properties object to be merged with the root log file.


key: artifacts

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.


key: invocations

description: An array of external property files containing run.invocations arrays to be merged with the root log file.


key: logicalLocations

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.


key: threadFlowLocations

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.


key: results

description: An array of external property files containing run.results arrays to be merged with the root log file.


key: taxonomies

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.


key: addresses

description: An array of external property files containing run.addresses arrays to be merged with the root log file.


key: driver

description: An external property file containing a run.driver object to be merged with the root log file.


key: extensions

description: An array of external property files containing run.extensions arrays to be merged with the root log file.


key: policies

description: An array of external property files containing run.policies arrays to be merged with the root log file.


key: translations

description: An array of external property files containing run.translations arrays to be merged with the root log file.


key: webRequests

description: An array of external property files containing run.requests arrays to be merged with the root log file.


key: webResponses

description: An array of external property files containing run.responses arrays to be merged with the root log file.


key: properties

description: Key/value pairs that provide additional information about the external property files.


key: fix

description: A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.


key: description

description: A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.


key: artifactChanges

description: One or more artifact changes that comprise a fix for a result.


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


key: graph

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).


description: A description of the graph.


key: nodes

description: An array of node objects representing the nodes of the graph.


key: edges

description: An array of edge objects representing the edges of the graph.


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


key: graphTraversal

description: Represents a path through a graph.


key: runGraphIndex

description: The index within the run.graphs to be associated with the result.


key: resultGraphIndex

description: The index within the result.graphs to be associated with the result.


description: A description of this graph traversal.


key: initialState

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.


key: immutableState

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.


key: edgeTraversals

description: The sequences of edges traversed by this graph traversal.


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


key: invocation

description: The runtime environment of the analysis tool run.


key: commandLine

description: The command line used to invoke the tool.


key: arguments

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.


key: responseFiles

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


key: startTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.


key: endTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.


key: exitCode

description: The process exit code.


key: ruleConfigurationOverrides

description: An array of configurationOverride objects that describe rules related runtime overrides.


key: notificationConfigurationOverrides

description: An array of configurationOverride objects that describe notifications related runtime overrides.


key: toolExecutionNotifications

description: A list of runtime conditions detected by the tool during the analysis.


key: toolConfigurationNotifications

description: A list of conditions detected by the tool that are relevant to the tool's configuration.


key: exitCodeDescription

description: The reason for the process exit.


key: exitSignalName

description: The name of the signal that caused the process to exit.


key: exitSignalNumber

description: The numeric value of the signal that caused the process to exit.


key: processStartFailureMessage

description: The reason given by the operating system that the process failed to start.


key: executionSuccessful

description: Specifies whether the tool's execution completed successfully.


key: machine

description: The machine that hosted the analysis tool run.


key: account

description: The account that ran the analysis tool.


key: processId

description: The process id for the analysis tool run.


key: executableLocation

description: An absolute URI specifying the location of the analysis tool's executable.


key: workingDirectory

description: The working directory for the analysis tool run.


key: environmentVariables

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


key: stdin

description: A file containing the standard input stream to the process that was invoked.


key: stdout

description: A file containing the standard output stream from the process that was invoked.


key: stderr

description: A file containing the standard error stream from the process that was invoked.


key: stdoutStderr

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.


key: properties

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


key: location

description: A location within a programming artifact.


key: id

description: Value that distinguishes this location from all other locations within a single result object.


key: physicalLocation

description: Identifies the artifact and region.


key: logicalLocations

description: The logical locations associated with the result.


key: message

description: A message relevant to the location.


key: annotations

description: A set of regions relevant to the location.


key: relationships

description: An array of objects that describe relationships between this location and others.


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


key: locationRelationship

description: Information about the relation of one location to another.


key: target

description: A reference to the related location.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.


key: description

description: A description of the location relationship.


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


key: logicalLocation

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


key: name

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


key: index

description: The index within the logical locations array.


key: fullyQualifiedName

description: The human-readable fully qualified name of the logical location.


key: decoratedName

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.


key: parentIndex

description: Identifies the index 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.


key: kind

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.


key: properties

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


description: Encapsulates a message intended to be read by the end user.


key: text

description: A plain text message string.


key: markdown

description: A Markdown message string.


key: id

description: The identifier for this message.


key: arguments

description: An array of strings to substitute into the message string.


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


key: multiformatMessageString

description: A message string or message format string rendered in multiple formats.


description: A plain text message string or format string.


description: A Markdown message string or format string.


key: node

description: Represents a node in a graph.


description: A string that uniquely identifies the node within its graph.


key: label

description: A short description of the node.


key: location

description: A code location associated with the node.


key: children

description: Array of child nodes.


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


key: notification

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

default: warning

enum: none note warning error


key: locations

description: The locations relevant to this notification.


key: message

description: A message that describes the condition that was encountered.


key: level

description: A value specifying the severity level of the notification.


key: threadId

description: The thread identifier of the code that generated the notification.


key: timeUtc

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.


key: exception

description: The runtime exception, if any, relevant to this notification.


key: descriptor

description: A reference used to locate the descriptor relevant to this notification.


key: associatedRule

description: A reference used to locate the rule descriptor associated with this notification.


key: properties

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


key: physicalLocation

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.


key: address

description: The address of the location.


key: artifactLocation

description: The location of the artifact.


key: region

description: Specifies a portion of the artifact.


key: contextRegion

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.


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


key: propertyBag

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


key: tags

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


key: rectangle

description: An area within an image.


key: top

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.


key: left

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.


key: bottom

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.


key: right

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.


key: message

description: A message relevant to the rectangle.


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


description: A region within an artifact where a result was detected.


key: startLine

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


key: startColumn

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


key: endLine

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


key: endColumn

description: The column number of the character following the end of the region.


key: charOffset

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


key: charLength

description: The length of the region in characters.


key: byteOffset

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


key: byteLength

description: The length of the region in bytes.


key: snippet

description: The portion of the artifact contents within the specified region.


description: A message relevant to the region.


key: sourceLanguage

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.


key: properties

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


key: replacement

description: The replacement of a single region of an artifact.


key: deletedRegion

description: The region of the artifact to delete.


key: insertedContent

description: The content to insert at the location specified by the 'deletedRegion' property.


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


key: reportingDescriptor

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.


key: id

description: A stable, opaque identifier for the report.


key: deprecatedIds

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.


key: guid

description: A unique identifier for the reporting descriptor in the form of a GUID.


key: deprecatedGuids

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.


key: name

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


key: deprecatedNames

description: An array of readable identifiers by which this report was known in some previous version of the analysis tool.


key: shortDescription

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


key: fullDescription

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


key: messageStrings

description: A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: defaultConfiguration

description: Default reporting configuration information.


key: helpUri

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


key: help

description: Provides the primary documentation for the report, useful when there is no online documentation.


key: relationships

description: An array of objects that describe relationships between this reporting descriptor and others.


key: properties

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


key: reportingConfiguration

description: Information about a rule or notification that can be configured at runtime.


key: enabled

description: Specifies whether the report may be produced during the scan.


key: level

description: Specifies the failure level for the report.


key: rank

description: Specifies the relative priority of the report. Used for analysis output only.


key: parameters

description: Contains configuration information specific to a report.


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


key: reportingDescriptorReference

description: Information about how to locate a relevant reporting descriptor.


key: id

description: The id of the descriptor.


key: index

description: The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.


key: guid

description: A guid that uniquely identifies the descriptor.


key: toolComponent

description: A reference used to locate the toolComponent associated with the descriptor.


description: Key/value pairs that provide additional information about the reporting descriptor reference.


key: reportingDescriptorRelationship

description: Information about the relation of one reporting descriptor to another.


key: target

description: A reference to the related reporting descriptor.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.


key: description

description: A description of the reporting descriptor relationship.


key: result

description: A result produced by an analysis tool.

default: fail

enum: new unchanged updated absent


key: ruleId

description: The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.


key: ruleIndex

description: The index within the tool component rules array of the rule object associated with this result.


key: rule

description: A reference used to locate the rule descriptor relevant to this result.


key: kind

description: A value that categorizes results by evaluation state.


key: level

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


key: message

description: A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.


key: analysisTarget

description: Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.


key: locations

description: The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.


description: A stable, unique identifier for the result in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.


key: occurrenceCount

description: A positive integer specifying the number of times this logically unique result was observed in this run.


key: partialFingerprints

description: A set of strings that contribute to the stable, unique identity of the result.


key: fingerprints

description: A set of strings each of which individually defines a stable, unique identity for the result.


key: stacks

description: An array of 'stack' objects relevant to the result.


key: codeFlows

description: An array of 'codeFlow' objects relevant to the result.


key: graphs

description: An array of zero or more unique graph objects associated with the result.


key: graphTraversals

description: An array of one or more unique 'graphTraversal' objects.


key: relatedLocations

description: A set of locations relevant to this result.


key: suppressions

description: A set of suppressions relevant to this result.


key: baselineState

description: The state of a result relative to a baseline of a previous run.


key: rank

description: A number representing the priority or importance of the result.


key: attachments

description: A set of artifacts relevant to the result.


key: hostedViewerUri

description: An absolute URI at which the result can be viewed.


key: workItemUris

description: The URIs of the work items associated with this result.


key: provenance

description: Information about how and when the result was detected.


key: fixes

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.


key: taxa

description: An array of references to taxonomy reporting descriptors that are applicable to the result.


key: webRequest

description: A web request associated with this result.


key: webResponse

description: A web response associated with this result.


key: properties

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


key: resultProvenance

description: Contains information about how and when a result was detected.


key: firstDetectionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.


key: lastDetectionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.


key: firstDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.


key: lastDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.


key: invocationIndex

description: The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.


key: conversionSources

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.


key: run

description: Describes a single run of an analysis tool, and contains the reported output of that run.

default: en-US


key: tool

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.


key: invocations

description: Describes the invocation of the analysis tool.


key: conversion

description: A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: versionControlProvenance

description: Specifies the revision in version control of the artifacts that were scanned.


key: originalUriBaseIds

description: The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.


key: artifacts

description: An array of artifact objects relevant to the run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions.


key: graphs

description: An array of zero or more unique graph objects associated with the run.


key: results

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.


key: automationDetails

description: Automation details that describe this run.


key: runAggregates

description: Automation details that describe the aggregate of runs to which this run belongs.


key: baselineGuid

description: The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.


key: redactionTokens

description: An array of strings used to replace sensitive information in a redaction-aware property.


key: defaultEncoding

description: Specifies the default encoding for any artifact object that refers to a text file.


key: defaultSourceLanguage

description: Specifies the default source language for any artifact object that refers to a text file that contains source code.


key: newlineSequences

description: An ordered list of character sequences that were treated as line breaks when computing region information for the run.


key: columnKind

description: Specifies the unit in which the tool measures columns.


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: threadFlowLocations

description: An array of threadFlowLocation objects cached at run level.


key: taxonomies

description: An array of toolComponent objects relevant to a taxonomy in which results are categorized.


key: addresses

description: Addresses associated with this run instance, if any.


key: translations

description: The set of available translations of the localized data provided by the tool.


key: policies

description: Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).


key: webRequests

description: An array of request objects cached at run level.


key: webResponses

description: An array of response objects cached at run level.


key: specialLocations

description: A specialLocations object that defines locations of special significance to SARIF consumers.


key: properties

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


key: runAutomationDetails

description: Information that describes a run's identity and role within an engineering system process.


key: description

description: A description of the identity and role played within the engineering system by this object's containing run object.


key: id

description: A hierarchical string that uniquely identifies this object's containing run object.


key: guid

description: A stable, unique identifier for this object's containing run object in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.


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


description: Defines locations of special significance to SARIF consumers.


key: displayBase

description: Provides a suggestion to SARIF consumers to display file paths relative to the specified location.


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


key: stack

description: A call stack that is relevant to a result.


key: message

description: A message relevant to this call stack.


key: frames

description: An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.


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


key: stackFrame

description: A function call within a stack trace.


key: location

description: The location to which this stack frame refers.


key: module

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


key: threadId

description: The thread identifier of the stack frame.


key: parameters

description: The parameters of the call that is executing.


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


key: suppression

description: A suppression that is relevant to a result.

enum: inSource external

enum: accepted underReview rejected


description: A stable, unique identifier for the suppression in the form of a GUID.


key: kind

description: A string that indicates where the suppression is persisted.


key: state

description: A string that indicates the state of the suppression.


key: justification

description: A string representing the justification for the suppression.


description: Identifies the location associated with the suppression.


key: properties

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


key: id

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.


description: A message relevant to the thread flow.


key: initialState

description: Values of relevant expressions at the start of the thread flow that may change during thread flow execution.


key: immutableState

description: Values of relevant expressions at the start of the thread flow that remain constant.


key: locations

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.


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


key: threadFlowLocation

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

enum: important essential unimportant

default: important


key: index

description: The index within the run threadFlowLocations array.


description: The code location.


key: stack

description: The call stack leading to this location.


key: kinds

description: A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.


key: taxa

description: An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.


key: module

description: The name of the module that contains the code that is executing.


description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.


key: nestingLevel

description: An integer representing a containment hierarchy within the thread flow.


key: executionOrder

description: An integer representing the temporal order in which execution reached this location.


key: executionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which this location was executed.


key: importance

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".


key: webRequest

description: A web request associated with this thread flow location.


key: webResponse

description: A web response associated with this thread flow location.


key: properties

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


key: tool

description: The analysis tool that was run.


key: driver

description: The analysis tool that was run.


key: extensions

description: Tool extensions that contributed to or reconfigured the analysis tool that was run.


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


key: toolComponent

description: A component, such as a plug-in or the driver, of the analysis tool that was run.

default: localizedData nonLocalizedData

enum: localizedData nonLocalizedData


key: guid

description: A unique identifier for the tool component in the form of a GUID.


key: name

description: The name of the tool component.


key: organization

description: The organization or company that produced the tool component.


key: product

description: A product suite to which the tool component belongs.


key: productSuite

description: A localizable string containing the name of the suite of products to which the tool component belongs.


key: shortDescription

description: A brief description of the tool component.


key: fullDescription

description: A comprehensive description of the tool component.


key: fullName

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


key: version

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


key: semanticVersion

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


key: dottedQuadFileVersion

description: The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).


key: releaseDateUtc

description: A string specifying the UTC date (and optionally, the time) of the component's release.


key: downloadUri

description: The absolute URI from which the tool component can be downloaded.


key: informationUri

description: The absolute URI at which information about this version of the tool component can be found.


key: globalMessageStrings

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: notifications

description: An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.


key: rules

description: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.


key: taxa

description: An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.


key: locations

description: An array of the artifactLocation objects associated with the tool component.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: contents

description: The kinds of data contained in this object.


key: isComprehensive

description: Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.


key: localizedDataSemanticVersion

description: The semantic version of the localized strings defined in this component; maintained by components that provide translations.


description: The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.


key: associatedComponent

description: The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.


key: translationMetadata

description: Translation metadata, required for a translation, not populated by other component types.


key: supportedTaxonomies

description: An array of toolComponentReference objects to declare the taxonomies supported by the tool component.


key: properties

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


key: toolComponentReference


key: name

description: The 'name' property of the referenced toolComponent.


key: index

description: An index into the referenced toolComponent in tool.extensions.


key: guid

description: The 'guid' property of the referenced toolComponent.


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


description: Provides additional metadata related to translation.


description: The name associated with the translation metadata.


key: fullName

description: The full name associated with the translation metadata.


key: shortDescription

description: A brief description of the translation metadata.


key: fullDescription

description: A comprehensive description of the translation metadata.


key: downloadUri

description: The absolute URI from which the translation metadata can be downloaded.


key: informationUri

description: The absolute URI from which information related to the translation metadata can be downloaded.


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


key: versionControlDetails

description: Specifies the information necessary to retrieve a desired revision from a version control system.


key: repositoryUri

description: The absolute URI of the repository.


key: revisionId

description: A string that uniquely and permanently identifies the revision within the repository.


key: branch

description: The name of a branch containing the revision.


key: revisionTag

description: A tag that has been applied to the revision.


key: asOfTimeUtc

description: A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.


key: mappedTo

description: The location in the local file system to which the root of the repository was mapped at the time of the analysis.


key: properties

description: Key/value pairs that provide additional information about the version control details.


key: webRequest

description: A web request object.


description: The index within the run.webRequests array of the request object associated with this result.


key: protocol

description: The request protocol. Example: 'http'.


key: version

description: The request version. Example: '1.1'.


key: target

description: The target of the request.


key: method

description: The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.


key: headers

description: The request headers.


key: parameters

description: The request parameters.


key: body

description: The body of the request.


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


key: webResponse

description: A web response object.


key: index

description: The index within the run.webResponses array of the response object associated with this result.


description: The response protocol. Example: 'http'.


description: The response version. Example: '1.1'.


key: statusCode

description: The response status code. Example: 451.


key: reasonPhrase

description: The response reason. Example: 'Not found'.


description: The response headers.


description: The body of the response.


key: noResponseReceived

description: Specifies whether a response was received from the server.


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


key: $schema

description: The URI of the JSON schema corresponding to the version.


description: The SARIF format version of this log file.


key: runs

description: The set of runs contained in this log file.


key: inlineExternalProperties

description: References to external property files that share data between runs.


key: properties

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


description: Meltano (https://meltano.com) is an open source platform for building, running & orchestrating ELT pipelines

required: name namespace

examples:
Stripe
Facebook Ads

enum: properties catalog discover state about stream-maps activate-version batch test log-based

enum: about stream-maps activate-version batch soft-delete hard-delete datatype-failsafe record-flattening

required: config name

enum: oauth hidden password date_iso8601 file email integer options object array boolean string


key: name

description: The name of the plugin.


key: namespace

description: The namespace of this plugin


key: label

description: A user friendly label describing the plugin


key: description

description: A description for what the plugin does


key: commands

description: An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable.


key: docs

description: A URL to the documentation for this plugin


key: executable

description: The plugin's executable name, as defined in setup.py (if a Python based plugin)


key: variant

description: The same of the variant.


description: The pip hosted package name or URL


key: repo

description: The URL to the repository where the plugin code lives.


key: items

description: A set consisting of one valid combination of required setting names


description: The name of the variant.


key: metadata

description: An object containing Singer stream and property metadata


key: schema

description: An object representing override rules for a Singer stream schema


key: select

description: An array of entity selection rules in the form '<entity|*>.<attribute|*>'


key: dialect

description: The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.


The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.


key: vars

description: An object containing dbt model variables


The name of the dbt package's internal dbt project: the value of name in dbt_project.yml.


key: mappings

description: Name of the invokable mappings and their associated configs.


description: The name of the setting


key: aliases

description: Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'


description: A user friendly label for the setting


key: value

description: The default value of this setting if not otherwise defined


key: placeholder

description: A placeholder value for this setting


key: kind

description: The type of value this setting contains


key: description

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account


key: tooltip

description: A phrase to provide additional information on this setting


key: documentation

description: A link to documentation on this setting