{
  "synLogic": "int $ret \u003d $api($1, $2, $3, $4);",
  "help": "The ns_kafka_set_message_header() function is used to set a header for a message being sent through a Kafka producer. Headers provide additional metadata about the message that can be used by Kafka consumers to process the message. ",
  "notes": "",
  "returns": "Returns 0 if the header was successfully added, or -1 if an error occurred in C, It returns boolean in Java.",
  "arguments": "\u003ctable class\u003d\"newGuiTable\" style\u003d\"width:100%\"\u003e \u003ctbody\u003e\u003ctr\u003e \u003cth\u003e Argument \u003c/th\u003e \u003cth\u003e Description \u003c/th\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e JPCID \u003c/td\u003e \u003ctd\u003e It is the Connection ID for Java Messaging Service \u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e Error Message \u003c/td\u003e \u003ctd\u003e The name of the message to which the header will be added. \u003c/td\u003e \u003c/tr\u003e  \u003ctr\u003e \u003ctd\u003e Header Name \u003c/td\u003e \u003ctd\u003e The name of the header to be added. \u003c/td\u003e \u003c/tr\u003e  \u003ctr\u003e \u003ctd\u003e Header Value \u003c/td\u003e \u003ctd\u003e The value of the header to be added. \u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e\u003c/table\u003e",
  "parameterization": "",
  "component": [
    {
      "id": "$1",
      "type": "TextField",
      "label": "JMS Pool Connection Id",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "First character must be Alpha.\r\nOther characters are Alpha, Numeric or Underscore",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "If JMS Connection id is a program variable",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,63}$",
        "required": false,
        "min": 0,
        "max": 0,
        "method": "isValidVar(arg)"
      },
      "quotes": false
    },
    {
      "id": "$2",
      "type": "TextField",
      "label": "Error Message Buffer Pointer",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "Enter error message",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "required": true,
        "min": 0,
        "max": 0
      },
      "quotes": false
    },
    {
      "id": "$3",
      "type": "TEXT_VAR",
      "label": "Header Name",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "Enter header name",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "If header name is a program variable",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "required": true,
        "min": 0,
        "max": 0
      },
      "quotes": true
    },
    {
      "id": "$4",
      "type": "TEXT_VAR",
      "label": "Header Value",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "Enter header value",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "If header value is a program variable",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "required": true,
        "min": 0,
        "max": 0
      },
      "quotes": true
    },
    {
      "id": "$ret",
      "type": "TextField",
      "label": "Return Variable",
      "value": "",
      "css": "p-grid p-align-center w-100-p",
      "title": "First character must be Alpha.\r\nOther characters are Alpha, Numeric or Underscore.",
      "placeHolder": "",
      "style": "",
      "isDisabled": "",
      "labelVarCheckbox": "",
      "argIndex": 0,
      "validate": {
        "inputType": "Text",
        "disabled": false,
        "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,63}$",
        "required": false,
        "min": 0,
        "max": 0,
        "method": "isValidVar(arg)"
      },
      "quotes": true
    }
  ],
  "name": "ns_kafka_set_message_header",
  "syntax": "int ns_kafka_set_message_header(int jpcid, char *error_msg, char *header_name, char *header_value);",
  "javaSyntax": "boolean ns_kafka_set_message_header(JMSKey key, String header_name, Object header_value);",
  "cEx": "flow()\n{\n  int jpcid \u003d 12345;\n  char* error_msg \u003d \"An error occurred\";\n  char* header_name \u003d \"error_type\";\n  char* header_value \u003d \"critical\";\n\n  int ret \u003d ns_kafka_set_message_header(jpcid, error_msg, header_name, header_value);\n  if (ret \u003d\u003d 0) {\n    printf(\"Header successfully added.\");\n  } else {\n    printf(\"Error adding header.\");\n  }\n}",
  "javaEx": "public class flow implements NsFlow\n{\n  public int execute(NSApi nsApi) throws Exception\n  {\n        NSApi.JMSKey key \u003d null;\n        String header_name \u003d \"header_name\";\n        String header_value \u003d \"header_value\";\n\n        // Headers provide additional metadata about the message that can be used by Kafka consumers to process the message.\n        if(!nsApi.ns_kafka_set_message_header(key, header_name, header_value))\n        {\n         System.out.println(\"Error in setting header. Error code \u003d \" + key.getErrCode() + \", Error Msg \u003d \" + key.getErrMsg());\n         return 0;\n        }\n  }\n}",
  "insertStrC": "ns_kafka_set_message_header(int jpcid, char *error_msg, char *header_name, char *header_value);",
  "insertStrJava": "ns_kafka_set_message_header(JMSKey key, String header_name, Object header_value);",
  "description": "The ns_kafka_set_message_header() function is used to set a header for a message being sent through a Kafka producer. Headers provide additional metadata about the message that can be used by Kafka consumers to process the message. "
}