public final class ParameterMetadata extends GeneratedMessageV3 implements ParameterMetadataOrBuilder
Metadata for a specific parameter.
Protobuf type google.dataflow.v1beta3.ParameterMetadata
Static Fields
public static final int CUSTOM_METADATA_FIELD_NUMBER
Field Value
HELP_TEXT_FIELD_NUMBER
public static final int HELP_TEXT_FIELD_NUMBER
Field Value
public static final int IS_OPTIONAL_FIELD_NUMBER
Field Value
public static final int LABEL_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int PARAM_TYPE_FIELD_NUMBER
Field Value
public static final int REGEXES_FIELD_NUMBER
Field Value
Static Methods
public static ParameterMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ParameterMetadata.Builder newBuilder()
Returns
public static ParameterMetadata.Builder newBuilder(ParameterMetadata prototype)
Parameter
Returns
public static ParameterMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ParameterMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ParameterMetadata parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static ParameterMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ParameterMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ParameterMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ParameterMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ParameterMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ParameterMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ParameterMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ParameterMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ParameterMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ParameterMetadata> parser()
Returns
Methods
public boolean containsCustomMetadata(String key)
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
Parameter
Returns
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Map<String,String> getCustomMetadata()
Returns
public int getCustomMetadataCount()
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
Returns
public Map<String,String> getCustomMetadataMap()
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
Returns
public String getCustomMetadataOrDefault(String key, String defaultValue)
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
Parameters
Returns
public String getCustomMetadataOrThrow(String key)
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
Parameter
Returns
public ParameterMetadata getDefaultInstanceForType()
Returns
getHelpText()
public String getHelpText()
Required. The help text to display for the parameter.
string help_text = 3;
Returns
Type | Description |
String | The helpText.
|
getHelpTextBytes()
public ByteString getHelpTextBytes()
Required. The help text to display for the parameter.
string help_text = 3;
Returns
public boolean getIsOptional()
Optional. Whether the parameter is optional. Defaults to false.
bool is_optional = 4;
Returns
Type | Description |
boolean | The isOptional.
|
Required. The label to display for the parameter.
string label = 2;
Returns
Type | Description |
String | The label.
|
public ByteString getLabelBytes()
Required. The label to display for the parameter.
string label = 2;
Returns
Required. The name of the parameter.
string name = 1;
Returns
Type | Description |
String | The name.
|
public ByteString getNameBytes()
Required. The name of the parameter.
string name = 1;
Returns
public ParameterType getParamType()
Optional. The type of the parameter.
Used for selecting input picker.
.google.dataflow.v1beta3.ParameterType param_type = 6;
Returns
public int getParamTypeValue()
Optional. The type of the parameter.
Used for selecting input picker.
.google.dataflow.v1beta3.ParameterType param_type = 6;
Returns
Type | Description |
int | The enum numeric value on the wire for paramType.
|
public Parser<ParameterMetadata> getParserForType()
Returns
Overrides
public String getRegexes(int index)
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
Parameter
Name | Description |
index | int
The index of the element to return.
|
Returns
Type | Description |
String | The regexes at the given index.
|
public ByteString getRegexesBytes(int index)
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
Parameter
Name | Description |
index | int
The index of the value to return.
|
Returns
Type | Description |
ByteString | The bytes of the regexes at the given index.
|
public int getRegexesCount()
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
Returns
Type | Description |
int | The count of regexes.
|
public ProtocolStringList getRegexesList()
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
Returns
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ParameterMetadata.Builder newBuilderForType()
Returns
protected ParameterMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ParameterMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions