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.



448
449
450
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 448

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:



388
389
390
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 388

def authorization_code_link
  @authorization_code_link
end

#description ⇒ String

Description. Corresponds to the JSON property description

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


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

def is_advanced
  @is_advanced
end

#key ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def required
  @required
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 prinicpal 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:



429
430
431
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 429

def role_grant
  @role_grant
end

#state ⇒ String

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

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 434

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) 


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

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) 


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

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 453

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)
  @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