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



2614
2615
2616
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2614

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) 


2591
2592
2593
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2591

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) 


2596
2597
2598
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2596

def is_optional
  @is_optional
end

#label ⇒ String

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

Returns:

  • (String) 


2602
2603
2604
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2602

def label
  @label
end

#name ⇒ String

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

Returns:

  • (String) 


2607
2608
2609
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2607

def name
  @name
end

#regexes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2612
2613
2614
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2612

def regexes
  @regexes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2619
2620
2621
2622
2623
2624
2625
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2619

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