com.google.cloud.dataproc.v1

Class TemplateParameter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.TemplateParameter

All Implemented Interfaces:

TemplateParameterOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class TemplateParameter
extends GeneratedMessageV3
implements TemplateParameterOrBuilder

 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)
 

Protobuf type google.cloud.dataproc.v1.TemplateParameter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateParameter.Builder A configurable parameter that replaces one or more fields in the template.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	FIELDS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	VALIDATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TemplateParameter	getDefaultInstance()
TemplateParameter	getDefaultInstanceForType()
String	getDescription() Optional.
ByteString	getDescriptionBytes() Optional.
static Descriptors.Descriptor	getDescriptor()
String	getFields(int index) Required.
ByteString	getFieldsBytes(int index) Required.
int	getFieldsCount() Required.
ProtocolStringList	getFieldsList() Required.
String	getName() Required.
ByteString	getNameBytes() Required.
Parser<TemplateParameter>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
ParameterValidation	getValidation() Optional.
ParameterValidationOrBuilder	getValidationOrBuilder() Optional.
int	hashCode()
boolean	hasValidation() Optional.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TemplateParameter.Builder	newBuilder()
static TemplateParameter.Builder	newBuilder(TemplateParameter prototype)
TemplateParameter.Builder	newBuilderForType()
protected TemplateParameter.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static TemplateParameter	parseDelimitedFrom(InputStream input)
static TemplateParameter	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static TemplateParameter	parseFrom(byte[] data)
static TemplateParameter	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static TemplateParameter	parseFrom(ByteBuffer data)
static TemplateParameter	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static TemplateParameter	parseFrom(ByteString data)
static TemplateParameter	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static TemplateParameter	parseFrom(CodedInputStream input)
static TemplateParameter	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static TemplateParameter	parseFrom(InputStream input)
static TemplateParameter	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<TemplateParameter>	parser()
TemplateParameter.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_FIELD_NUMBER

public static final int VALIDATION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getName in interface TemplateParameterOrBuilder

Returns:

The name.

getNameBytes

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

Specified by:

getNameBytes in interface TemplateParameterOrBuilder

Returns:

The bytes for name.

getFieldsList

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

Specified by:

getFieldsList in interface TemplateParameterOrBuilder

Returns:

A list containing the fields.

getFieldsCount

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

Specified by:

getFieldsCount in interface TemplateParameterOrBuilder

Returns:

The count of fields.

getFields

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

Specified by:

getFields in interface TemplateParameterOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The fields at the given index.

getFieldsBytes

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

Specified by:

getFieldsBytes in interface TemplateParameterOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fields at the given index.

getDescription

public String getDescription()

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

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

Specified by:

getDescription in interface TemplateParameterOrBuilder

Returns:

The description.

getDescriptionBytes

public ByteString getDescriptionBytes()

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

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

Specified by:

getDescriptionBytes in interface TemplateParameterOrBuilder

Returns:

The bytes for description.

hasValidation

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

Specified by:

hasValidation in interface TemplateParameterOrBuilder

Returns:

Whether the validation field is set.

getValidation

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

Specified by:

getValidation in interface TemplateParameterOrBuilder

Returns:

The validation.

getValidationOrBuilder

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

Specified by:

getValidationOrBuilder in interface TemplateParameterOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static TemplateParameter parseFrom(ByteBuffer data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(ByteBuffer data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(ByteString data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(ByteString data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(byte[] data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(byte[] data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static TemplateParameter parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static TemplateParameter parseFrom(InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static TemplateParameter parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static TemplateParameter parseDelimitedFrom(InputStream input,
                                                   ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static TemplateParameter parseFrom(CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static TemplateParameter parseFrom(CodedInputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public TemplateParameter.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static TemplateParameter.Builder newBuilder()

newBuilder

public static TemplateParameter.Builder newBuilder(TemplateParameter prototype)

toBuilder

public TemplateParameter.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected TemplateParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static TemplateParameter getDefaultInstance()

parser

public static Parser<TemplateParameter> parser()

getParserForType

public Parser<TemplateParameter> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public TemplateParameter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder