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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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:



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 376

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