Class InstantiateWorkflowTemplateRequest (4.19.0)

public final class InstantiateWorkflowTemplateRequest extends GeneratedMessageV3 implements InstantiateWorkflowTemplateRequestOrBuilder

A request to instantiate a workflow template.

Protobuf type google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstantiateWorkflowTemplateRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InstantiateWorkflowTemplateRequest getDefaultInstance()
Returns
TypeDescription
InstantiateWorkflowTemplateRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InstantiateWorkflowTemplateRequest.Builder newBuilder()
Returns
TypeDescription
InstantiateWorkflowTemplateRequest.Builder

newBuilder(InstantiateWorkflowTemplateRequest prototype)

public static InstantiateWorkflowTemplateRequest.Builder newBuilder(InstantiateWorkflowTemplateRequest prototype)
Parameter
NameDescription
prototypeInstantiateWorkflowTemplateRequest
Returns
TypeDescription
InstantiateWorkflowTemplateRequest.Builder

parseDelimitedFrom(InputStream input)

public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstantiateWorkflowTemplateRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstantiateWorkflowTemplateRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstantiateWorkflowTemplateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstantiateWorkflowTemplateRequest> parser()
Returns
TypeDescription
Parser<InstantiateWorkflowTemplateRequest>

Methods

containsParameters(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()
Returns
TypeDescription
InstantiateWorkflowTemplateRequest

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) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public 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) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParameters()

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,String>

getParametersCount()

public int getParametersCount()

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

Returns
TypeDescription
int

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

Returns
TypeDescription
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getParametersOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<InstantiateWorkflowTemplateRequest> getParserForType()
Returns
TypeDescription
Parser<InstantiateWorkflowTemplateRequest>
Overrides

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.

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

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public 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.

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

Returns
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
int

The version.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InstantiateWorkflowTemplateRequest.Builder newBuilderForType()
Returns
TypeDescription
InstantiateWorkflowTemplateRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstantiateWorkflowTemplateRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstantiateWorkflowTemplateRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InstantiateWorkflowTemplateRequest.Builder toBuilder()
Returns
TypeDescription
InstantiateWorkflowTemplateRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException