Class ParameterMetadata (0.26.0)

public final class ParameterMetadata extends GeneratedMessageV3 implements ParameterMetadataOrBuilder

Metadata for a specific parameter.

Protobuf type google.dataflow.v1beta3.ParameterMetadata

Static Fields

CUSTOM_METADATA_FIELD_NUMBER

public static final int CUSTOM_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

HELP_TEXT_FIELD_NUMBER

public static final int HELP_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

IS_OPTIONAL_FIELD_NUMBER

public static final int IS_OPTIONAL_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARAM_TYPE_FIELD_NUMBER

public static final int PARAM_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

REGEXES_FIELD_NUMBER

public static final int REGEXES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ParameterMetadata getDefaultInstance()
Returns
TypeDescription
ParameterMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ParameterMetadata.Builder newBuilder()
Returns
TypeDescription
ParameterMetadata.Builder

newBuilder(ParameterMetadata prototype)

public static ParameterMetadata.Builder newBuilder(ParameterMetadata prototype)
Parameter
NameDescription
prototypeParameterMetadata
Returns
TypeDescription
ParameterMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ParameterMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ParameterMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ParameterMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ParameterMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ParameterMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ParameterMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ParameterMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ParameterMetadata> parser()
Returns
TypeDescription
Parser<ParameterMetadata>

Methods

containsCustomMetadata(String key)

public boolean containsCustomMetadata(String key)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCustomMetadata()

public Map<String,String> getCustomMetadata()
Returns
TypeDescription
Map<String,String>

getCustomMetadataCount()

public int getCustomMetadataCount()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
TypeDescription
int

getCustomMetadataMap()

public Map<String,String> getCustomMetadataMap()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
TypeDescription
Map<String,String>

getCustomMetadataOrDefault(String key, String defaultValue)

public String getCustomMetadataOrDefault(String key, String defaultValue)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getCustomMetadataOrThrow(String key)

public String getCustomMetadataOrThrow(String key)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public ParameterMetadata getDefaultInstanceForType()
Returns
TypeDescription
ParameterMetadata

getHelpText()

public String getHelpText()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
TypeDescription
String

The helpText.

getHelpTextBytes()

public ByteString getHelpTextBytes()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
TypeDescription
ByteString

The bytes for helpText.

getIsOptional()

public boolean getIsOptional()

Optional. Whether the parameter is optional. Defaults to false.

bool is_optional = 4;

Returns
TypeDescription
boolean

The isOptional.

getLabel()

public String getLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
TypeDescription
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

Required. The label to display for the parameter.

string label = 2;

Returns
TypeDescription
ByteString

The bytes for label.

getName()

public String getName()

Required. The name of the parameter.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the parameter.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParamType()

public ParameterType getParamType()

Optional. The type of the parameter. Used for selecting input picker.

.google.dataflow.v1beta3.ParameterType param_type = 6;

Returns
TypeDescription
ParameterType

The paramType.

getParamTypeValue()

public int getParamTypeValue()

Optional. The type of the parameter. Used for selecting input picker.

.google.dataflow.v1beta3.ParameterType param_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for paramType.

getParserForType()

public Parser<ParameterMetadata> getParserForType()
Returns
TypeDescription
Parser<ParameterMetadata>
Overrides

getRegexes(int index)

public String getRegexes(int index)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The regexes at the given index.

getRegexesBytes(int index)

public ByteString getRegexesBytes(int index)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the regexes at the given index.

getRegexesCount()

public int getRegexesCount()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
TypeDescription
int

The count of regexes.

getRegexesList()

public ProtocolStringList getRegexesList()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the regexes.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ParameterMetadata.Builder newBuilderForType()
Returns
TypeDescription
ParameterMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ParameterMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ParameterMetadata.Builder toBuilder()
Returns
TypeDescription
ParameterMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException