Class: Google::Apis::ConnectorsV2::InputParameter

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/connectors_v2/classes.rb,
lib/google/apis/connectors_v2/representations.rb,
lib/google/apis/connectors_v2/representations.rb

Overview

Input Parameter message contains metadata about the parameters required for executing an Action.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InputParameter

Returns a new instance of InputParameter.



593
594
595
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 593

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

Instance Attribute Details

#additional_details ⇒ Hash<String,Object>

The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. Corresponds to the JSON property additionalDetails

Returns:

  • (Hash<String,Object>) 


559
560
561
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 559

def additional_details
  @additional_details
end

#data_type ⇒ String

The data type of the Parameter Corresponds to the JSON property dataType

Returns:

  • (String) 


564
565
566
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 564

def data_type
  @data_type
end

#default_value ⇒ Object

The following field specifies the default value of the Parameter provided by the external system if a value is not provided. Corresponds to the JSON property defaultValue

Returns:

  • (Object) 


570
571
572
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 570

def default_value
  @default_value
end

#description ⇒ String

A brief description of the Parameter. Corresponds to the JSON property description

Returns:

  • (String) 


575
576
577
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 575

def description
  @description
end

#json_schema ⇒ Google::Apis::ConnectorsV2::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property jsonSchema

Returns:



580
581
582
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 580

def json_schema
  @json_schema
end

#name ⇒ String

Name of the Parameter. Corresponds to the JSON property name

Returns:

  • (String) 


585
586
587
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 585

def name
  @name
end

#nullable ⇒ Boolean Also known as: nullable?

Specifies whether a null value is allowed. Corresponds to the JSON property nullable

Returns:

  • (Boolean) 


590
591
592
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 590

def nullable
  @nullable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



598
599
600
601
602
603
604
605
606
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 598

def update!(**args)
  @additional_details = args[:additional_details] if args.key?(:additional_details)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @description = args[:description] if args.key?(:description)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @name = args[:name] if args.key?(:name)
  @nullable = args[:nullable] if args.key?(:nullable)
end