Field

Information about the value and type of the field. Next Id: 8

JSON representation
{
  "referenceKey": string,
  "transformExpression": {
    object (TransformExpression)
  },
  "defaultValue": {
    object (ParameterValueType)
  },
  "fieldType": enum (WorkflowParameterDataType),
  "protoDefPath": string,
  "cardinality": enum (FieldCardinality)
}
Fields
referenceKey

string

This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$

transformExpression

object (TransformExpression)

This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). See go/transform-functions-design for more details. Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, referenceKey will be ignored. 3. If no value is returned after evaluation of transform expression, defaultValue can be mapped if provided. 4. The fieldType should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data.

defaultValue

object (ParameterValueType)

This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data. This field will be scrubbed using DatapolScrubber#maybeScrub() with go/proto-sanitizer#level3

fieldType

enum (WorkflowParameterDataType)

Specifies the data type of the field.

protoDefPath

string

Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input fieldType is BYTES and output fieldType is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If fieldType is *_ARRAY, then all the converted protos are of the same type.

cardinality

enum (FieldCardinality)

By default, if the cardinality is unspecified the field is considered required while mapping.