Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::ParameterMetadata (v0.3.0)

Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::ParameterMetadata.

Metadata for a specific parameter.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_metadata

def custom_metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Additional metadata for describing this parameter.

#custom_metadata=

def custom_metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Additional metadata for describing this parameter.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Additional metadata for describing this parameter.

#help_text

def help_text() -> ::String
Returns
  • (::String) — Required. The help text to display for the parameter.

#help_text=

def help_text=(value) -> ::String
Parameter
  • value (::String) — Required. The help text to display for the parameter.
Returns
  • (::String) — Required. The help text to display for the parameter.

#is_optional

def is_optional() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the parameter is optional. Defaults to false.

#is_optional=

def is_optional=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the parameter is optional. Defaults to false.
Returns
  • (::Boolean) — Optional. Whether the parameter is optional. Defaults to false.

#label

def label() -> ::String
Returns
  • (::String) — Required. The label to display for the parameter.

#label=

def label=(value) -> ::String
Parameter
  • value (::String) — Required. The label to display for the parameter.
Returns
  • (::String) — Required. The label to display for the parameter.

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the parameter.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the parameter.
Returns
  • (::String) — Required. The name of the parameter.

#param_type

def param_type() -> ::Google::Cloud::Dataflow::V1beta3::ParameterType
Returns

#param_type=

def param_type=(value) -> ::Google::Cloud::Dataflow::V1beta3::ParameterType
Parameter
Returns

#regexes

def regexes() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Regexes that the parameter must match.

#regexes=

def regexes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Regexes that the parameter must match.
Returns
  • (::Array<::String>) — Optional. Regexes that the parameter must match.