Class ParameterMetadata.Builder (0.10.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class ParameterMetadata.Builder extends GeneratedMessageV3.Builder<ParameterMetadata.Builder> implements ParameterMetadataOrBuilder

Metadata for a specific parameter.

Protobuf type google.dataflow.v1beta3.ParameterMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The regexes to add.

Returns
TypeDescription
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
NameDescription
valueString

The regexes to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the regexes to add.

Returns
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ParameterMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

build()

public ParameterMetadata build()
Returns
TypeDescription
ParameterMetadata

buildPartial()

public ParameterMetadata buildPartial()
Returns
TypeDescription
ParameterMetadata

clear()

public ParameterMetadata.Builder clear()
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

clearCustomMetadata()

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

clearField(Descriptors.FieldDescriptor field)

public ParameterMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

clearHelpText()

public ParameterMetadata.Builder clearHelpText()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
TypeDescription
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
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

clearLabel()

public ParameterMetadata.Builder clearLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

clearName()

public ParameterMetadata.Builder clearName()

Required. The name of the parameter.

string name = 1;

Returns
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ParameterMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

clearParamType()

public ParameterMetadata.Builder clearParamType()

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

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

Returns
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

clearRegexes()

public ParameterMetadata.Builder clearRegexes()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
TypeDescription
ParameterMetadata.Builder

This builder for chaining.

clone()

public ParameterMetadata.Builder clone()
Returns
TypeDescription
ParameterMetadata.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getMutableCustomMetadata()

public Map<String,String> getMutableCustomMetadata()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

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.

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.

Ret