Package com.google.cloud.dataproc.v1

Interface WorkflowTemplateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WorkflowTemplate, WorkflowTemplate.Builder

public interface WorkflowTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsLabels(String key)	Optional.
com.google.protobuf.Timestamp	getCreateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	Output only.
com.google.protobuf.Duration	getDagTimeout()	Optional.
com.google.protobuf.DurationOrBuilder	getDagTimeoutOrBuilder()	Optional.
String	getId()	string id = 2 [(.google.api.field_behavior) = REQUIRED];
com.google.protobuf.ByteString	getIdBytes()	string id = 2 [(.google.api.field_behavior) = REQUIRED];
OrderedJob	getJobs(int index)	Required.
int	getJobsCount()	Required.
List<OrderedJob>	getJobsList()	Required.
OrderedJobOrBuilder	getJobsOrBuilder(int index)	Required.
List<? extends OrderedJobOrBuilder>	getJobsOrBuilderList()	Required.
Map<String,String>	getLabels()	Deprecated.
int	getLabelsCount()	Optional.
Map<String,String>	getLabelsMap()	Optional.
String	getLabelsOrDefault(String key, String defaultValue)	Optional.
String	getLabelsOrThrow(String key)	Optional.
String	getName()	Output only.
com.google.protobuf.ByteString	getNameBytes()	Output only.
TemplateParameter	getParameters(int index)	Optional.
int	getParametersCount()	Optional.
List<TemplateParameter>	getParametersList()	Optional.
TemplateParameterOrBuilder	getParametersOrBuilder(int index)	Optional.
List<? extends TemplateParameterOrBuilder>	getParametersOrBuilderList()	Optional.
WorkflowTemplatePlacement	getPlacement()	Required.
WorkflowTemplatePlacementOrBuilder	getPlacementOrBuilder()	Required.
com.google.protobuf.Timestamp	getUpdateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder()	Output only.
int	getVersion()	Optional.
boolean	hasCreateTime()	Output only.
boolean	hasDagTimeout()	Optional.
boolean	hasPlacement()	Required.
boolean	hasUpdateTime()	Output only.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getId

String getId()

string id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

string id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for id.

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getVersion

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:

The version.

hasCreateTime

boolean hasCreateTime()

 Output only. The time template was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. The time template was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time template was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. The time template was last updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. The time template was last updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The time template was last updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getLabelsCount

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](https://www.ietf.org/rfc/rfc1035.txt).

 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).

 No more than 32 labels can be associated with a template.
 

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

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](https://www.ietf.org/rfc/rfc1035.txt).

 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).

 No more than 32 labels can be associated with a template.
 

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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](https://www.ietf.org/rfc/rfc1035.txt).

 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).

 No more than 32 labels can be associated with a template.
 

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

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](https://www.ietf.org/rfc/rfc1035.txt).

 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).

 No more than 32 labels can be associated with a template.
 

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

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](https://www.ietf.org/rfc/rfc1035.txt).

 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).

 No more than 32 labels can be associated with a template.
 

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

hasPlacement

boolean hasPlacement()

 Required. WorkflowTemplate scheduling information.
 

.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the placement field is set.

getPlacement

WorkflowTemplatePlacement getPlacement()

 Required. WorkflowTemplate scheduling information.
 

.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];

Returns:

The placement.

getPlacementOrBuilder

WorkflowTemplatePlacementOrBuilder getPlacementOrBuilder()

 Required. WorkflowTemplate scheduling information.
 

.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];

getJobsList

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

getJobs

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

getJobsCount

int getJobsCount()

 Required. The Directed Acyclic Graph of Jobs to submit.
 

repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];

getJobsOrBuilderList

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

getJobsOrBuilder

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

getParametersList

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

getParameters

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

getParametersCount

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

getParametersOrBuilderList

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

getParametersOrBuilder

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

hasDagTimeout

boolean hasDagTimeout()

 Optional. Timeout duration for the DAG of jobs, expressed in seconds (see
 [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 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](/dataproc/docs/concepts/workflows/using-workflows#configuring_or_selecting_a_cluster),
 the cluster is deleted.
 

.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the dagTimeout field is set.

getDagTimeout

com.google.protobuf.Duration getDagTimeout()

 Optional. Timeout duration for the DAG of jobs, expressed in seconds (see
 [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 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](/dataproc/docs/concepts/workflows/using-workflows#configuring_or_selecting_a_cluster),
 the cluster is deleted.
 

.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The dagTimeout.

getDagTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getDagTimeoutOrBuilder()

 Optional. Timeout duration for the DAG of jobs, expressed in seconds (see
 [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 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](/dataproc/docs/concepts/workflows/using-workflows#configuring_or_selecting_a_cluster),
 the cluster is deleted.
 

.google.protobuf.Duration dag_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];