Class TemplateParameter (3.1.0) 

public sealed class TemplateParameter : IMessage<TemplateParameter>, IEquatable<TemplateParameter>, IDeepCloneable<TemplateParameter>, IBufferMessage, IMessage

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)

Inheritance

Object > TemplateParameter

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

TemplateParameter()

public TemplateParameter()

TemplateParameter(TemplateParameter)

public TemplateParameter(TemplateParameter other)
Parameter
NameDescription
otherTemplateParameter

Properties

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

Fields

public RepeatedField<string> Fields { get; }

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][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
Property Value
TypeDescription
RepeatedField<String>

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
String

Validation

public ParameterValidation Validation { get; set; }

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

Property Value
TypeDescription
ParameterValidation