public final class ParameterMetadata extends GeneratedMessageV3 implements ParameterMetadataOrBuilder
Metadata for a specific parameter.
Protobuf type google.dataflow.v1beta3.ParameterMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CUSTOM_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DEFAULT_VALUE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENUM_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GROUP_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HELP_TEXT_FIELD_NUMBER
public static final int HELP_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int HIDDEN_UI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IS_OPTIONAL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARAM_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_TRIGGER_VALUES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REGEXES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ParameterMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ParameterMetadata.Builder newBuilder()
public static ParameterMetadata.Builder newBuilder(ParameterMetadata prototype)
public static ParameterMetadata parseDelimitedFrom(InputStream input)
public static ParameterMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ParameterMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ParameterMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ParameterMetadata parseFrom(ByteString data)
public static ParameterMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ParameterMetadata parseFrom(CodedInputStream input)
public static ParameterMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ParameterMetadata parseFrom(InputStream input)
public static ParameterMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ParameterMetadata parseFrom(ByteBuffer data)
public static ParameterMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ParameterMetadata> parser()
Methods
public boolean containsCustomMetadata(String key)
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Map<String,String> getCustomMetadata()
public int getCustomMetadataCount()
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getCustomMetadataMap()
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
public String getCustomMetadataOrDefault(String key, String defaultValue)
Optional. Additional metadata for describing this parameter.
map<string, string> custom_metadata = 7;
| Returns |
| Type |
Description |
String |
|
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 |
|
public ParameterMetadata getDefaultInstanceForType()
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.
|
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.
|
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
|
public int getEnumOptionsCount()
Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
| Returns |
| Type |
Description |
int |
|
public List<ParameterMetadataEnumOption> getEnumOptionsList()
Optional. The options shown when ENUM ParameterType is specified.
repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;
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
|
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> |
|
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.
|
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.
|
public boolean getHiddenUi()
Optional. Whether the parameter should be hidden in the UI.
bool hidden_ui = 13;
| Returns |
| Type |
Description |
boolean |
The hiddenUi.
|
public boolean getIsOptional()
Optional. Whether the parameter is optional. Defaults to false.
bool is_optional = 4;
| Returns |
| Type |
Description |
boolean |
The isOptional.
|
Required. The label to display for the parameter.
string label = 2;
| Returns |
| Type |
Description |
String |
The label.
|
public ByteString getLabelBytes()
Required. The label to display for the parameter.
string label = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for label.
|
Required. The name of the parameter.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Required. The name of the parameter.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public ParameterType getParamType()
Optional. The type of the parameter.
Used for selecting input picker.
.google.dataflow.v1beta3.ParameterType param_type = 6;
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.
|
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.
|
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.
|
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 |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The parentTriggerValues at the given 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 |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the parentTriggerValues at the given index.
|
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.
|
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;
public Parser<ParameterMetadata> getParserForType()
Overrides
public 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.
|
public 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.
|
public int getRegexesCount()
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
| Returns |
| Type |
Description |
int |
The count of regexes.
|
public ProtocolStringList getRegexesList()
Optional. Regexes that the parameter must match.
repeated string regexes = 5;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public ParameterMetadata.Builder newBuilderForType()
protected ParameterMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ParameterMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
