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

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

Overview

Metadata for a specific parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ParameterMetadata

Returns a new instance of ParameterMetadata.



3361
3362
3363
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3361

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

Instance Attribute Details

#custom_metadata ⇒ Hash<String,String>

Optional. Additional metadata for describing this parameter. Corresponds to the JSON property customMetadata

Returns:

  • (Hash<String,String>) 


3328
3329
3330
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3328

def custom_metadata
  @custom_metadata
end

#help_text ⇒ String

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

Returns:

  • (String) 


3333
3334
3335
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3333

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) 


3338
3339
3340
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3338

def is_optional
  @is_optional
end

#label ⇒ String

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

Returns:

  • (String) 


3344
3345
3346
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3344

def label
  @label
end

#name ⇒ String

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

Returns:

  • (String) 


3349
3350
3351
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3349

def name
  @name
end

#param_type ⇒ String

Optional. The type of the parameter. Used for selecting input picker. Corresponds to the JSON property paramType

Returns:

  • (String) 


3354
3355
3356
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3354

def param_type
  @param_type
end

#regexes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3359
3360
3361
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3359

def regexes
  @regexes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3366

def update!(**args)
  @custom_metadata = args[:custom_metadata] if args.key?(:custom_metadata)
  @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)
  @param_type = args[:param_type] if args.key?(:param_type)
  @regexes = args[:regexes] if args.key?(:regexes)
end