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.



6938
6939
6940
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6938

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

Instance Attribute Details

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


6889
6890
6891
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6889

def data_type
  @data_type
end

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

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

Returns:



6894
6895
6896
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6894

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) 


6900
6901
6902
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6900

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) 


6905
6906
6907
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6905

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) 


6910
6911
6912
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6910

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) 


6917
6918
6919
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6917

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) 


6924
6925
6926
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6924

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) 


6930
6931
6932
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6930

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) 


6935
6936
6937
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6935

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 6943

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