Package com.google.dataflow.v1beta3

Class ParameterMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.ParameterMetadata
All Implemented Interfaces:
ParameterMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ParameterMetadata extends com.google.protobuf.GeneratedMessage implements ParameterMetadataOrBuilder
 Metadata for a specific parameter.
Protobuf type google.dataflow.v1beta3.ParameterMetadata
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • LABEL_FIELD_NUMBER

      public static final int LABEL_FIELD_NUMBER
      See Also:

    • HELP_TEXT_FIELD_NUMBER

      public static final int HELP_TEXT_FIELD_NUMBER
      See Also:

    • IS_OPTIONAL_FIELD_NUMBER

      public static final int IS_OPTIONAL_FIELD_NUMBER
      See Also:

    • REGEXES_FIELD_NUMBER

      public static final int REGEXES_FIELD_NUMBER
      See Also:

    • PARAM_TYPE_FIELD_NUMBER

      public static final int PARAM_TYPE_FIELD_NUMBER
      See Also:

    • CUSTOM_METADATA_FIELD_NUMBER

      public static final int CUSTOM_METADATA_FIELD_NUMBER
      See Also:

    • GROUP_NAME_FIELD_NUMBER

      public static final int GROUP_NAME_FIELD_NUMBER
      See Also:

    • PARENT_NAME_FIELD_NUMBER

      public static final int PARENT_NAME_FIELD_NUMBER
      See Also:

    • PARENT_TRIGGER_VALUES_FIELD_NUMBER

      public static final int PARENT_TRIGGER_VALUES_FIELD_NUMBER
      See Also:

    • ENUM_OPTIONS_FIELD_NUMBER

      public static final int ENUM_OPTIONS_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • HIDDEN_UI_FIELD_NUMBER

      public static final int HIDDEN_UI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Required. The name of the parameter.
      string name = 1;
      Specified by:
      getName in interface ParameterMetadataOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the parameter.
      string name = 1;
      Specified by:
      getNameBytes in interface ParameterMetadataOrBuilder
      Returns:
      The bytes for name.

    • getLabel

      public String getLabel()
       Required. The label to display for the parameter.
      string label = 2;
      Specified by:
      getLabel in interface ParameterMetadataOrBuilder
      Returns:
      The label.

    • getLabelBytes

      public com.google.protobuf.ByteString getLabelBytes()
       Required. The label to display for the parameter.
      string label = 2;
      Specified by:
      getLabelBytes in interface ParameterMetadataOrBuilder
      Returns:
      The bytes for label.

    • getHelpText

      public String getHelpText()
       Required. The help text to display for the parameter.
      string help_text = 3;
      Specified by:
      getHelpText in interface ParameterMetadataOrBuilder
      Returns:
      The helpText.

    • getHelpTextBytes

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

    • getIsOptional

      public boolean getIsOptional()
       Optional. Whether the parameter is optional. Defaults to false.
      bool is_optional = 4;
      Specified by:
      getIsOptional in interface ParameterMetadataOrBuilder
      Returns:
      The isOptional.

    • getRegexesList

      public com.google.protobuf.ProtocolStringList getRegexesList()
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Specified by:
      getRegexesList in interface ParameterMetadataOrBuilder
      Returns:
      A list containing the regexes.

    • getRegexesCount

      public int getRegexesCount()
       Optional. Regexes that the parameter must match.
      repeated string regexes = 5;
      Specified by:
      getRegexesCount in interface ParameterMetadataOrBuilder
      Returns:
      The count of regexes.

    • getRegexes

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

    • getRegexesBytes

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

    • getParamTypeValue

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

    • getParamType

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

    • getCustomMetadataCount

      public int getCustomMetadataCount()
      Description copied from interface: ParameterMetadataOrBuilder
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;
      Specified by:
      getCustomMetadataCount in interface ParameterMetadataOrBuilder

    • containsCustomMetadata

      public boolean containsCustomMetadata(String key)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;
      Specified by:
      containsCustomMetadata in interface ParameterMetadataOrBuilder

    • getCustomMetadata

      @Deprecated public Map<String,String> getCustomMetadata()
      Deprecated.
      Use getCustomMetadataMap() instead.
      Specified by:
      getCustomMetadata in interface ParameterMetadataOrBuilder

    • getCustomMetadataMap

      public Map<String,String> getCustomMetadataMap()
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;
      Specified by:
      getCustomMetadataMap in interface ParameterMetadataOrBuilder

    • getCustomMetadataOrDefault

      public String getCustomMetadataOrDefault(String key, String defaultValue)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;
      Specified by:
      getCustomMetadataOrDefault in interface ParameterMetadataOrBuilder

    • getCustomMetadataOrThrow

      public String getCustomMetadataOrThrow(String key)
       Optional. Additional metadata for describing this parameter.
      map<string, string> custom_metadata = 7;
      Specified by:
      getCustomMetadataOrThrow in interface ParameterMetadataOrBuilder

    • getGroupName

      public 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;
      Specified by:
      getGroupName in interface ParameterMetadataOrBuilder
      Returns:
      The groupName.

    • getGroupNameBytes

      public 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;
      Specified by:
      getGroupNameBytes in interface ParameterMetadataOrBuilder
      Returns:
      The bytes for groupName.

    • getParentName

      public 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;
      Specified by:
      getParentName in interface ParameterMetadataOrBuilder
      Returns:
      The parentName.

    • getParentNameBytes

      public 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;
      Specified by:
      getParentNameBytes in interface ParameterMetadataOrBuilder
      Returns:
      The bytes for parentName.

    • getParentTriggerValuesList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getParentTriggerValuesList in interface ParameterMetadataOrBuilder
      Returns:
      A list containing the parentTriggerValues.

    • getParentTriggerValuesCount

      public 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;
      Specified by:
      getParentTriggerValuesCount in interface ParameterMetadataOrBuilder
      Returns:
      The count of parentTriggerValues.

    • getParentTriggerValues

      public 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;
      Specified by:
      getParentTriggerValues in interface ParameterMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The parentTriggerValues at the given index.

    • getParentTriggerValuesBytes

      public 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;
      Specified by:
      getParentTriggerValuesBytes in interface ParameterMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the parentTriggerValues at the given index.

    • getEnumOptionsList

      public List<ParameterMetadataEnumOption> getEnumOptionsList()
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
      Specified by:
      getEnumOptionsList in interface ParameterMetadataOrBuilder

    • getEnumOptionsOrBuilderList

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

    • getEnumOptionsCount

      public int getEnumOptionsCount()
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
      Specified by:
      getEnumOptionsCount in interface ParameterMetadataOrBuilder

    • getEnumOptions

      public ParameterMetadataEnumOption getEnumOptions(int index)
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
      Specified by:
      getEnumOptions in interface ParameterMetadataOrBuilder

    • getEnumOptionsOrBuilder

      public ParameterMetadataEnumOptionOrBuilder getEnumOptionsOrBuilder(int index)
       Optional. The options shown when ENUM ParameterType is specified.
      repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
      Specified by:
      getEnumOptionsOrBuilder in interface ParameterMetadataOrBuilder

    • getDefaultValue

      public 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;
      Specified by:
      getDefaultValue in interface ParameterMetadataOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      public 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;
      Specified by:
      getDefaultValueBytes in interface ParameterMetadataOrBuilder
      Returns:
      The bytes for defaultValue.

    • getHiddenUi

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ParameterMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ParameterMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ParameterMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ParameterMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ParameterMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ParameterMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ParameterMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ParameterMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ParameterMetadata.Builder newBuilder()

    • newBuilder

      public static ParameterMetadata.Builder newBuilder(ParameterMetadata prototype)

    • toBuilder

      public ParameterMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ParameterMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ParameterMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ParameterMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<ParameterMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ParameterMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder