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.



6820
6821
6822
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6820

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

Instance Attribute Details

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


6771
6772
6773
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6771

def data_type
  @data_type
end

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

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

Returns:



6776
6777
6778
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6776

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) 


6782
6783
6784
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6782

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) 


6787
6788
6789
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6787

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) 


6792
6793
6794
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6792

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) 


6799
6800
6801
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6799

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) 


6806
6807
6808
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6806

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) 


6812
6813
6814
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6812

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) 


6817
6818
6819
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6817

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6825

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