Class ParameterMetadata.Builder (0.24.0)

public static final class ParameterMetadata.Builder extends GeneratedMessageV3.Builder<ParameterMetadata.Builder> implements ParameterMetadataOrBuilder

Metadata for a specific parameter.

Protobuf type google.dataflow.v1beta3.ParameterMetadata

Inheritance

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

Implements

ParameterMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllRegexes(Iterable<String> values)

public ParameterMetadata.Builder addAllRegexes(Iterable<String> values)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameter
Name	Description
`values`	`Iterable<String>` The regexes to add.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

addRegexes(String value)

public ParameterMetadata.Builder addRegexes(String value)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameter
Name	Description
`value`	`String` The regexes to add.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

addRegexesBytes(ByteString value)

public ParameterMetadata.Builder addRegexesBytes(ByteString value)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes of the regexes to add.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ParameterMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ParameterMetadata build()

Returns
Type	Description
`ParameterMetadata`

buildPartial()

public ParameterMetadata buildPartial()

Returns
Type	Description
`ParameterMetadata`

clear()

public ParameterMetadata.Builder clear()

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCustomMetadata()

public ParameterMetadata.Builder clearCustomMetadata()

Returns
Type	Description
`ParameterMetadata.Builder`

clearField(Descriptors.FieldDescriptor field)

public ParameterMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHelpText()

public ParameterMetadata.Builder clearHelpText()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clearIsOptional()

public ParameterMetadata.Builder clearIsOptional()

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

bool is_optional = 4;

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clearLabel()

public ParameterMetadata.Builder clearLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clearName()

public ParameterMetadata.Builder clearName()

Required. The name of the parameter.

string name = 1;

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ParameterMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParamType()

public ParameterMetadata.Builder clearParamType()

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

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

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clearRegexes()

public ParameterMetadata.Builder clearRegexes()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

clone()

public ParameterMetadata.Builder clone()

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getCustomMetadata()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getMutableCustomMetadata()

public Map<String,String> getMutableCustomMetadata()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ParameterMetadata other)

public ParameterMetadata.Builder mergeFrom(ParameterMetadata other)

Parameter
Name	Description
`other`	`ParameterMetadata`

Returns
Type	Description
`ParameterMetadata.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ParameterMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ParameterMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ParameterMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllCustomMetadata(Map<String,String> values)

public ParameterMetadata.Builder putAllCustomMetadata(Map<String,String> values)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`ParameterMetadata.Builder`

putCustomMetadata(String key, String value)

public ParameterMetadata.Builder putCustomMetadata(String key, String value)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`ParameterMetadata.Builder`

removeCustomMetadata(String key)

public ParameterMetadata.Builder removeCustomMetadata(String key)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`ParameterMetadata.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ParameterMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHelpText(String value)

public ParameterMetadata.Builder setHelpText(String value)

Required. The help text to display for the parameter.

string help_text = 3;

Parameter
Name	Description
`value`	`String` The helpText to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setHelpTextBytes(ByteString value)

public ParameterMetadata.Builder setHelpTextBytes(ByteString value)

Required. The help text to display for the parameter.

string help_text = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for helpText to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setIsOptional(boolean value)

public ParameterMetadata.Builder setIsOptional(boolean value)

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

bool is_optional = 4;

Parameter
Name	Description
`value`	`boolean` The isOptional to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setLabel(String value)

public ParameterMetadata.Builder setLabel(String value)

Required. The label to display for the parameter.

string label = 2;

Parameter
Name	Description
`value`	`String` The label to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setLabelBytes(ByteString value)

public ParameterMetadata.Builder setLabelBytes(ByteString value)

Required. The label to display for the parameter.

string label = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for label to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setName(String value)

public ParameterMetadata.Builder setName(String value)

Required. The name of the parameter.

string name = 1;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public ParameterMetadata.Builder setNameBytes(ByteString value)

Required. The name of the parameter.

string name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setParamType(ParameterType value)

public ParameterMetadata.Builder setParamType(ParameterType value)

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

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

Parameter
Name	Description
`value`	`ParameterType` The paramType to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setParamTypeValue(int value)

public ParameterMetadata.Builder setParamTypeValue(int value)

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

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for paramType to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setRegexes(int index, String value)

public ParameterMetadata.Builder setRegexes(int index, String value)

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The regexes to set.

Returns
Type	Description
`ParameterMetadata.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ParameterMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ParameterMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ParameterMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)