Class: Google::Apis::ConnectorsV1::ConfigVariableTemplate
- Inherits:
-
Object
- Object
- Google::Apis::ConnectorsV1::ConfigVariableTemplate
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/connectors_v1/classes.rb,
lib/google/apis/connectors_v1/representations.rb,
lib/google/apis/connectors_v1/representations.rb
Overview
ConfigVariableTemplate provides metadata about a ConfigVariable
that is used
in a Connection.
Instance Attribute Summary collapse
-
#authorization_code_link ⇒ Google::Apis::ConnectorsV1::AuthorizationCodeLink
This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.
-
#description ⇒ String
Description.
-
#display_name ⇒ String
Display name of the parameter.
-
#enum_options ⇒ Array<Google::Apis::ConnectorsV1::EnumOption>
Enum options.
-
#enum_source ⇒ String
Optional.
-
#is_advanced ⇒ Boolean
(also: #is_advanced?)
Indicates if current template is part of advanced settings Corresponds to the JSON property
isAdvanced
. -
#key ⇒ String
Key of the config variable.
-
#location_type ⇒ String
Optional.
-
#multiple_select_config ⇒ Google::Apis::ConnectorsV1::MultipleSelectConfig
MultipleSelectConfig represents the multiple options for a config variable.
-
#required ⇒ Boolean
(also: #required?)
Flag represents that this
ConfigVariable
must be provided for a connection. -
#required_condition ⇒ Google::Apis::ConnectorsV1::LogicalExpression
Struct for representing boolean expressions.
-
#role_grant ⇒ Google::Apis::ConnectorsV1::RoleGrant
This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account.
-
#state ⇒ String
State of the config variable.
-
#validation_regex ⇒ String
Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
. -
#value_type ⇒ String
Type of the parameter: string, int, bool etc.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ConfigVariableTemplate
constructor
A new instance of ConfigVariableTemplate.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ConfigVariableTemplate
Returns a new instance of ConfigVariableTemplate.
525 526 527 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 525 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authorization_code_link ⇒ Google::Apis::ConnectorsV1::AuthorizationCodeLink
This configuration captures the details required to render an authorization
link for the OAuth Authorization Code Flow.
Corresponds to the JSON property authorizationCodeLink
444 445 446 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 444 def @authorization_code_link end |
#description ⇒ String
Description.
Corresponds to the JSON property description
449 450 451 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 449 def description @description end |
#display_name ⇒ String
Display name of the parameter.
Corresponds to the JSON property displayName
454 455 456 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 454 def display_name @display_name end |
#enum_options ⇒ Array<Google::Apis::ConnectorsV1::EnumOption>
Enum options. To be populated if ValueType
is ENUM
Corresponds to the JSON property enumOptions
459 460 461 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 459 def @enum_options end |
#enum_source ⇒ String
Optional. enum source denotes the source of api to fill the enum options
Corresponds to the JSON property enumSource
464 465 466 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 464 def enum_source @enum_source end |
#is_advanced ⇒ Boolean Also known as: is_advanced?
Indicates if current template is part of advanced settings
Corresponds to the JSON property isAdvanced
469 470 471 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 469 def is_advanced @is_advanced end |
#key ⇒ String
Key of the config variable.
Corresponds to the JSON property key
475 476 477 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 475 def key @key end |
#location_type ⇒ String
Optional. Location Tyep denotes where this value should be sent in BYOC
connections.
Corresponds to the JSON property locationType
481 482 483 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 481 def location_type @location_type end |
#multiple_select_config ⇒ Google::Apis::ConnectorsV1::MultipleSelectConfig
MultipleSelectConfig represents the multiple options for a config variable.
Corresponds to the JSON property multipleSelectConfig
486 487 488 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 486 def multiple_select_config @multiple_select_config end |
#required ⇒ Boolean Also known as: required?
Flag represents that this ConfigVariable
must be provided for a connection.
Corresponds to the JSON property required
491 492 493 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 491 def required @required end |
#required_condition ⇒ Google::Apis::ConnectorsV1::LogicalExpression
Struct for representing boolean expressions.
Corresponds to the JSON property requiredCondition
497 498 499 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 497 def required_condition @required_condition end |
#role_grant ⇒ Google::Apis::ConnectorsV1::RoleGrant
This configuration defines all the Cloud IAM roles that needs to be granted to
a particular Google Cloud resource for the selected principal like service
account. These configurations will let UI display to customers what IAM roles
need to be granted by them. Or these configurations can be used by the UI to
render a 'grant' button to do the same on behalf of the user.
Corresponds to the JSON property roleGrant
506 507 508 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 506 def role_grant @role_grant end |
#state ⇒ String
State of the config variable.
Corresponds to the JSON property state
511 512 513 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 511 def state @state end |
#validation_regex ⇒ String
Regular expression in RE2 syntax used for validating the value
of a
ConfigVariable
.
Corresponds to the JSON property validationRegex
517 518 519 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 517 def validation_regex @validation_regex end |
#value_type ⇒ String
Type of the parameter: string, int, bool etc. consider custom type for the
benefit for the validation.
Corresponds to the JSON property valueType
523 524 525 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 523 def value_type @value_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 530 def update!(**args) @authorization_code_link = args[:authorization_code_link] if args.key?(:authorization_code_link) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @enum_options = args[:enum_options] if args.key?(:enum_options) @enum_source = args[:enum_source] if args.key?(:enum_source) @is_advanced = args[:is_advanced] if args.key?(:is_advanced) @key = args[:key] if args.key?(:key) @location_type = args[:location_type] if args.key?(:location_type) @multiple_select_config = args[:multiple_select_config] if args.key?(:multiple_select_config) @required = args[:required] if args.key?(:required) @required_condition = args[:required_condition] if args.key?(:required_condition) @role_grant = args[:role_grant] if args.key?(:role_grant) @state = args[:state] if args.key?(:state) @validation_regex = args[:validation_regex] if args.key?(:validation_regex) @value_type = args[:value_type] if args.key?(:value_type) end |