- 0.67.0 (latest)
- 0.66.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.5.0
public interface ParameterMetadataOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 |
|
getDefaultValue()
public abstract String getDefaultValue()Optional. The default values will pre-populate the parameter with the given value from the proto. If default_value is left empty, the parameter will be populated with a default of the relevant type, e.g. false for a boolean.
string default_value = 12;
| Returns | |
|---|---|
| Type | Description |
String |
The defaultValue. |
getDefaultValueBytes()
public abstract ByteString getDefaultValueBytes()Optional. The default values will pre-populate the parameter with the given value from the proto. If default_value is left empty, the parameter will be populated with a default of the relevant type, e.g. false for a boolean.
string default_value = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultValue. |
getEnumOptions(int index)
public abstract ParameterMetadataEnumOption getEnumOptions(int index)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadataEnumOption |
|
getEnumOptionsCount()
public abstract int getEnumOptionsCount()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEnumOptionsList()
public abstract List<ParameterMetadataEnumOption> getEnumOptionsList()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns | |
|---|---|
| Type | Description |
List<ParameterMetadataEnumOption> |
|
getEnumOptionsOrBuilder(int index)
public abstract ParameterMetadataEnumOptionOrBuilder getEnumOptionsOrBuilder(int index)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadataEnumOptionOrBuilder |
|
getEnumOptionsOrBuilderList()
public abstract List<? extends ParameterMetadataEnumOptionOrBuilder> getEnumOptionsOrBuilderList()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.dataflow.v1beta3.ParameterMetadataEnumOptionOrBuilder> |
|
getGroupName()
public abstract String getGroupName()Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
string group_name = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The groupName. |
getGroupNameBytes()
public abstract ByteString getGroupNameBytes()Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
string group_name = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for groupName. |
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. |
getHiddenUi()
public abstract boolean getHiddenUi()Optional. Whether the parameter should be hidden in the UI.
bool hidden_ui = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
The hiddenUi. |
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. |
getParentName()
public abstract String getParentName()Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
string parent_name = 9;
| Returns | |
|---|---|
| Type | Description |
String |
The parentName. |
getParentNameBytes()
public abstract ByteString getParentNameBytes()Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
string parent_name = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parentName. |
getParentTriggerValues(int index)
public abstract String getParentTriggerValues(int index)Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
repeated string parent_trigger_values = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The parentTriggerValues at the given index. |
getParentTriggerValuesBytes(int index)
public abstract ByteString getParentTriggerValuesBytes(int index)Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
repeated string parent_trigger_values = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the parentTriggerValues at the given index. |
getParentTriggerValuesCount()
public abstract int getParentTriggerValuesCount()Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
repeated string parent_trigger_values = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The count of parentTriggerValues. |
getParentTriggerValuesList()
public abstract List<String> getParentTriggerValuesList()Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
repeated string parent_trigger_values = 10;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the parentTriggerValues. |
getRegexes(int index)
public abstract String getRegexes(int index)Optional. Regexes that the parameter must match.
repeated string regexes = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 |
intThe 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. |