- 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 static final class ParameterMetadata.Builder extends GeneratedMessageV3.Builder<ParameterMetadata.Builder> implements ParameterMetadataOrBuilderMetadata for a specific parameter.
Protobuf type google.dataflow.v1beta3.ParameterMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ParameterMetadata.BuilderImplements
ParameterMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEnumOptions(Iterable<? extends ParameterMetadataEnumOption> values)
public ParameterMetadata.Builder addAllEnumOptions(Iterable<? extends ParameterMetadataEnumOption> values)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.dataflow.v1beta3.ParameterMetadataEnumOption> |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
addAllParentTriggerValues(Iterable<String> values)
public ParameterMetadata.Builder addAllParentTriggerValues(Iterable<String> values)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 |
values |
Iterable<String>The parentTriggerValues to add. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
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. |
addEnumOptions(ParameterMetadataEnumOption value)
public ParameterMetadata.Builder addEnumOptions(ParameterMetadataEnumOption value)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ParameterMetadataEnumOption |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
addEnumOptions(ParameterMetadataEnumOption.Builder builderForValue)
public ParameterMetadata.Builder addEnumOptions(ParameterMetadataEnumOption.Builder builderForValue)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ParameterMetadataEnumOption.Builder |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
addEnumOptions(int index, ParameterMetadataEnumOption value)
public ParameterMetadata.Builder addEnumOptions(int index, ParameterMetadataEnumOption value)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterMetadataEnumOption |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
addEnumOptions(int index, ParameterMetadataEnumOption.Builder builderForValue)
public ParameterMetadata.Builder addEnumOptions(int index, ParameterMetadataEnumOption.Builder builderForValue)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterMetadataEnumOption.Builder |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
addEnumOptionsBuilder()
public ParameterMetadataEnumOption.Builder addEnumOptionsBuilder()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns | |
|---|---|
| Type | Description |
ParameterMetadataEnumOption.Builder |
|
addEnumOptionsBuilder(int index)
public ParameterMetadataEnumOption.Builder addEnumOptionsBuilder(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.Builder |
|
addParentTriggerValues(String value)
public ParameterMetadata.Builder addParentTriggerValues(String value)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 |
value |
StringThe parentTriggerValues to add. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
addParentTriggerValuesBytes(ByteString value)
public ParameterMetadata.Builder addParentTriggerValuesBytes(ByteString value)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 |
value |
ByteStringThe bytes of the parentTriggerValues 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
|
clearCustomMetadata()
public ParameterMetadata.Builder clearCustomMetadata()| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
clearDefaultValue()
public ParameterMetadata.Builder clearDefaultValue()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 |
ParameterMetadata.Builder |
This builder for chaining. |
clearEnumOptions()
public ParameterMetadata.Builder clearEnumOptions()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| 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 |
|
clearGroupName()
public ParameterMetadata.Builder clearGroupName()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 |
ParameterMetadata.Builder |
This builder for chaining. |
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. |
clearHiddenUi()
public ParameterMetadata.Builder clearHiddenUi()Optional. Whether the parameter should be hidden in the UI.
bool hidden_ui = 13;
| 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 |
|
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. |
clearParentName()
public ParameterMetadata.Builder clearParentName()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 |
ParameterMetadata.Builder |
This builder for chaining. |
clearParentTriggerValues()
public ParameterMetadata.Builder clearParentTriggerValues()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 |
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 |
|
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() (deprecated)
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 |
|
getDefaultValue()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEnumOptions(int index)
public 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 |
|
getEnumOptionsBuilder(int index)
public ParameterMetadataEnumOption.Builder getEnumOptionsBuilder(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.Builder |
|
getEnumOptionsBuilderList()
public List<ParameterMetadataEnumOption.Builder> getEnumOptionsBuilderList()Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getEnumOptionsCount()
public 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 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 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 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 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 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 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. |
getHiddenUi()
public boolean getHiddenUi()Optional. Whether the parameter should be hidden in the UI.
bool hidden_ui = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
The hiddenUi. |
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() (deprecated)
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. |
getParentName()
public 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 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the parentTriggerValues. |
getRegexes(int index)
public 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 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 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 |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ParameterMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ParameterMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
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 |
|
removeEnumOptions(int index)
public ParameterMetadata.Builder removeEnumOptions(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 |
ParameterMetadata.Builder |
|
setDefaultValue(String value)
public ParameterMetadata.Builder setDefaultValue(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setDefaultValueBytes(ByteString value)
public ParameterMetadata.Builder setDefaultValueBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setEnumOptions(int index, ParameterMetadataEnumOption value)
public ParameterMetadata.Builder setEnumOptions(int index, ParameterMetadataEnumOption value)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterMetadataEnumOption |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|
setEnumOptions(int index, ParameterMetadataEnumOption.Builder builderForValue)
public ParameterMetadata.Builder setEnumOptions(int index, ParameterMetadataEnumOption.Builder builderForValue)Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterMetadataEnumOption.Builder |
| 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 |
|
setGroupName(String value)
public ParameterMetadata.Builder setGroupName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe groupName to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setGroupNameBytes(ByteString value)
public ParameterMetadata.Builder setGroupNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for groupName to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
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 |
StringThe 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 |
ByteStringThe bytes for helpText to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setHiddenUi(boolean value)
public ParameterMetadata.Builder setHiddenUi(boolean value)Optional. Whether the parameter should be hidden in the UI.
bool hidden_ui = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe hiddenUi 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 |
booleanThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
ParameterTypeThe 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 |
intThe enum numeric value on the wire for paramType to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setParentName(String value)
public ParameterMetadata.Builder setParentName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parentName to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setParentNameBytes(ByteString value)
public ParameterMetadata.Builder setParentNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parentName to set. |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
This builder for chaining. |
setParentTriggerValues(int index, String value)
public ParameterMetadata.Builder setParentTriggerValues(int index, String value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe parentTriggerValues 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 |
intThe index to set the value at. |
value |
StringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ParameterMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ParameterMetadata.Builder |
|