Class: Google::Apis::DataflowV1b3::ParameterMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dataflow_v1b3/classes.rb,
generated/google/apis/dataflow_v1b3/representations.rb,
generated/google/apis/dataflow_v1b3/representations.rb

Overview

Metadata for a specific parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ParameterMetadata

Returns a new instance of ParameterMetadata



2840
2841
2842
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2840

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

Instance Attribute Details

#help_text ⇒ String

Required. The help text to display for the parameter. Corresponds to the JSON property helpText

Returns:

  • (String) 


2817
2818
2819
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2817

def help_text
  @help_text
end

#is_optional ⇒ Boolean Also known as: is_optional?

Optional. Whether the parameter is optional. Defaults to false. Corresponds to the JSON property isOptional

Returns:

  • (Boolean) 


2822
2823
2824
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2822

def is_optional
  @is_optional
end

#label ⇒ String

Required. The label to display for the parameter. Corresponds to the JSON property label

Returns:

  • (String) 


2828
2829
2830
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2828

def label
  @label
end

#name ⇒ String

Required. The name of the parameter. Corresponds to the JSON property name

Returns:

  • (String) 


2833
2834
2835
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2833

def name
  @name
end

#regexes ⇒ Array<String>

Optional. Regexes that the parameter must match. Corresponds to the JSON property regexes

Returns:

  • (Array<String>) 


2838
2839
2840
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2838

def regexes
  @regexes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2845
2846
2847
2848
2849
2850
2851
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2845

def update!(**args)
  @help_text = args[:help_text] if args.key?(:help_text)
  @is_optional = args[:is_optional] if args.key?(:is_optional)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @regexes = args[:regexes] if args.key?(:regexes)
end