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.



343
344
345
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 343

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

Instance Attribute Details

#description ⇒ String

Description. Corresponds to the JSON property description

Returns:

  • (String) 


304
305
306
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 304

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


309
310
311
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 309

def display_name
  @display_name
end

#key ⇒ String

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

Returns:

  • (String) 


314
315
316
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 314

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) 


319
320
321
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 319

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:



329
330
331
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 329

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


335
336
337
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 335

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) 


341
342
343
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 341

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



348
349
350
351
352
353
354
355
356
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 348

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @key = args[:key] if args.key?(:key)
  @required = args[:required] if args.key?(:required)
  @role_grant = args[:role_grant] if args.key?(:role_grant)
  @validation_regex = args[:validation_regex] if args.key?(:validation_regex)
  @value_type = args[:value_type] if args.key?(:value_type)
end