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.



7032
7033
7034
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7032

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

Instance Attribute Details

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


6983
6984
6985
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6983

def data_type
  @data_type
end

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

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

Returns:



6988
6989
6990
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6988

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) 


6994
6995
6996
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6994

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) 


6999
7000
7001
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6999

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) 


7004
7005
7006
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7004

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) 


7011
7012
7013
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7011

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) 


7018
7019
7020
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7018

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) 


7024
7025
7026
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7024

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) 


7029
7030
7031
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7029

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 7037

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