Class: Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaIntegrationParameter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/integrations_v1/classes.rb,
lib/google/apis/integrations_v1/representations.rb,
lib/google/apis/integrations_v1/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.



8606
8607
8608
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8606

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

Instance Attribute Details

#contains_large_data ⇒ Boolean Also known as: contains_large_data?

Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. Corresponds to the JSON property containsLargeData

Returns:

  • (Boolean) 


8540
8541
8542
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8540

def contains_large_data
  @contains_large_data
end

#data_type ⇒ String

Type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


8546
8547
8548
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8546

def data_type
  @data_type
end

#default_value ⇒ Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaValueType

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

Returns:



8551
8552
8553
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8551

def default_value
  @default_value
end

#description ⇒ String

Optional. Description of the parameter. Corresponds to the JSON property description

Returns:

  • (String) 


8556
8557
8558
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8556

def description
  @description
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) 


8562
8563
8564
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8562

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) 


8567
8568
8569
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8567

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) 


8572
8573
8574
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8572

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) 


8579
8580
8581
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8579

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) 


8586
8587
8588
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8586

def key
  @key
end

#masked ⇒ Boolean Also known as: masked?

True if this parameter should be masked in the logs Corresponds to the JSON property masked

Returns:

  • (Boolean) 


8591
8592
8593
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8591

def masked
  @masked
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) 


8598
8599
8600
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8598

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) 


8603
8604
8605
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8603

def searchable
  @searchable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 8611

def update!(**args)
  @contains_large_data = args[:contains_large_data] if args.key?(:contains_large_data)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @description = args[:description] if args.key?(:description)
  @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)
  @masked = args[:masked] if args.key?(:masked)
  @producer = args[:producer] if args.key?(:producer)
  @searchable = args[:searchable] if args.key?(:searchable)
end