Class TemplateParameter.Builder (4.33.0)

Version 4.33.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public static final class TemplateParameter.Builder extends GeneratedMessageV3.Builder<TemplateParameter.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TemplateParameter.Builder

Implements

TemplateParameterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllFields(Iterable<String> values)

public TemplateParameter.Builder addAllFields(Iterable<String> values)

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
values	Iterable<String> The fields to add.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

addFields(String value)

public TemplateParameter.Builder addFields(String value)

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
value	String The fields to add.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

addFieldsBytes(ByteString value)

public TemplateParameter.Builder addFieldsBytes(ByteString value)

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
value	ByteString The bytes of the fields to add.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TemplateParameter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TemplateParameter build()

Returns
Type	Description
TemplateParameter

buildPartial()

public TemplateParameter buildPartial()

Returns
Type	Description
TemplateParameter

clear()

public TemplateParameter.Builder clear()

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescription()

public TemplateParameter.Builder clearDescription()

Optional. Brief description of the parameter. Must not exceed 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TemplateParameter.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFields()

public TemplateParameter.Builder clearFields()

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
TemplateParameter.Builder	This builder for chaining.

clearName()

public TemplateParameter.Builder clearName()

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
TemplateParameter.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TemplateParameter.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearValidation()

public TemplateParameter.Builder clearValidation()

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
TemplateParameter.Builder

clone()

public TemplateParameter.Builder clone()

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TemplateParameter getDefaultInstanceForType()

Returns
Type	Description
TemplateParameter

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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];

Returns
Type	Description
ProtocolStringList	A list containing the fields.

getName()

public String 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.

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];

Returns
Type	Description
ParameterValidation	The validation.

getValidationBuilder()

public ParameterValidation.Builder getValidationBuilder()

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
ParameterValidation.Builder

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];

Returns
Type	Description
ParameterValidationOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TemplateParameter other)

public TemplateParameter.Builder mergeFrom(TemplateParameter other)

Parameter
Name	Description
other	TemplateParameter

Returns
Type	Description
TemplateParameter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TemplateParameter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TemplateParameter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public TemplateParameter.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
TemplateParameter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TemplateParameter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeValidation(ParameterValidation value)

public TemplateParameter.Builder mergeValidation(ParameterValidation value)

Optional. Validation rules to be applied to this parameter's value.

.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ParameterValidation

Returns
Type	Description
TemplateParameter.Builder

setDescription(String value)

public TemplateParameter.Builder setDescription(String value)

Optional. Brief description of the parameter. Must not exceed 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public TemplateParameter.Builder setDescriptionBytes(ByteString value)

Optional. Brief description of the parameter. Must not exceed 1024 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TemplateParameter.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFields(int index, String value)

public TemplateParameter.Builder setFields(int index, String value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	String The fields to set.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

setName(String value)

public TemplateParameter.Builder setName(String value)

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];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

setNameBytes(ByteString value)

public TemplateParameter.Builder setNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
TemplateParameter.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TemplateParameter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TemplateParameter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TemplateParameter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setValidation(ParameterValidation value)

public TemplateParameter.Builder setValidation(ParameterValidation value)

Optional. Validation rules to be applied to this parameter's value.

.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ParameterValidation

Returns
Type	Description
TemplateParameter.Builder

setValidation(ParameterValidation.Builder builderForValue)

public TemplateParameter.Builder setValidation(ParameterValidation.Builder builderForValue)

Optional. Validation rules to be applied to this parameter's value.

.google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	ParameterValidation.Builder

Returns
Type	Description
TemplateParameter.Builder