public final class WorkflowTemplate extends GeneratedMessageV3 implements WorkflowTemplateOrBuilder
A Dataproc workflow template resource.
Protobuf type google.cloud.dataproc.v1.WorkflowTemplate
Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DAG_TIMEOUT_FIELD_NUMBER
public static final int DAG_TIMEOUT_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
JOBS_FIELD_NUMBER
public static final int JOBS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
PLACEMENT_FIELD_NUMBER
public static final int PLACEMENT_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
Field Value
Methods
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
getDefaultInstance()
public static WorkflowTemplate getDefaultInstance()
Returns
getDefaultInstanceForType()
public WorkflowTemplate getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getId()
string id = 2 [(.google.api.field_behavior) = REQUIRED];
getIdBytes()
public ByteString getIdBytes()
string id = 2 [(.google.api.field_behavior) = REQUIRED];
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];
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];
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];
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];
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];
| Type | Description |
| List<? extends com.google.cloud.dataproc.v1.OrderedJobOrBuilder> | |
getLabels()
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
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];
| 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];
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];
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];
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];
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];
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];
| Type | Description |
| List<? extends com.google.cloud.dataproc.v1.TemplateParameterOrBuilder> | |
getParserForType()
public Parser<WorkflowTemplate> getParserForType()
Returns
Overrides
getPlacement()
public WorkflowTemplatePlacement getPlacement()
Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
getPlacementOrBuilder()
public WorkflowTemplatePlacementOrBuilder getPlacementOrBuilder()
Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static WorkflowTemplate.Builder newBuilder()
Returns
newBuilder(WorkflowTemplate prototype)
public static WorkflowTemplate.Builder newBuilder(WorkflowTemplate prototype)
Parameter
Returns
newBuilderForType()
public WorkflowTemplate.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkflowTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static WorkflowTemplate parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static WorkflowTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static WorkflowTemplate parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkflowTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static WorkflowTemplate parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkflowTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static WorkflowTemplate parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static WorkflowTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static WorkflowTemplate parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static WorkflowTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static WorkflowTemplate parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkflowTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<WorkflowTemplate> parser()
Returns
toBuilder()
public WorkflowTemplate.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
