target.apidocs.com.google.api.services.dataproc.model.TemplateParameter.html Maven / Gradle / Ivy

Go to download






TemplateParameter (Cloud Dataproc API v1-rev20240605-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataproc.model
Class TemplateParameter



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.dataproc.model.TemplateParameter













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class TemplateParameter
extends com.google.api.client.json.GenericJson
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 is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


TemplateParameter() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TemplateParameter
clone() 


String
getDescription()
Optional.



List<String>
getFields()
Required.



String
getName()
Required.



ParameterValidation
getValidation()
Optional.



TemplateParameter
set(String fieldName,
   Object value) 


TemplateParameter
setDescription(String description)
Optional.



TemplateParameter
setFields(List<String> fields)
Required.



TemplateParameter
setName(String name)
Required.



TemplateParameter
setValidation(ParameterValidation validation)
Optional.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





TemplateParameter
public TemplateParameter()









Method Detail





getDescription
public String getDescription()
Optional. Brief description of the parameter. Must not exceed 1024 characters.

Returns:
value or null for none








setDescription
public TemplateParameter setDescription(String description)
Optional. Brief description of the parameter. Must not exceed 1024 characters.

Parameters:
description - description or null for none








getFields
public List<String> getFields()
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

Returns:
value or null for none








setFields
public TemplateParameter setFields(List<String> fields)
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

Parameters:
fields - fields or null for none








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.

Returns:
value or null for none








setName
public TemplateParameter setName(String name)
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.

Parameters:
name - name or null for none








getValidation
public ParameterValidation getValidation()
Optional. Validation rules to be applied to this parameter's value.

Returns:
value or null for none








setValidation
public TemplateParameter setValidation(ParameterValidation validation)
Optional. Validation rules to be applied to this parameter's value.

Parameters:
validation - validation or null for none








set
public TemplateParameter set(String fieldName,
                             Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public TemplateParameter clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.
Modifier and Type	Method and Description
`TemplateParameter`	`clone()`
`String`	`getDescription()` Optional.
`List<String>`	`getFields()` Required.
`String`	`getName()` Required.
`ParameterValidation`	`getValidation()` Optional.
`TemplateParameter`	`set(String fieldName, Object value)`
`TemplateParameter`	`setDescription(String description)` Optional.
`TemplateParameter`	`setFields(List<String> fields)` Required.
`TemplateParameter`	`setName(String name)` Required.
`TemplateParameter`	`setValidation(ParameterValidation validation)` Optional.