Struct TemplateParameter

pub struct TemplateParameter {
    pub description: Option<String>,
    pub fields: Option<Vec<String>>,
    pub name: Option<String>,
    pub validation: Option<ParameterValidation>,
}

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)

This type is not used in any activity, and only used as part of another schema.

Fields

description: Option<String>

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

fields: Option<Vec<String>>

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.jarFileUris0 jobs’step-id’.hadoopJob.archiveUris0 jobs’step-id’.hadoopJob.fileUris0 jobs’step-id’.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs’step-id’.sparkJob.args0 Other examples: jobs’step-id’.hadoopJob.properties’key’ jobs’step-id’.hadoopJob.args0 jobs’step-id’.hiveJob.scriptVariables’key’ jobs’step-id’.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt 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

name: Option<String>

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.

validation: Option<ParameterValidation>

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

Trait Implementations

impl Clone for TemplateParameter

fn clone(&self) -> TemplateParameter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TemplateParameter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TemplateParameter

fn default() -> TemplateParameter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TemplateParameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateParameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for TemplateParameter