Package com.google.cloud.dataproc.v1

Interface TemplateParameterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TemplateParameter, TemplateParameter.Builder

public interface TemplateParameterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Optional.
com.google.protobuf.ByteString	getDescriptionBytes()	Optional.
String	getFields(int index)	Required.
com.google.protobuf.ByteString	getFieldsBytes(int index)	Required.
int	getFieldsCount()	Required.
List<String>	getFieldsList()	Required.
String	getName()	Required.
com.google.protobuf.ByteString	getNameBytes()	Required.
ParameterValidation	getValidation()	Optional.
ParameterValidationOrBuilder	getValidationOrBuilder()	Optional.
boolean	hasValidation()	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getFieldsList

List<String> 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][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:

A list containing the fields.

getFieldsCount

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][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:

The count of fields.

getFields

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][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:

index - The index of the element to return.

Returns:

The fields at the given index.

getFieldsBytes

com.google.protobuf.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][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:

index - The index of the value to return.

Returns:

The bytes of the fields at the given index.

getDescription

String getDescription()

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

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

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

Returns:

The bytes for description.

hasValidation

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:

Whether the validation field is set.

getValidation

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:

The validation.

getValidationOrBuilder

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