Interface ParameterMetadataOrBuilder (0.59.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
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getCustomMetadata() (deprecated)

public abstract Map<String,String> getCustomMetadata()

Use #getCustomMetadataMap() instead.

Returns
Type	Description
`Map<String,String>`

getCustomMetadataCount()

public abstract int getCustomMetadataCount()

Optional. Additional metadata for describing this parameter.

map<string, string> custom_metadata = 7;

Returns
Type	Description
`int`

getCustomMetadataMap()

public abstract 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 abstract 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 abstract 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`

getHelpText()

public abstract String getHelpText()

Required. The help text to display for the parameter.

string help_text = 3;

Returns
Type	Description
`String`	The helpText.

getHelpTextBytes()

public abstract 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 abstract boolean getIsOptional()

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

bool is_optional = 4;

Returns
Type	Description
`boolean`	The isOptional.

getLabel()

public abstract String getLabel()

Required. The label to display for the parameter.

string label = 2;

Returns
Type	Description
`String`	The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

Required. The label to display for the parameter.

string label = 2;

Returns
Type	Description
`ByteString`	The bytes for label.

getName()

public abstract String getName()

Required. The name of the parameter.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The name of the parameter.

string name = 1;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
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 abstract 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 abstract int getRegexesCount()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
Type	Description
`int`	The count of regexes.

getRegexesList()

public abstract List<String> getRegexesList()

Optional. Regexes that the parameter must match.

repeated string regexes = 5;

Returns
Type	Description
`List<String>`	A list containing the regexes.