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.



471
472
473
# File 'lib/google/apis/connectors_v2/classes.rb', line 471

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

Instance Attribute Details

#additional_detailsHash<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>)


437
438
439
# File 'lib/google/apis/connectors_v2/classes.rb', line 437

def additional_details
  @additional_details
end

#data_typeString

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

Returns:

  • (String)


442
443
444
# File 'lib/google/apis/connectors_v2/classes.rb', line 442

def data_type
  @data_type
end

#default_valueObject

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)


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

def default_value
  @default_value
end

#descriptionString

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

Returns:

  • (String)


453
454
455
# File 'lib/google/apis/connectors_v2/classes.rb', line 453

def description
  @description
end

#json_schemaGoogle::Apis::ConnectorsV2::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property jsonSchema



458
459
460
# File 'lib/google/apis/connectors_v2/classes.rb', line 458

def json_schema
  @json_schema
end

#nameString

Name of the Parameter. Corresponds to the JSON property name

Returns:

  • (String)


463
464
465
# File 'lib/google/apis/connectors_v2/classes.rb', line 463

def name
  @name
end

#nullableBoolean Also known as: nullable?

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

Returns:

  • (Boolean)


468
469
470
# File 'lib/google/apis/connectors_v2/classes.rb', line 468

def nullable
  @nullable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



476
477
478
479
480
481
482
483
484
# File 'lib/google/apis/connectors_v2/classes.rb', line 476

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