Class: Google::Apis::ConnectorsV1::ConfigVariableTemplate

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ConfigVariableTemplate

Returns a new instance of ConfigVariableTemplate.



459
460
461
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 459

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

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

Returns:



394
395
396
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 394

def authorization_code_link
  @authorization_code_link
end

#description ⇒ String

Description. Corresponds to the JSON property description

Returns:

  • (String) 


399
400
401
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 399

def description
  @description
end

#display_name ⇒ String

Display name of the parameter. Corresponds to the JSON property displayName

Returns:

  • (String) 


404
405
406
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 404

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

Returns:



409
410
411
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 409

def enum_options
  @enum_options
end

#is_advanced ⇒ Boolean Also known as: is_advanced?

Indicates if current template is part of advanced settings Corresponds to the JSON property isAdvanced

Returns:

  • (Boolean) 


414
415
416
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 414

def is_advanced
  @is_advanced
end

#key ⇒ String

Key of the config variable. Corresponds to the JSON property key

Returns:

  • (String) 


420
421
422
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 420

def key
  @key
end

#required ⇒ Boolean Also known as: required?

Flag represents that this ConfigVariable must be provided for a connection. Corresponds to the JSON property required

Returns:

  • (Boolean) 


425
426
427
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 425

def required
  @required
end

#required_condition ⇒ Google::Apis::ConnectorsV1::LogicalExpression

Struct for representing boolean expressions. Corresponds to the JSON property requiredCondition

Returns:



431
432
433
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 431

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 GCP 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

Returns:



440
441
442
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 440

def role_grant
  @role_grant
end

#state ⇒ String

State of the config variable. Corresponds to the JSON property state

Returns:

  • (String) 


445
446
447
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 445

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

Returns:

  • (String) 


451
452
453
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 451

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

Returns:

  • (String) 


457
458
459
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 457

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 464

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)
  @is_advanced = args[:is_advanced] if args.key?(:is_advanced)
  @key = args[:key] if args.key?(:key)
  @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