[−][src]Struct gcp_client::google::cloud::dataproc::v1::TemplateParameter
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)
Fields
name: 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.
fields: 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][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
description: String
Optional. Brief description of the parameter. Must not exceed 1024 characters.
validation: Option<ParameterValidation>
Optional. Validation rules to be applied to this parameter's value.
Trait Implementations
impl Clone for TemplateParameter
[src]
fn clone(&self) -> TemplateParameter
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for TemplateParameter
[src]
impl Default for TemplateParameter
[src]
fn default() -> TemplateParameter
[src]
impl Message for TemplateParameter
[src]
fn encode_raw<B>(&self, buf: &mut B) where
B: BufMut,
[src]
B: BufMut,
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
[src]
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
fn encoded_len(&self) -> usize
[src]
fn clear(&mut self)
[src]
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
[src]
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
[src]
B: Buf,
Self: Default,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
[src]
B: Buf,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
[src]
B: Buf,
impl PartialEq<TemplateParameter> for TemplateParameter
[src]
fn eq(&self, other: &TemplateParameter) -> bool
[src]
fn ne(&self, other: &TemplateParameter) -> bool
[src]
impl StructuralPartialEq for TemplateParameter
[src]
Auto Trait Implementations
impl RefUnwindSafe for TemplateParameter
impl Send for TemplateParameter
impl Sync for TemplateParameter
impl Unpin for TemplateParameter
impl UnwindSafe for TemplateParameter
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoRequest<T> for T
[src]
fn into_request(self) -> Request<T>
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,