Package com.google.dataflow.v1beta3

Interface ParameterMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ParameterMetadata, ParameterMetadata.Builder
@Generated public interface ParameterMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Required. The name of the parameter.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the parameter.
      string name = 1;
      Returns:
      The bytes for name.

    • getLabel

      String getLabel()
       Required. The label to display for the parameter.
      string label = 2;
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
       Required. The label to display for the parameter.
      string label = 2;
      Returns:
      The bytes for label.

    • getHelpText

      String getHelpText()
       Required. The help text to display for the parameter.
      string help_text = 3;
      Returns:
      The helpText.

    • getHelpTextBytes

      com.google.protobuf.ByteString getHelpTextBytes()
       Required. The help text to display for the parameter.
      string help_text = 3;
      Returns:
      The bytes for helpText.

    • getIsOptional

      boolean getIsOptional()
       Optional. Whether the parameter is optional. Defaults to false.
      bool is_optional = 4;
      Returns:
      The isOptional.

    • getRegexesList

      List<String> getRegexesList()
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Returns:
      A list containing the regexes.

    • getRegexesCount

      int getRegexesCount()
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Returns:
      The count of regexes.

    • getRegexes

      String getRegexes(int index)
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The regexes at the given index.

    • getRegexesBytes

      com.google.protobuf.ByteString getRegexesBytes(int index)
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the regexes at the given index.

    • getParamTypeValue

      int getParamTypeValue()
       Optional. The type of the parameter.
 Used for selecting input picker.
      .google.dataflow.v1beta3.ParameterType param_type = 6;
      Returns:
      The enum numeric value on the wire for paramType.

    • getParamType

      ParameterType getParamType()
       Optional. The type of the parameter.
 Used for selecting input picker.
      .google.dataflow.v1beta3.ParameterType param_type = 6;
      Returns:
      The paramType.

    • getCustomMetadataCount

      int getCustomMetadataCount()
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;

    • containsCustomMetadata

      boolean containsCustomMetadata(String key)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;

    • getCustomMetadata

      @Deprecated Map<String,String> getCustomMetadata()
      Deprecated.
      Use getCustomMetadataMap() instead.

    • getCustomMetadataMap

      Map<String,String> getCustomMetadataMap()
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;

    • getCustomMetadataOrDefault

      String getCustomMetadataOrDefault(String key, String defaultValue)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;

    • getCustomMetadataOrThrow

      String getCustomMetadataOrThrow(String key)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;

    • getGroupName

      String getGroupName()
       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.
      string group_name = 8;
      Returns:
      The groupName.

    • getGroupNameBytes

      com.google.protobuf.ByteString getGroupNameBytes()
       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.
      string group_name = 8;
      Returns:
      The bytes for groupName.

    • getParentName

      String getParentName()
       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.
      string parent_name = 9;
      Returns:
      The parentName.

    • getParentNameBytes

      com.google.protobuf.ByteString getParentNameBytes()
       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.
      string parent_name = 9;
      Returns:
      The bytes for parentName.

    • getParentTriggerValuesList

      List<String> getParentTriggerValuesList()
       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).
      repeated string parent_trigger_values = 10;
      Returns:
      A list containing the parentTriggerValues.

    • getParentTriggerValuesCount

      int getParentTriggerValuesCount()
       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).
      repeated string parent_trigger_values = 10;
      Returns:
      The count of parentTriggerValues.

    • getParentTriggerValues

      String getParentTriggerValues(int index)
       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).
      repeated string parent_trigger_values = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The parentTriggerValues at the given index.

    • getParentTriggerValuesBytes

      com.google.protobuf.ByteString getParentTriggerValuesBytes(int index)
       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).
      repeated string parent_trigger_values = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the parentTriggerValues at the given index.

    • getEnumOptionsList

      List<ParameterMetadataEnumOption> getEnumOptionsList()
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;

    • getEnumOptions

      ParameterMetadataEnumOption getEnumOptions(int index)
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;

    • getEnumOptionsCount

      int getEnumOptionsCount()
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;

    • getEnumOptionsOrBuilderList

      List<? extends ParameterMetadataEnumOptionOrBuilder> getEnumOptionsOrBuilderList()
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;

    • getEnumOptionsOrBuilder

      ParameterMetadataEnumOptionOrBuilder getEnumOptionsOrBuilder(int index)
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;

    • getDefaultValue

      String getDefaultValue()
       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.
      string default_value = 12;
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      com.google.protobuf.ByteString getDefaultValueBytes()
       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.
      string default_value = 12;
      Returns:
      The bytes for defaultValue.

    • getHiddenUi

      boolean getHiddenUi()
       Optional. Whether the parameter should be hidden in the UI.
      bool hidden_ui = 13;
      Returns:
      The hiddenUi.