/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/workflow_templates.proto
package com.google.cloud.dataproc.v1;
public interface WorkflowTemplateOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.WorkflowTemplate)
com.google.protobuf.MessageOrBuilder {
/**
* string id = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The id.
*/
java.lang.String getId();
/**
* string id = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for id.
*/
com.google.protobuf.ByteString getIdBytes();
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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];
*
* @return The version.
*/
int getVersion();
/**
*
*
*
* Output only. The time template was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time template was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time template was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time template was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time template was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Required. WorkflowTemplate scheduling information.
*
*
*
* .google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the placement field is set.
*/
boolean hasPlacement();
/**
*
*
*
* Required. WorkflowTemplate scheduling information.
*
*
*
* .google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The placement.
*/
com.google.cloud.dataproc.v1.WorkflowTemplatePlacement getPlacement();
/**
*
*
*
* Required. WorkflowTemplate scheduling information.
*
*
*
* .google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataproc.v1.WorkflowTemplatePlacementOrBuilder getPlacementOrBuilder();
/**
*
*
*
* Required. The Directed Acyclic Graph of Jobs to submit.
*
*
*
* repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List getJobsList();
/**
*
*
*
* Required. The Directed Acyclic Graph of Jobs to submit.
*
*
*
* repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
int getJobsCount();
/**
*
*
*
* Required. The Directed Acyclic Graph of Jobs to submit.
*
*
*
* repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List getJobsOrBuilderList();
/**
*
*
*
* Required. The Directed Acyclic Graph of Jobs to submit.
*
*
*
* repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataproc.v1.OrderedJobOrBuilder getJobsOrBuilder(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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dataproc.v1.TemplateParameterOrBuilder getParametersOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return Whether the dagTimeout field is set.
*/
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];
*
*
* @return The dagTimeout.
*/
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];
*
*/
com.google.protobuf.DurationOrBuilder getDagTimeoutOrBuilder();
}