Interface ParameterMetadataOrBuilder (0.22.0)

public interface ParameterMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCustomMetadata(String key)

public abstract 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 abstract Map<String,String> getCustomMetadata()
Returns
TypeDescription
Map<String,String>

getCustomMetadataCount()

public abstract int getCustomMetadataCount()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
TypeDescription
int

getCustomMetadataMap()

public abstract 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 abstract 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 abstract String getCustomMetadataOrThrow(String key)

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getHelpText()

public abstract String getHelpText()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
TypeDescription
String

The helpText.

getHelpTextBytes()

public abstract ByteString getHelpTextBytes()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
TypeDescription
ByteString

The bytes for helpText.

getIsOptional()

public abstract boolean getIsOptional()

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

bool is_optional = 4;

Returns
TypeDescription
boolean

The isOptional.

getLabel()

public abstract String getLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
TypeDescription
String

The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

Required. The label to display for the parameter.

string label = 2;

Returns
TypeDescription
ByteString

The bytes for label.

getName()

public abstract String getName()

Required. The name of the parameter.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The name of the parameter.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParamType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getRegexesCount()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
TypeDescription
int

The count of regexes.

getRegexesList()

public abstract List<String> getRegexesList()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
TypeDescription
List<String>

A list containing the regexes.