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.
#default_value
def default_value() -> ::String
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.
#default_value=
def default_value=(value) -> ::String
Parameter
- 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.
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.
#enum_options
def enum_options() -> ::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>
Returns
- (::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>) — Optional. The options shown when ENUM ParameterType is specified.
#enum_options=
def enum_options=(value) -> ::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>
Parameter
- value (::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>) — Optional. The options shown when ENUM ParameterType is specified.
Returns
- (::Array<::Google::Cloud::Dataflow::V1beta3::ParameterMetadataEnumOption>) — Optional. The options shown when ENUM ParameterType is specified.
#group_name
def group_name() -> ::String
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.
#group_name=
def group_name=(value) -> ::String
Parameter
- value (::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.
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.
#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.
#hidden_ui
def hidden_ui() -> ::Boolean
Returns
- (::Boolean) — Optional. Whether the parameter should be hidden in the UI.
#hidden_ui=
def hidden_ui=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Whether the parameter should be hidden in the UI.
Returns
- (::Boolean) — Optional. Whether the parameter should be hidden in the UI.
#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
- (::Google::Cloud::Dataflow::V1beta3::ParameterType) — Optional. The type of the parameter. Used for selecting input picker.
#param_type=
def param_type=(value) -> ::Google::Cloud::Dataflow::V1beta3::ParameterType
Parameter
- value (::Google::Cloud::Dataflow::V1beta3::ParameterType) — Optional. The type of the parameter. Used for selecting input picker.
Returns
- (::Google::Cloud::Dataflow::V1beta3::ParameterType) — Optional. The type of the parameter. Used for selecting input picker.
#parent_name
def parent_name() -> ::String
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.
#parent_name=
def parent_name=(value) -> ::String
Parameter
- value (::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.
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.
#parent_trigger_values
def parent_trigger_values() -> ::Array<::String>
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).
#parent_trigger_values=
def parent_trigger_values=(value) -> ::Array<::String>
Parameter
- value (::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).
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).
#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.