Class: Google::Cloud::Dataflow::V1beta3::ParameterMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/templates.rb

Overview

Metadata for a specific parameter.

Defined Under Namespace

Classes: CustomMetadataEntry

Instance Attribute Summary collapse

Instance Attribute Details

#custom_metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Additional metadata for describing this parameter.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Additional metadata for describing this parameter.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#default_value ⇒ ::String

Returns 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.

Returns:

  • (::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.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enum_options ⇒ ::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>

Returns Optional. The options shown when ENUM ParameterType is specified.

Returns:



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#group_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#help_text ⇒ ::String

Returns Required. The help text to display for the parameter.

Returns:

  • (::String) —

    Required. The help text to display for the parameter.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#hidden_ui ⇒ ::Boolean

Returns Optional. Whether the parameter should be hidden in the UI.

Returns:

  • (::Boolean) —

    Optional. Whether the parameter should be hidden in the UI.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_optional ⇒ ::Boolean

Returns Optional. Whether the parameter is optional. Defaults to false.

Returns:

  • (::Boolean) —

    Optional. Whether the parameter is optional. Defaults to false.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#label ⇒ ::String

Returns Required. The label to display for the parameter.

Returns:

  • (::String) —

    Required. The label to display for the parameter.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The name of the parameter.

Returns:

  • (::String) —

    Required. The name of the parameter.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#param_type ⇒ ::Google::Cloud::Dataflow::V1beta3::ParameterType

Returns Optional. The type of the parameter. Used for selecting input picker.

Returns:



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent_trigger_values ⇒ ::Array<::String>

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

Returns:

  • (::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).



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#regexes ⇒ ::Array<::String>

Returns Optional. Regexes that the parameter must match.

Returns:

  • (::Array<::String>) —

    Optional. Regexes that the parameter must match.



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 462

class ParameterMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class CustomMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end