Class: Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationParameter

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

Overview

Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIntegrationsV1alphaIntegrationParameter

Returns a new instance of GoogleCloudIntegrationsV1alphaIntegrationParameter.



6563
6564
6565
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6563

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

Instance Attribute Details

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


6514
6515
6516
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6514

def data_type
  @data_type
end

#default_value ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaValueType

The type of the parameter. Corresponds to the JSON property defaultValue

Returns:



6519
6520
6521
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6519

def default_value
  @default_value
end

#display_name ⇒ String

The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". Corresponds to the JSON property displayName

Returns:

  • (String) 


6525
6526
6527
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6525

def display_name
  @display_name
end

#input_output_type ⇒ String

Specifies the input/output type for the parameter. Corresponds to the JSON property inputOutputType

Returns:

  • (String) 


6530
6531
6532
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6530

def input_output_type
  @input_output_type
end

#is_transient ⇒ Boolean Also known as: is_transient?

Whether this parameter is a transient parameter. Corresponds to the JSON property isTransient

Returns:

  • (Boolean) 


6535
6536
6537
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6535

def is_transient
  @is_transient
end

#json_schema ⇒ String

This schema will be used to validate runtime JSON-typed values of this parameter. Corresponds to the JSON property jsonSchema

Returns:

  • (String) 


6542
6543
6544
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6542

def json_schema
  @json_schema
end

#key ⇒ String

Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. Corresponds to the JSON property key

Returns:

  • (String) 


6549
6550
6551
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6549

def key
  @key
end

#producer ⇒ String

The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param. Corresponds to the JSON property producer

Returns:

  • (String) 


6555
6556
6557
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6555

def producer
  @producer
end

#searchable ⇒ Boolean Also known as: searchable?

Searchable in the execution log or not. Corresponds to the JSON property searchable

Returns:

  • (Boolean) 


6560
6561
6562
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6560

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6568

def update!(**args)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @display_name = args[:display_name] if args.key?(:display_name)
  @input_output_type = args[:input_output_type] if args.key?(:input_output_type)
  @is_transient = args[:is_transient] if args.key?(:is_transient)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @key = args[:key] if args.key?(:key)
  @producer = args[:producer] if args.key?(:producer)
  @searchable = args[:searchable] if args.key?(:searchable)
end