public final class TemplateParameter extends GeneratedMessageV3 implements TemplateParameterOrBuilder
A configurable parameter that replaces one or more fields in the template.
Parameterizable fields:
- Labels
- File uris
- Job properties
- Job arguments
- Script variables
- Main class (in HadoopJob and SparkJob)
- Zone (in ClusterSelector)
Protobuf type google.cloud.dataproc.v1.TemplateParameter
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
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VALIDATION_FIELD_NUMBER
public static final int VALIDATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static TemplateParameter getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TemplateParameter.Builder newBuilder()
newBuilder(TemplateParameter prototype)
public static TemplateParameter.Builder newBuilder(TemplateParameter prototype)
public static TemplateParameter parseDelimitedFrom(InputStream input)
public static TemplateParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TemplateParameter parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TemplateParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TemplateParameter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TemplateParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TemplateParameter parseFrom(CodedInputStream input)
public static TemplateParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TemplateParameter parseFrom(InputStream input)
public static TemplateParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TemplateParameter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TemplateParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TemplateParameter> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public TemplateParameter getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. Brief description of the parameter.
Must not exceed 1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Brief description of the parameter.
Must not exceed 1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getFields(int index)
public String getFields(int index)
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to a
google.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified as placement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
- labels['key']
- placement.clusterSelector.clusterLabels['key']
- placement.managedCluster.labels['key']
- placement.clusterSelector.clusterLabels['key']
- jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
- jobs['step-id'].hadoopJob.mainJarFileUri
- jobs['step-id'].hiveJob.queryFileUri
- jobs['step-id'].pySparkJob.mainPythonFileUri
- jobs['step-id'].hadoopJob.jarFileUris[0]
- jobs['step-id'].hadoopJob.archiveUris[0]
- jobs['step-id'].hadoopJob.fileUris[0]
- jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
- jobs['step-id'].sparkJob.args[0]
Other examples:
- jobs['step-id'].hadoopJob.properties['key']
- jobs['step-id'].hadoopJob.args[0]
- jobs['step-id'].hiveJob.scriptVariables['key']
- jobs['step-id'].hadoopJob.mainJarFileUri
- placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
placement.clusterSelector.clusterLabels
- jobs['step-id'].sparkJob.args
repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The fields at the given index.
|
getFieldsBytes(int index)
public ByteString getFieldsBytes(int index)
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to a
google.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified as placement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
- labels['key']
- placement.clusterSelector.clusterLabels['key']
- placement.managedCluster.labels['key']
- placement.clusterSelector.clusterLabels['key']
- jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
- jobs['step-id'].hadoopJob.mainJarFileUri
- jobs['step-id'].hiveJob.queryFileUri
- jobs['step-id'].pySparkJob.mainPythonFileUri
- jobs['step-id'].hadoopJob.jarFileUris[0]
- jobs['step-id'].hadoopJob.archiveUris[0]
- jobs['step-id'].hadoopJob.fileUris[0]
- jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
- jobs['step-id'].sparkJob.args[0]
Other examples:
- jobs['step-id'].hadoopJob.properties['key']
- jobs['step-id'].hadoopJob.args[0]
- jobs['step-id'].hiveJob.scriptVariables['key']
- jobs['step-id'].hadoopJob.mainJarFileUri
- placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
placement.clusterSelector.clusterLabels
- jobs['step-id'].sparkJob.args
repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the fields at the given index.
|
getFieldsCount()
public int getFieldsCount()
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to a
google.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified as placement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
- labels['key']
- placement.clusterSelector.clusterLabels['key']
- placement.managedCluster.labels['key']
- placement.clusterSelector.clusterLabels['key']
- jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
- jobs['step-id'].hadoopJob.mainJarFileUri
- jobs['step-id'].hiveJob.queryFileUri
- jobs['step-id'].pySparkJob.mainPythonFileUri
- jobs['step-id'].hadoopJob.jarFileUris[0]
- jobs['step-id'].hadoopJob.archiveUris[0]
- jobs['step-id'].hadoopJob.fileUris[0]
- jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
- jobs['step-id'].sparkJob.args[0]
Other examples:
- jobs['step-id'].hadoopJob.properties['key']
- jobs['step-id'].hadoopJob.args[0]
- jobs['step-id'].hiveJob.scriptVariables['key']
- jobs['step-id'].hadoopJob.mainJarFileUri
- placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
placement.clusterSelector.clusterLabels
- jobs['step-id'].sparkJob.args
repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
int | The count of fields.
|
getFieldsList()
public ProtocolStringList getFieldsList()
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to a
google.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified as placement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
- labels['key']
- placement.clusterSelector.clusterLabels['key']
- placement.managedCluster.labels['key']
- placement.clusterSelector.clusterLabels['key']
- jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
- jobs['step-id'].hadoopJob.mainJarFileUri
- jobs['step-id'].hiveJob.queryFileUri
- jobs['step-id'].pySparkJob.mainPythonFileUri
- jobs['step-id'].hadoopJob.jarFileUris[0]
- jobs['step-id'].hadoopJob.archiveUris[0]
- jobs['step-id'].hadoopJob.fileUris[0]
- jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
- jobs['step-id'].sparkJob.args[0]
Other examples:
- jobs['step-id'].hadoopJob.properties['key']
- jobs['step-id'].hadoopJob.args[0]
- jobs['step-id'].hiveJob.scriptVariables['key']
- jobs['step-id'].hadoopJob.mainJarFileUri
- placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
placement.clusterSelector.clusterLabels
- jobs['step-id'].sparkJob.args
repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
getName()
Required. Parameter name.
The parameter name is used as the key, and paired with the
parameter value, which are passed to the template when the template
is instantiated.
The name must contain only capital letters (A-Z), numbers (0-9), and
underscores (_), and must not start with a number. The maximum length is
40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. Parameter name.
The parameter name is used as the key, and paired with the
parameter value, which are passed to the template when the template
is instantiated.
The name must contain only capital letters (A-Z), numbers (0-9), and
underscores (_), and must not start with a number. The maximum length is
40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<TemplateParameter> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getValidation()
public ParameterValidation getValidation()
Optional. Validation rules to be applied to this parameter's value.
.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
getValidationOrBuilder()
public ParameterValidationOrBuilder getValidationOrBuilder()
Optional. Validation rules to be applied to this parameter's value.
.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
hasValidation()
public boolean hasValidation()
Optional. Validation rules to be applied to this parameter's value.
.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the validation field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TemplateParameter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TemplateParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public TemplateParameter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
