Package com.google.dataflow.v1beta3

Class ParameterMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

public final class ParameterMetadata
extends com.google.protobuf.GeneratedMessageV3
implements ParameterMetadataOrBuilder

 Metadata for a specific parameter.
 

Protobuf type google.dataflow.v1beta3.ParameterMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterMetadata.Builder	Metadata for a specific parameter.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	CUSTOM_METADATA_FIELD_NUMBER
static int	HELP_TEXT_FIELD_NUMBER
static int	IS_OPTIONAL_FIELD_NUMBER
static int	LABEL_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARAM_TYPE_FIELD_NUMBER
static int	REGEXES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	containsCustomMetadata(String key)	Optional.
boolean	equals(Object obj)
Map<String,String>	getCustomMetadata()	Deprecated.
int	getCustomMetadataCount()	Optional.
Map<String,String>	getCustomMetadataMap()	Optional.
String	getCustomMetadataOrDefault(String key, String defaultValue)	Optional.
String	getCustomMetadataOrThrow(String key)	Optional.
static ParameterMetadata	getDefaultInstance()
ParameterMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getHelpText()	Required.
com.google.protobuf.ByteString	getHelpTextBytes()	Required.
boolean	getIsOptional()	Optional.
String	getLabel()	Required.
com.google.protobuf.ByteString	getLabelBytes()	Required.
String	getName()	Required.
com.google.protobuf.ByteString	getNameBytes()	Required.
ParameterType	getParamType()	Optional.
int	getParamTypeValue()	Optional.
com.google.protobuf.Parser<ParameterMetadata>	getParserForType()
String	getRegexes(int index)	Optional.
com.google.protobuf.ByteString	getRegexesBytes(int index)	Optional.
int	getRegexesCount()	Optional.
com.google.protobuf.ProtocolStringList	getRegexesList()	Optional.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static ParameterMetadata.Builder	newBuilder()
static ParameterMetadata.Builder	newBuilder(ParameterMetadata prototype)
ParameterMetadata.Builder	newBuilderForType()
protected ParameterMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ParameterMetadata	parseDelimitedFrom(InputStream input)
static ParameterMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterMetadata	parseFrom(byte[] data)
static ParameterMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterMetadata	parseFrom(com.google.protobuf.ByteString data)
static ParameterMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static ParameterMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterMetadata	parseFrom(InputStream input)
static ParameterMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterMetadata	parseFrom(ByteBuffer data)
static ParameterMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ParameterMetadata>	parser()
ParameterMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

See Also:

Constant Field Values

HELP_TEXT_FIELD_NUMBER

public static final int HELP_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

IS_OPTIONAL_FIELD_NUMBER

public static final int IS_OPTIONAL_FIELD_NUMBER

See Also:

Constant Field Values

REGEXES_FIELD_NUMBER

public static final int REGEXES_FIELD_NUMBER

See Also:

Constant Field Values

PARAM_TYPE_FIELD_NUMBER

public static final int PARAM_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_METADATA_FIELD_NUMBER

public static final int CUSTOM_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public ParameterMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder