ConfigVariableTemplate
Stay organized with collections Save and categorize content based on your preferences.

JSON representation
ValueType
EnumOption
- JSON representation
AuthorizationCodeLink
- JSON representation
State
LogicalExpression
- JSON representation
FieldComparison
- JSON representation
Comparator
Operator
LocationType

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

JSON representation

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`) }

{
  "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)
}

Fields
`key`	`string` Key of the config variable.
`valueType`	`enum (ValueType)` Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
`displayName`	`string` Display name of the parameter.
`description`	`string` Description.
`validationRegex`	`string` Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
`required`	`boolean` Flag represents that this `ConfigVariable` must be provided for a connection.
`roleGrant`	`object (RoleGrant)` Role grant configuration for the config variable.
`enumOptions[]`	`object (EnumOption)` Enum options. To be populated if `ValueType` is `ENUM`
`authorizationCodeLink`	`object (AuthorizationCodeLink)` Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
`state`	`enum (State)` State of the config variable.
`isAdvanced`	`boolean` Indicates if current template is part of advanced settings
`requiredCondition`	`object (LogicalExpression)` 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.

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.

EnumOption

EnumOption definition

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

Fields

Fields
`id`	`string` Id of the option.
`displayName`	`string` Display name of the option.

id

string

Id of the option.

displayName

string

Display name of the option.

AuthorizationCodeLink

This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.

JSON representation
{ "uri": string, "scopes": [ string ], "clientId": string, "enablePkce": boolean }

Fields
`uri`	`string` The base URI the user must click to trigger the authorization code login flow.
`scopes[]`	`string` The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
`clientId`	`string` The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
`enablePkce`	`boolean` Whether to enable PKCE for the auth code flow.

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

Fields
`fieldComparisons[]`	`object (FieldComparison)` A list of fields to be compared.
`logicalExpressions[]`	`object (LogicalExpression)` A list of nested conditions to be compared.
`logicalOperator`	`enum (Operator)` The logical operator to use between the fields and conditions.

fieldComparisons[]

object (FieldComparison)

A list of fields to be compared.

logicalExpressions[]

object (LogicalExpression)

A list of nested conditions to be compared.

logicalOperator

enum (Operator)

The logical operator to use between the fields and conditions.

FieldComparison

Field that needs to be compared.

JSON representation

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`. }

{
  "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` Key of the field.
`comparator`	`enum (Comparator)` 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.

ConfigVariableTemplate Stay organized with collections Save and categorize content based on your preferences.