ConfigVariableTemplate

ConfigVariableTemplate provides metadata about a ConfigVariable that is used in a Connection.

JSON representation 
{
  "key": string,
  "valueType": enum (ValueType),
  "displayName": string,
  "description": string,
  "validationRegex": string,
  "required": boolean,
  "roleGrant": {
    object (RoleGrant)
  },
  "enumOptions": [
    {
      object (EnumOption)
    }
  ],
  "authorizationCodeLink": {
    object (AuthorizationCodeLink)
  },
  "state": enum (State),
  "isAdvanced": boolean,
  "requiredCondition": {
    object (LogicalExpression)
  },
  "locationType": enum (LocationType),
  "enumSource": enum (EnumSource),
  "multipleSelectConfig": {
    object (MultipleSelectConfig)
  }
}
Fields
key

string

Optional. Key of the config variable.
valueType

enum (ValueType)

Optional. Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
displayName

string

Optional. Display name of the parameter.
description

string

Optional. Description.
validationRegex

string

Optional. Regular expression in RE2 syntax used for validating the value of a ConfigVariable.
required

boolean

Optional. Flag represents that this ConfigVariable must be provided for a connection.
roleGrant

object (RoleGrant)

Optional. Role grant configuration for the config variable.
enumOptions[]

object (EnumOption)

Optional. Enum options. To be populated if ValueType is ENUM
state

enum (State)

Output only. State of the config variable.
isAdvanced

boolean

Optional. Indicates if current template is part of advanced settings
requiredCondition

object (LogicalExpression)

Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
locationType

enum (LocationType)

Optional. Location Tyep denotes where this value should be sent in BYOC connections.
enumSource

enum (EnumSource)

Optional. enum source denotes the source of api to fill the enum options
multipleSelectConfig

object (MultipleSelectConfig)

Optional. MultipleSelectConfig represents the multiple options for a config variable.

ValueType

ValueType indicates the data type of the value.

Enums
VALUE_TYPE_UNSPECIFIED Value type is not specified.
STRING Value type is string.
INT Value type is integer.
BOOL Value type is boolean.
SECRET Value type is secret.
ENUM Value type is enum.
AUTHORIZATION_CODE Value type is authorization code.
ENCRYPTION_KEY Encryption Key.
MULTIPLE_SELECT Value type is multiple select.

EnumOption

EnumOption definition

JSON representation 
{
  "id": string,
  "displayName": string
}
Fields
id

string

Optional. Id of the option.
displayName

string

Optional. Display name of the option.

State

Indicates the state of the config variable.

Enums
STATE_UNSPECIFIED Status is unspecified.
ACTIVE Config variable is active
DEPRECATED Config variable is deprecated.

LogicalExpression

Struct for representing boolean expressions.

JSON representation 
{
  "fieldComparisons": [
    {
      object (FieldComparison)
    }
  ],
  "logicalExpressions": [
    {
      object (LogicalExpression)
    }
  ],
  "logicalOperator": enum (Operator)
}
Fields
fieldComparisons[]

object (FieldComparison)

Optional. A list of fields to be compared.
logicalExpressions[]

object (LogicalExpression)

Optional. A list of nested conditions to be compared.
logicalOperator

enum (Operator)

Optional. The logical operator to use between the fields and conditions.

FieldComparison

Field that needs to be compared.

JSON representation 
{
  "key": string,
  "comparator": enum (Comparator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "intValue": string
  // End of list of possible types for union field value.
}
Fields
key

string

Optional. Key of the field.
comparator

enum (Comparator)

Optional. Comparator to use for comparing the field value.
Union field value. Value to compare against. value can be only one of the following:
stringValue

string

String value
boolValue

boolean

Boolean value
intValue

string (int64 format)

Integer value

Comparator

Representation of the different comparators that can be used.

Enums
COMPARATOR_UNSPECIFIED The default value.
EQUALS The field value must be equal to the specified value.
NOT_EQUALS The field value must not be equal to the specified value.

Operator

Representation of the different logical operators that can be used.

Enums
OPERATOR_UNSPECIFIED The default value.
AND AND operator; The conditions must all be true.
OR OR operator; At least one of the conditions must be true.

LocationType

Location Type are the options where this value should be sent in BYOC connections.

Enums
LOCATION_TYPE_UNSPECIFIED Location type unspecified.
HEADER Request header.
PAYLOAD Request Payload.
QUERY_PARAM Request query param.
PATH_PARAM Request path param.

EnumSource

Api source used to fill the enum options

Enums
ENUM_SOURCE_UNSPECIFIED Api type unspecified.
EVENT_TYPES_API list event types.

MultipleSelectConfig

MultipleSelectConfig represents the multiple options for a config variable.

JSON representation 
{
  "valueSeparator": string,
  "multipleSelectOptions": [
    {
      object (MultipleSelectOption)
    }
  ],
  "allowCustomValues": boolean
}
Fields
valueSeparator

string

Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
multipleSelectOptions[]

object (MultipleSelectOption)

Required. Multiple select options.
allowCustomValues

boolean

Optional. Allow custom values.

MultipleSelectOption

MultiplSelecteOption represents the single option for a config variable.

JSON representation 
{
  "description": string,
  "displayName": string,
  "key": string,
  "preselected": boolean
}
Fields
description

string

Optional. Value of the option.
displayName

string

Required. Display name of the option.
key

string

Required. Key of the option.
preselected

boolean

Optional. Indicates if the option is preselected.