Class ParameterMetadata (0.52.0)

Version 0.52.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public final class ParameterMetadata extends GeneratedMessageV3 implements ParameterMetadataOrBuilder

Metadata for a specific parameter.

Protobuf type google.dataflow.v1beta3.ParameterMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ParameterMetadata

Implements

ParameterMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOM_METADATA_FIELD_NUMBER

public static final int CUSTOM_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

HELP_TEXT_FIELD_NUMBER

public static final int HELP_TEXT_FIELD_NUMBER

Field Value
Type	Description
int

IS_OPTIONAL_FIELD_NUMBER

public static final int IS_OPTIONAL_FIELD_NUMBER

Field Value
Type	Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PARAM_TYPE_FIELD_NUMBER

public static final int PARAM_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

REGEXES_FIELD_NUMBER

public static final int REGEXES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ParameterMetadata getDefaultInstance()

Returns
Type	Description
ParameterMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ParameterMetadata.Builder newBuilder()

Returns
Type	Description
ParameterMetadata.Builder

newBuilder(ParameterMetadata prototype)

public static ParameterMetadata.Builder newBuilder(ParameterMetadata prototype)

Parameter
Name	Description
prototype	ParameterMetadata

Returns
Type	Description
ParameterMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ParameterMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ParameterMetadata parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ParameterMetadata parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ParameterMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ParameterMetadata parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ParameterMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ParameterMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ParameterMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ParameterMetadata> parser()

Returns
Type	Description
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
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCustomMetadata() (deprecated)

public Map<String,String> getCustomMetadata()

Use #getCustomMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getCustomMetadataCount()

public int getCustomMetadataCount()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
Type	Description
int

getCustomMetadataMap()

public Map<String,String> getCustomMetadataMap()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
Type	Description
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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getCustomMetadataOrThrow(String key)

public String getCustomMetadataOrThrow(String key)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getDefaultInstanceForType()

public ParameterMetadata getDefaultInstanceForType()

Returns
Type	Description
ParameterMetadata

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
Type	Description
ByteString	The bytes for helpText.

getIsOptional()

public boolean getIsOptional()

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

bool is_optional = 4;

Returns
Type	Description
boolean	The isOptional.

getLabel()

public String getLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
Type	Description
String	The label.

getLabelBytes()

public ByteString getLabelBytes()

Required. The label to display for the parameter.

string label = 2;

Returns
Type	Description
ByteString	The bytes for label.

getName()

public String getName()

Required. The name of the parameter.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the parameter.

string name = 1;

Returns
Type	Description
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
Type	Description
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
Type	Description
int	The enum numeric value on the wire for paramType.

getParserForType()

public Parser<ParameterMetadata> getParserForType()

Returns
Type	Description
Parser<ParameterMetadata>

Overrides

GeneratedMessageV3.getParserForType()

getRegexes(int index)

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.

getRegexesBytes(int 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.

getRegexesCount()

public int getRegexesCount()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
Type	Description
int	The count of regexes.

getRegexesList()

public ProtocolStringList getRegexesList()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
Type	Description
ProtocolStringList	A list containing the regexes.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ParameterMetadata.Builder newBuilderForType()

Returns
Type	Description
ParameterMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ParameterMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ParameterMetadata.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ParameterMetadata.Builder toBuilder()

Returns
Type	Description
ParameterMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException