- JSON representation
- ValueType
- EnumOption
- AuthorizationCodeLink
- State
- LogicalExpression
- FieldComparison
- Comparator
- Operator
- LocationType
- EnumSource
- MultipleSelectConfig
- MultipleSelectOption
ConfigVariableTemplate provides metadata about a ConfigVariable
that is used in a Connection.
JSON representation |
---|
{ "key": string, "valueType": enum ( |
Fields | |
---|---|
key |
Optional. Key of the config variable. |
valueType |
Optional. Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
displayName |
Optional. Display name of the parameter. |
description |
Optional. Description. |
validationRegex |
Optional. Regular expression in RE2 syntax used for validating the |
required |
Optional. Flag represents that this |
roleGrant |
Optional. Role grant configuration for the config variable. |
enumOptions[] |
Optional. Enum options. To be populated if |
authorizationCodeLink |
Optional. Authorization code link options. To be populated if |
state |
Output only. State of the config variable. |
isAdvanced |
Optional. Indicates if current template is part of advanced settings |
requiredCondition |
Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression. |
locationType |
Optional. Location Tyep denotes where this value should be sent in BYOC connections. |
enumSource |
Optional. enum source denotes the source of api to fill the enum options |
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 |
Optional. Id of the option. |
displayName |
Optional. 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,
"clientSecret": {
object ( |
Fields | |
---|---|
uri |
Optional. The base URI the user must click to trigger the authorization code login flow. |
scopes[] |
Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source. |
clientId |
Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source. |
clientSecret |
Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source. |
enablePkce |
Optional. Whether to enable PKCE for the auth code flow. |
omitQueryParams |
Optional. Omit query params from the redirect URI. |
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 ( |
Fields | |
---|---|
fieldComparisons[] |
Optional. A list of fields to be compared. |
logicalExpressions[] |
Optional. A list of nested conditions to be compared. |
logicalOperator |
Optional. The logical operator to use between the fields and conditions. |
FieldComparison
Field that needs to be compared.
JSON representation |
---|
{ "key": string, "comparator": enum ( |
Fields | |
---|---|
key |
Optional. Key of the field. |
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 value |
boolValue |
Boolean value |
intValue |
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 ( |
Fields | |
---|---|
valueSeparator |
Required. Value separator. Only "," can be used for OAuth auth code flow scope field. |
multipleSelectOptions[] |
Required. Multiple select options. |
allowCustomValues |
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 |
Optional. Value of the option. |
displayName |
Required. Display name of the option. |
key |
Required. Key of the option. |
preselected |
Optional. Indicates if the option is preselected. |