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.



3823
3824
3825
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3823

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>) 


3750
3751
3752
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3750

def custom_metadata
  @custom_metadata
end

#default_value ⇒ String

Optional. The default values will pre-populate the parameter with the given value from the proto. If default_value is left empty, the parameter will be populated with a default of the relevant type, e.g. false for a boolean. Corresponds to the JSON property defaultValue

Returns:

  • (String) 


3757
3758
3759
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3757

def default_value
  @default_value
end

#enum_options ⇒ Array<Google::Apis::DataflowV1b3::ParameterMetadataEnumOption>

Optional. The options shown when ENUM ParameterType is specified. Corresponds to the JSON property enumOptions

Returns:



3762
3763
3764
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3762

def enum_options
  @enum_options
end

#group_name ⇒ String

Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided. Corresponds to the JSON property groupName

Returns:

  • (String) 


3769
3770
3771
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3769

def group_name
  @group_name
end

#help_text ⇒ String

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

Returns:

  • (String) 


3774
3775
3776
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3774

def help_text
  @help_text
end

#hidden_ui ⇒ Boolean Also known as: hidden_ui?

Optional. Whether the parameter should be hidden in the UI. Corresponds to the JSON property hiddenUi

Returns:

  • (Boolean) 


3779
3780
3781
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3779

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


3785
3786
3787
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3785

def is_optional
  @is_optional
end

#label ⇒ String

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

Returns:

  • (String) 


3791
3792
3793
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3791

def label
  @label
end

#name ⇒ String

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

Returns:

  • (String) 


3796
3797
3798
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3796

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) 


3801
3802
3803
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3801

def param_type
  @param_type
end

#parent_name ⇒ String

Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field. Corresponds to the JSON property parentName

Returns:

  • (String) 


3808
3809
3810
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3808

def parent_name
  @parent_name
end

#parent_trigger_values ⇒ Array<String>

Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided). Corresponds to the JSON property parentTriggerValues

Returns:

  • (Array<String>) 


3816
3817
3818
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3816

def parent_trigger_values
  @parent_trigger_values
end

#regexes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3821
3822
3823
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3821

def regexes
  @regexes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 3828

def update!(**args)
  @custom_metadata = args[:custom_metadata] if args.key?(:custom_metadata)
  @default_value = args[:default_value] if args.key?(:default_value)
  @enum_options = args[:enum_options] if args.key?(:enum_options)
  @group_name = args[:group_name] if args.key?(:group_name)
  @help_text = args[:help_text] if args.key?(:help_text)
  @hidden_ui = args[:hidden_ui] if args.key?(:hidden_ui)
  @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)
  @parent_name = args[:parent_name] if args.key?(:parent_name)
  @parent_trigger_values = args[:parent_trigger_values] if args.key?(:parent_trigger_values)
  @regexes = args[:regexes] if args.key?(:regexes)
end