IntegrationParameter

JSON representation
InOutType

Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.

JSON representation

JSON representation
{ "key": string, "dataType": enum (`IntegrationParameterDataType`), "defaultValue": { object (`ValueType`) }, "searchable": boolean, "displayName": string, "inputOutputType": enum (`InOutType`), "isTransient": boolean, "producer": string, "jsonSchema": string, "containsLargeData": boolean, "masked": boolean, "description": string }

{
  "key": string,
  "dataType": enum (IntegrationParameterDataType),
  "defaultValue": {
    object (ValueType)
  },
  "searchable": boolean,
  "displayName": string,
  "inputOutputType": enum (InOutType),
  "isTransient": boolean,
  "producer": string,
  "jsonSchema": string,
  "containsLargeData": boolean,
  "masked": boolean,
  "description": string
}

Fields
`key`	`string` Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
`dataType`	`enum (IntegrationParameterDataType)` type of the parameter.
`defaultValue`	`object (ValueType)` Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
`searchable`	`boolean` Searchable in the execution log or not.
`displayName`	`string` The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
`inputOutputType`	`enum (InOutType)` Specifies the input/output type for the parameter.
`isTransient`	`boolean` Whether this parameter is a transient parameter.
`producer`	`string` The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
`jsonSchema`	`string` This schema will be used to validate runtime JSON-typed values of this parameter.
`containsLargeData`	`boolean` Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
`masked`	`boolean` True if this parameter should be masked in the logs
`description`	`string` Optional. Description of the parameter.

InOutType

Is the parameter input, output of a integration.

Enums
`IN_OUT_TYPE_UNSPECIFIED`	Default.
`IN`	Input parameters for the integration. EventBus validates that these parameters exist in the integrations before execution.
`OUT`	Output Parameters for the integration. EventBus will only return the integration parameters tagged with OUT in the response back.
`IN_OUT`	Input and Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response.