Class InstantiateWorkflowTemplateRequest.Builder (4.44.0)

public static final class InstantiateWorkflowTemplateRequest.Builder extends GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder> implements InstantiateWorkflowTemplateRequestOrBuilder

A request to instantiate a workflow template.

Protobuf type google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstantiateWorkflowTemplateRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

build()

public InstantiateWorkflowTemplateRequest build()
Returns
Type Description
InstantiateWorkflowTemplateRequest

buildPartial()

public InstantiateWorkflowTemplateRequest buildPartial()
Returns
Type Description
InstantiateWorkflowTemplateRequest

clear()

public InstantiateWorkflowTemplateRequest.Builder clear()
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public InstantiateWorkflowTemplateRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

clearName()

public InstantiateWorkflowTemplateRequest.Builder clearName()

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
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstantiateWorkflowTemplateRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

clearParameters()

public InstantiateWorkflowTemplateRequest.Builder clearParameters()
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

clearRequestId()

public InstantiateWorkflowTemplateRequest.Builder clearRequestId()

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
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

clearVersion()

public InstantiateWorkflowTemplateRequest.Builder clearVersion()

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
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

clone()

public InstantiateWorkflowTemplateRequest.Builder clone()
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

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
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()
Returns
Type Description
InstantiateWorkflowTemplateRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableParameters() (deprecated)

public Map<String,String> getMutableParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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
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()

Use #getParametersMap() instead.

Returns
Type Description
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
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];

Returns
Type Description
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
Name Description
key String
defaultValue String
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
key String
Returns
Type Description
String

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.

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
Type Description
int

The version.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(InstantiateWorkflowTemplateRequest other)

public InstantiateWorkflowTemplateRequest.Builder mergeFrom(InstantiateWorkflowTemplateRequest other)
Parameter
Name Description
other InstantiateWorkflowTemplateRequest
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InstantiateWorkflowTemplateRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InstantiateWorkflowTemplateRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InstantiateWorkflowTemplateRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

putAllParameters(Map<String,String> values)

public InstantiateWorkflowTemplateRequest.Builder putAllParameters(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

putParameters(String key, String value)

public InstantiateWorkflowTemplateRequest.Builder putParameters(String key, String value)

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
Name Description
key String
value String
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

removeParameters(String key)

public InstantiateWorkflowTemplateRequest.Builder removeParameters(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
key String
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public InstantiateWorkflowTemplateRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

setName(String value)

public InstantiateWorkflowTemplateRequest.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public InstantiateWorkflowTemplateRequest.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InstantiateWorkflowTemplateRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

setRequestId(String value)

public InstantiateWorkflowTemplateRequest.Builder setRequestId(String value)

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

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public InstantiateWorkflowTemplateRequest.Builder setRequestIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final InstantiateWorkflowTemplateRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder
Overrides

setVersion(int value)

public InstantiateWorkflowTemplateRequest.Builder setVersion(int value)

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

Parameter
Name Description
value int

The version to set.

Returns
Type Description
InstantiateWorkflowTemplateRequest.Builder

This builder for chaining.