- 4.52.0 (latest)
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.46.0
- 4.45.0
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public static final class WorkflowTemplate.Builder extends GeneratedMessageV3.Builder<WorkflowTemplate.Builder> implements WorkflowTemplateOrBuilderA Dataproc workflow template resource.
Protobuf type google.cloud.dataproc.v1.WorkflowTemplate
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkflowTemplate.BuilderImplements
WorkflowTemplateOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllJobs(Iterable<? extends OrderedJob> values)
public WorkflowTemplate.Builder addAllJobs(Iterable<? extends OrderedJob> values)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.dataproc.v1.OrderedJob> |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addAllParameters(Iterable<? extends TemplateParameter> values)
public WorkflowTemplate.Builder addAllParameters(Iterable<? extends TemplateParameter> values)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.dataproc.v1.TemplateParameter> |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addJobs(OrderedJob value)
public WorkflowTemplate.Builder addJobs(OrderedJob value)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | OrderedJob |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addJobs(OrderedJob.Builder builderForValue)
public WorkflowTemplate.Builder addJobs(OrderedJob.Builder builderForValue)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | OrderedJob.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addJobs(int index, OrderedJob value)
public WorkflowTemplate.Builder addJobs(int index, OrderedJob value)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | OrderedJob |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addJobs(int index, OrderedJob.Builder builderForValue)
public WorkflowTemplate.Builder addJobs(int index, OrderedJob.Builder builderForValue)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | OrderedJob.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addJobsBuilder()
public OrderedJob.Builder addJobsBuilder()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OrderedJob.Builder | |
addJobsBuilder(int index)
public OrderedJob.Builder addJobsBuilder(int index)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
OrderedJob.Builder | |
addParameters(TemplateParameter value)
public WorkflowTemplate.Builder addParameters(TemplateParameter value)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | TemplateParameter |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addParameters(TemplateParameter.Builder builderForValue)
public WorkflowTemplate.Builder addParameters(TemplateParameter.Builder builderForValue)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | TemplateParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addParameters(int index, TemplateParameter value)
public WorkflowTemplate.Builder addParameters(int index, TemplateParameter value)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | TemplateParameter |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addParameters(int index, TemplateParameter.Builder builderForValue)
public WorkflowTemplate.Builder addParameters(int index, TemplateParameter.Builder builderForValue)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | TemplateParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
addParametersBuilder()
public TemplateParameter.Builder addParametersBuilder()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TemplateParameter.Builder | |
addParametersBuilder(int index)
public TemplateParameter.Builder addParametersBuilder(int index)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TemplateParameter.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WorkflowTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
build()
public WorkflowTemplate build()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate | |
buildPartial()
public WorkflowTemplate buildPartial()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate | |
clear()
public WorkflowTemplate.Builder clear()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearCreateTime()
public WorkflowTemplate.Builder clearCreateTime()Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearDagTimeout()
public WorkflowTemplate.Builder clearDagTimeout()Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearField(Descriptors.FieldDescriptor field)
public WorkflowTemplate.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearId()
public WorkflowTemplate.Builder clearId()string id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
clearJobs()
public WorkflowTemplate.Builder clearJobs()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearLabels()
public WorkflowTemplate.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearName()
public WorkflowTemplate.Builder clearName()Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates, 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) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WorkflowTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearParameters()
public WorkflowTemplate.Builder clearParameters()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearPlacement()
public WorkflowTemplate.Builder clearPlacement()Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearUpdateTime()
public WorkflowTemplate.Builder clearUpdateTime()Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
clearVersion()
public WorkflowTemplate.Builder clearVersion()Optional. Used to perform a consistent read-modify-write.
This field should be left blank for a CreateWorkflowTemplate request. It
is required for an UpdateWorkflowTemplate request, and must match the
current server version. A typical update template flow would fetch the
current template with a GetWorkflowTemplate request, which will return
the current template with the version field filled in with the
current server version. The user updates other fields in the template,
then returns it as part of the UpdateWorkflowTemplate request.
int32 version = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
clone()
public WorkflowTemplate.Builder clone()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
containsLabels(String key)
public boolean containsLabels(String key)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCreateTime()
public Timestamp getCreateTime()Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDagTimeout()
public Duration getDagTimeout()Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration | The dagTimeout. |
getDagTimeoutBuilder()
public Duration.Builder getDagTimeoutBuilder()Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getDagTimeoutOrBuilder()
public DurationOrBuilder getDagTimeoutOrBuilder()Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getDefaultInstanceForType()
public WorkflowTemplate getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getId()
public String getId()string id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The id. |
getIdBytes()
public ByteString getIdBytes()string id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for id. |
getJobs(int index)
public OrderedJob getJobs(int index)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
OrderedJob | |
getJobsBuilder(int index)
public OrderedJob.Builder getJobsBuilder(int index)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
OrderedJob.Builder | |
getJobsBuilderList()
public List<OrderedJob.Builder> getJobsBuilderList()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getJobsCount()
public int getJobsCount()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
getJobsList()
public List<OrderedJob> getJobsList()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<OrderedJob> | |
getJobsOrBuilder(int index)
public OrderedJobOrBuilder getJobsOrBuilder(int index)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
OrderedJobOrBuilder | |
getJobsOrBuilderList()
public List<? extends OrderedJobOrBuilder> getJobsOrBuilderList()Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dataproc.v1.OrderedJobOrBuilder> | |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public String getName()Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates, 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) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates, 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) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getParameters(int index)
public TemplateParameter getParameters(int index)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TemplateParameter | |
getParametersBuilder(int index)
public TemplateParameter.Builder getParametersBuilder(int index)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TemplateParameter.Builder | |
getParametersBuilderList()
public List<TemplateParameter.Builder> getParametersBuilderList()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getParametersCount()
public int getParametersCount()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getParametersList()
public List<TemplateParameter> getParametersList()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<TemplateParameter> | |
getParametersOrBuilder(int index)
public TemplateParameterOrBuilder getParametersOrBuilder(int index)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TemplateParameterOrBuilder | |
getParametersOrBuilderList()
public List<? extends TemplateParameterOrBuilder> getParametersOrBuilderList()Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dataproc.v1.TemplateParameterOrBuilder> | |
getPlacement()
public WorkflowTemplatePlacement getPlacement()Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplatePlacement | The placement. |
getPlacementBuilder()
public WorkflowTemplatePlacement.Builder getPlacementBuilder()Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplatePlacement.Builder | |
getPlacementOrBuilder()
public WorkflowTemplatePlacementOrBuilder getPlacementOrBuilder()Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplatePlacementOrBuilder | |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getVersion()
public int getVersion()Optional. Used to perform a consistent read-modify-write.
This field should be left blank for a CreateWorkflowTemplate request. It
is required for an UpdateWorkflowTemplate request, and must match the
current server version. A typical update template flow would fetch the
current template with a GetWorkflowTemplate request, which will return
the current template with the version field filled in with the
current server version. The user updates other fields in the template,
then returns it as part of the UpdateWorkflowTemplate request.
int32 version = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The version. |
hasCreateTime()
public boolean hasCreateTime()Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasDagTimeout()
public boolean hasDagTimeout()Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the dagTimeout field is set. |
hasPlacement()
public boolean hasPlacement()Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the placement field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreateTime(Timestamp value)
public WorkflowTemplate.Builder mergeCreateTime(Timestamp value)Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergeDagTimeout(Duration value)
public WorkflowTemplate.Builder mergeDagTimeout(Duration value)Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergeFrom(WorkflowTemplate other)
public WorkflowTemplate.Builder mergeFrom(WorkflowTemplate other)| Parameter | |
|---|---|
| Name | Description |
other | WorkflowTemplate |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkflowTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public WorkflowTemplate.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergePlacement(WorkflowTemplatePlacement value)
public WorkflowTemplate.Builder mergePlacement(WorkflowTemplatePlacement value)Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | WorkflowTemplatePlacement |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WorkflowTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
mergeUpdateTime(Timestamp value)
public WorkflowTemplate.Builder mergeUpdateTime(Timestamp value)Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
putAllLabels(Map<String,String> values)
public WorkflowTemplate.Builder putAllLabels(Map<String,String> values)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
putLabels(String key, String value)
public WorkflowTemplate.Builder putLabels(String key, String value)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
removeJobs(int index)
public WorkflowTemplate.Builder removeJobs(int index)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
removeLabels(String key)
public WorkflowTemplate.Builder removeLabels(String key)Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035.
Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.
No more than 32 labels can be associated with a template.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
removeParameters(int index)
public WorkflowTemplate.Builder removeParameters(int index)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setCreateTime(Timestamp value)
public WorkflowTemplate.Builder setCreateTime(Timestamp value)Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public WorkflowTemplate.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setDagTimeout(Duration value)
public WorkflowTemplate.Builder setDagTimeout(Duration value)Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setDagTimeout(Duration.Builder builderForValue)
public WorkflowTemplate.Builder setDagTimeout(Duration.Builder builderForValue)Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.
.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public WorkflowTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setId(String value)
public WorkflowTemplate.Builder setId(String value)string id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe id to set. |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public WorkflowTemplate.Builder setIdBytes(ByteString value)string id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
setJobs(int index, OrderedJob value)
public WorkflowTemplate.Builder setJobs(int index, OrderedJob value)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | OrderedJob |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setJobs(int index, OrderedJob.Builder builderForValue)
public WorkflowTemplate.Builder setJobs(int index, OrderedJob.Builder builderForValue)Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | OrderedJob.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setName(String value)
public WorkflowTemplate.Builder setName(String value)Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates, 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) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public WorkflowTemplate.Builder setNameBytes(ByteString value)Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
For
projects.regions.workflowTemplates, the resource name of the template has the following format:projects/{project_id}/regions/{region}/workflowTemplates/{template_id}For
projects.locations.workflowTemplates, 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) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |
setParameters(int index, TemplateParameter value)
public WorkflowTemplate.Builder setParameters(int index, TemplateParameter value)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | TemplateParameter |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setParameters(int index, TemplateParameter.Builder builderForValue)
public WorkflowTemplate.Builder setParameters(int index, TemplateParameter.Builder builderForValue)Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
repeated .google.cloud.dataproc.v1.TemplateParameter parameters = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | TemplateParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setPlacement(WorkflowTemplatePlacement value)
public WorkflowTemplate.Builder setPlacement(WorkflowTemplatePlacement value)Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | WorkflowTemplatePlacement |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setPlacement(WorkflowTemplatePlacement.Builder builderForValue)
public WorkflowTemplate.Builder setPlacement(WorkflowTemplatePlacement.Builder builderForValue)Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkflowTemplatePlacement.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WorkflowTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final WorkflowTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setUpdateTime(Timestamp value)
public WorkflowTemplate.Builder setUpdateTime(Timestamp value)Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public WorkflowTemplate.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | |
setVersion(int value)
public WorkflowTemplate.Builder setVersion(int value)Optional. Used to perform a consistent read-modify-write.
This field should be left blank for a CreateWorkflowTemplate request. It
is required for an UpdateWorkflowTemplate request, and must match the
current server version. A typical update template flow would fetch the
current template with a GetWorkflowTemplate request, which will return
the current template with the version field filled in with the
current server version. The user updates other fields in the template,
then returns it as part of the UpdateWorkflowTemplate request.
int32 version = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | intThe version to set. |
| Returns | |
|---|---|
| Type | Description |
WorkflowTemplate.Builder | This builder for chaining. |