Lock & Unlock

These actions provide ability to create locks and unlock them for a given id and a domain.

Lock & Unlock Actions

TryLock

Tries creating a lock and returns whether it was successful:

Fields (table)

Field	Definition	Example	Default
Input Element	Json path in payload that has id parameter	parameters	-
Output Element	Json path in payload to return "locked" results	result	-

Fields (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "inputElement": {
          "type": "string",
          "description": "Json path in payload that has id parameter",
          "examples": ["parameters"],
          "default": null
        },
        "outputElement": {
          "type": "string",
          "description": "Json path in payload to return \"locked\" results",
          "examples": ["result"],
          "default": null
        }
      }
    }
  }
}

With the following event metadata parameters:

Parameters (table)

Parameter	Definition	Example	Default
Master	Whether master lock should be used instead of a specific id	true	false
Timeout	Milliseconds to wait for acquiring a lock, overrides default	2000	-
Expiry	TTL in milliseconds for lock expiry, overrides default	10000	-
Allow No Lock	Whether failure to hold a lock should return a successful result, returns locked instead of error	true	false

Parameters (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "master": {
              "type": "boolean",
              "description": "Whether master lock should be used instead of a specific id",
              "examples": [true],
              "default": false
            },
            "timeout": {
              "type": "integer",
              "description": "Milliseconds to wait for acquiring a lock (overrides default)",
              "examples": [2000],
              "default": null
            },
            "expiry": {
              "type": "integer",
              "description": "TTL in milliseconds for lock expiry (overrides default)",
              "examples": [10000],
              "default": null
            },
            "allowNoLock": {
              "type": "boolean",
              "description": "Whether failure to hold a lock should return a successful result (returns \"locked\" value instead of error)",
              "examples": [true],
              "default": false
            }
          }
        }
      }
    }
  }
}

Unlock

Unlocks an existing lock:

Fields (table)

Field	Definition	Example	Default
Input Element	Json path in payload that has id parameter	parameters	-

Fields (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "inputElement": {
          "type": "string",
          "description": "Json path in payload that has id parameter",
          "examples": ["parameters"],
          "default": null
        }
      }
    }
  }
}

With the following event metadata parameters:

Parameters (table)

Parameter	Definition	Example	Default
Master	Whether master lock should be used instead of a specific id	true	false

Parameters (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "master": {
              "type": "boolean",
              "description": "Whether master lock should be used instead of a specific id",
              "examples": [true],
              "default": false
            }
          }
        }
      }
    }
  }
}

CheckLock

Returns the current status for a lock:

Fields (table)

Field	Definition	Example	Default
Input Element	Json path in payload that has id parameter	parameters	-
Output Element	Json path in payload to return "locked" results	result	-

Fields (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "inputElement": {
          "type": "string",
          "description": "Json path in payload that has id parameter",
          "examples": ["parameters"],
          "default": null
        },
        "outputElement": {
          "type": "string",
          "description": "Json path in payload to return \"locked\" results",
          "examples": ["result"],
          "default": null
        }
      }
    }
  }
}

With the following event metadata parameters:

Parameters (table)

Parameter	Definition	Example	Default
Master	Whether master lock should be used instead of a specific id	true	false

Parameters (JSON Schema)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "master": {
              "type": "boolean",
              "description": "Whether master lock should be used instead of a specific id",
              "examples": [true],
              "default": false
            }
          }
        }
      }
    }
  }
}