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.



712
713
714
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 712

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:



630
631
632
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 630

def authorization_code_link
  @authorization_code_link
end

#description ⇒ String

Optional. Description. Corresponds to the JSON property description

Returns:

  • (String) 


635
636
637
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 635

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


640
641
642
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 640

def display_name
  @display_name
end

#enum_options ⇒ Array<Google::Apis::ConnectorsV1::EnumOption>

Optional. Enum options. To be populated if ValueType is ENUM Corresponds to the JSON property enumOptions

Returns:



645
646
647
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 645

def enum_options
  @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

Returns:

  • (String) 


650
651
652
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 650

def enum_source
  @enum_source
end

#is_advanced ⇒ Boolean Also known as: is_advanced?

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

Returns:

  • (Boolean) 


655
656
657
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 655

def is_advanced
  @is_advanced
end

#key ⇒ String

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

Returns:

  • (String) 


661
662
663
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 661

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

Returns:

  • (String) 


667
668
669
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 667

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

Returns:



672
673
674
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 672

def multiple_select_config
  @multiple_select_config
end

#required ⇒ Boolean Also known as: required?

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

Returns:

  • (Boolean) 


678
679
680
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 678

def required
  @required
end

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

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

Returns:



684
685
686
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 684

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

Returns:



693
694
695
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 693

def role_grant
  @role_grant
end

#state ⇒ String

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

Returns:

  • (String) 


698
699
700
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 698

def state
  @state
end

#validation_regex ⇒ String

Optional. Regular expression in RE2 syntax used for validating the value of a ConfigVariable. Corresponds to the JSON property validationRegex

Returns:

  • (String) 


704
705
706
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 704

def validation_regex
  @validation_regex
end

#value_type ⇒ String

Optional. 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) 


710
711
712
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 710

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 717

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