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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public InstantiateWorkflowTemplateRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public InstantiateWorkflowTemplateRequest build()
Returns
buildPartial()
public InstantiateWorkflowTemplateRequest buildPartial()
Returns
clear()
public InstantiateWorkflowTemplateRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public InstantiateWorkflowTemplateRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public InstantiateWorkflowTemplateRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearParameters()
public InstantiateWorkflowTemplateRequest.Builder clearParameters()
Returns
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];
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];
clone()
public InstantiateWorkflowTemplateRequest.Builder clone()
Returns
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];
getDefaultInstanceForType()
public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMutableParameters()
public Map<String,String> getMutableParameters()
Use alternate mutation accessors instead.
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) = { ... }
| 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) = { ... }
getParameters()
public Map<String,String> getParameters()
Returns
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];
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];
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];
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];
| 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];
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];
| Type | Description |
| int | The version.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(InstantiateWorkflowTemplateRequest other)
public InstantiateWorkflowTemplateRequest.Builder mergeFrom(InstantiateWorkflowTemplateRequest other)
Parameter
Returns
public InstantiateWorkflowTemplateRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public InstantiateWorkflowTemplateRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final InstantiateWorkflowTemplateRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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];
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];
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];
setField(Descriptors.FieldDescriptor field, Object value)
public InstantiateWorkflowTemplateRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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) = { ... }
| Name | Description |
| value | String
The name to set.
|
Returns
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) = { ... }
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public InstantiateWorkflowTemplateRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
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];
| Name | Description |
| value | String
The requestId to set.
|
Returns
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];
| Name | Description |
| value | ByteString
The bytes for requestId to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final InstantiateWorkflowTemplateRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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];
| Name | Description |
| value | int
The version to set.
|
Returns
