Class InstantiateWorkflowTemplateRequest (4.34.0)
Version 4.34.0keyboard_arrow_down
public final class InstantiateWorkflowTemplateRequest extends GeneratedMessageV3 implements InstantiateWorkflowTemplateRequestOrBuilder
A request to instantiate a workflow template.
Protobuf type google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static InstantiateWorkflowTemplateRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static InstantiateWorkflowTemplateRequest . Builder newBuilder ()
newBuilder(InstantiateWorkflowTemplateRequest prototype)
public static InstantiateWorkflowTemplateRequest . Builder newBuilder ( InstantiateWorkflowTemplateRequest prototype )
public static InstantiateWorkflowTemplateRequest parseDelimitedFrom ( InputStream input )
public static InstantiateWorkflowTemplateRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static InstantiateWorkflowTemplateRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstantiateWorkflowTemplateRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static InstantiateWorkflowTemplateRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstantiateWorkflowTemplateRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static InstantiateWorkflowTemplateRequest parseFrom ( CodedInputStream input )
public static InstantiateWorkflowTemplateRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static InstantiateWorkflowTemplateRequest parseFrom ( InputStream input )
public static InstantiateWorkflowTemplateRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static InstantiateWorkflowTemplateRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstantiateWorkflowTemplateRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<InstantiateWorkflowTemplateRequest> parser ()
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
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public InstantiateWorkflowTemplateRequest getDefaultInstanceForType ()
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
Type Description
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
Type Description
ByteString The bytes for name.
getParameters() (deprecated)
public Map<String , String > getParameters ()
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
Type Description
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];
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];
Returns
Type Description
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
Name Description
keyString
Returns
Type Description
String
getParserForType()
public Parser<InstantiateWorkflowTemplateRequest> getParserForType ()
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
Type Description
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
Type Description
ByteString The bytes for requestId.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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
Type Description
int The version.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public InstantiateWorkflowTemplateRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstantiateWorkflowTemplateRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public InstantiateWorkflowTemplateRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
