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.



6711
6712
6713
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6711

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

Instance Attribute Details

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


6662
6663
6664
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6662

def data_type
  @data_type
end

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

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

Returns:



6667
6668
6669
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6667

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) 


6673
6674
6675
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6673

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) 


6678
6679
6680
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6678

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) 


6683
6684
6685
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6683

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) 


6690
6691
6692
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6690

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) 


6697
6698
6699
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6697

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) 


6703
6704
6705
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6703

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) 


6708
6709
6710
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6708

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6716

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