com.google.cloud.dataproc.v1

Class InstantiateWorkflowTemplateRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest

All Implemented Interfaces:

InstantiateWorkflowTemplateRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class InstantiateWorkflowTemplateRequest
extends com.google.protobuf.GeneratedMessageV3
implements InstantiateWorkflowTemplateRequestOrBuilder

 A request to instantiate a workflow template.
 

Protobuf type google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstantiateWorkflowTemplateRequest.Builder A request to instantiate a workflow template.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER
static int	REQUEST_ID_FIELD_NUMBER
static int	VERSION_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	containsParameters(String key) Optional.
boolean	equals(Object obj)
static InstantiateWorkflowTemplateRequest	getDefaultInstance()
InstantiateWorkflowTemplateRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
Map<String,String>	getParameters() Deprecated.
int	getParametersCount() Optional.
Map<String,String>	getParametersMap() Optional.
String	getParametersOrDefault(String key, String defaultValue) Optional.
String	getParametersOrThrow(String key) Optional.
com.google.protobuf.Parser<InstantiateWorkflowTemplateRequest>	getParserForType()
String	getRequestId() Optional.
com.google.protobuf.ByteString	getRequestIdBytes() Optional.
int	getSerializedSize()
int	getVersion() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static InstantiateWorkflowTemplateRequest.Builder	newBuilder()
static InstantiateWorkflowTemplateRequest.Builder	newBuilder(InstantiateWorkflowTemplateRequest prototype)
InstantiateWorkflowTemplateRequest.Builder	newBuilderForType()
protected InstantiateWorkflowTemplateRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static InstantiateWorkflowTemplateRequest	parseDelimitedFrom(InputStream input)
static InstantiateWorkflowTemplateRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InstantiateWorkflowTemplateRequest	parseFrom(byte[] data)
static InstantiateWorkflowTemplateRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InstantiateWorkflowTemplateRequest	parseFrom(ByteBuffer data)
static InstantiateWorkflowTemplateRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InstantiateWorkflowTemplateRequest	parseFrom(com.google.protobuf.ByteString data)
static InstantiateWorkflowTemplateRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InstantiateWorkflowTemplateRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static InstantiateWorkflowTemplateRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InstantiateWorkflowTemplateRequest	parseFrom(InputStream input)
static InstantiateWorkflowTemplateRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<InstantiateWorkflowTemplateRequest>	parser()
InstantiateWorkflowTemplateRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, 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

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Required. The resource name of the workflow template, as described
 in https://cloud.google.com/apis/design/resource_names.

 * For `projects.regions.workflowTemplates.instantiate`, the resource name
 of the template has the following format:
   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

 * For `projects.locations.workflowTemplates.instantiate`, the resource name
   of the template has the following format:
   `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getName in interface InstantiateWorkflowTemplateRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the workflow template, as described
 in https://cloud.google.com/apis/design/resource_names.

 * For `projects.regions.workflowTemplates.instantiate`, the resource name
 of the template has the following format:
   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

 * For `projects.locations.workflowTemplates.instantiate`, the resource name
   of the template has the following format:
   `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getNameBytes in interface InstantiateWorkflowTemplateRequestOrBuilder

Returns:

The bytes for name.

getVersion

public int getVersion()

 Optional. The version of workflow template to instantiate. If specified,
 the workflow will be instantiated only if the current version of
 the workflow template has the supplied version.

 This option cannot be used to instantiate a previous version of
 workflow template.
 

int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getVersion in interface InstantiateWorkflowTemplateRequestOrBuilder

Returns:

The version.

getRequestId

public String getRequestId()

 Optional. A tag that prevents multiple concurrent workflow
 instances with the same tag from running. This mitigates risk of
 concurrent instances started due to retries.

 It is recommended to always set this value to a
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).

 The tag must contain only letters (a-z, A-Z), numbers (0-9),
 underscores (_), and hyphens (-). The maximum length is 40 characters.
 

string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRequestId in interface InstantiateWorkflowTemplateRequestOrBuilder

Returns:

The requestId.

getRequestIdBytes

public com.google.protobuf.ByteString getRequestIdBytes()

 Optional. A tag that prevents multiple concurrent workflow
 instances with the same tag from running. This mitigates risk of
 concurrent instances started due to retries.

 It is recommended to always set this value to a
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).

 The tag must contain only letters (a-z, A-Z), numbers (0-9),
 underscores (_), and hyphens (-). The maximum length is 40 characters.
 

string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRequestIdBytes in interface InstantiateWorkflowTemplateRequestOrBuilder

Returns:

The bytes for requestId.

getParametersCount

public int getParametersCount()

Description copied from interface: InstantiateWorkflowTemplateRequestOrBuilder

 Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
 

map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParametersCount in interface InstantiateWorkflowTemplateRequestOrBuilder

containsParameters

public boolean containsParameters(String key)

 Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
 

map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

containsParameters in interface InstantiateWorkflowTemplateRequestOrBuilder

getParameters

@Deprecated
public Map<String,String> getParameters()

Deprecated.

Use getParametersMap() instead.

Specified by:

getParameters in interface InstantiateWorkflowTemplateRequestOrBuilder

getParametersMap

public Map<String,String> getParametersMap()

 Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
 

map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParametersMap in interface InstantiateWorkflowTemplateRequestOrBuilder

getParametersOrDefault

public String getParametersOrDefault(String key,
                                     String defaultValue)

 Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
 

map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParametersOrDefault in interface InstantiateWorkflowTemplateRequestOrBuilder

getParametersOrThrow

public String getParametersOrThrow(String key)

 Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
 

map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParametersOrThrow in interface InstantiateWorkflowTemplateRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static InstantiateWorkflowTemplateRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

newBuilderForType

public InstantiateWorkflowTemplateRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static InstantiateWorkflowTemplateRequest.Builder newBuilder()

newBuilder

public static InstantiateWorkflowTemplateRequest.Builder newBuilder(InstantiateWorkflowTemplateRequest prototype)

toBuilder

public InstantiateWorkflowTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected InstantiateWorkflowTemplateRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static InstantiateWorkflowTemplateRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<InstantiateWorkflowTemplateRequest> parser()

getParserForType

public com.google.protobuf.Parser<InstantiateWorkflowTemplateRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder