public final class WorkflowTemplate extends com.google.protobuf.GeneratedMessageV3 implements WorkflowTemplateOrBuilder
A Cloud Dataproc workflow template resource.Protobuf type
google.cloud.dataproc.v1.WorkflowTemplate| Modifier and Type | Class and Description |
|---|---|
static class |
WorkflowTemplate.Builder
A Cloud Dataproc workflow template resource.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
JOBS_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PARAMETERS_FIELD_NUMBER |
static int |
PLACEMENT_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
static int |
VERSION_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Optional.
|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static WorkflowTemplate |
getDefaultInstance() |
WorkflowTemplate |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getId()
Required.
|
com.google.protobuf.ByteString |
getIdBytes()
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.
|
com.google.protobuf.Parser<WorkflowTemplate> |
getParserForType() |
WorkflowTemplatePlacement |
getPlacement()
Required.
|
WorkflowTemplatePlacementOrBuilder |
getPlacementOrBuilder()
Required.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
int |
getVersion()
Optional.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasPlacement()
Required.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static WorkflowTemplate.Builder |
newBuilder() |
static WorkflowTemplate.Builder |
newBuilder(WorkflowTemplate prototype) |
WorkflowTemplate.Builder |
newBuilderForType() |
protected WorkflowTemplate.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static WorkflowTemplate |
parseDelimitedFrom(InputStream input) |
static WorkflowTemplate |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WorkflowTemplate |
parseFrom(byte[] data) |
static WorkflowTemplate |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WorkflowTemplate |
parseFrom(ByteBuffer data) |
static WorkflowTemplate |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WorkflowTemplate |
parseFrom(com.google.protobuf.ByteString data) |
static WorkflowTemplate |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WorkflowTemplate |
parseFrom(com.google.protobuf.CodedInputStream input) |
static WorkflowTemplate |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WorkflowTemplate |
parseFrom(InputStream input) |
static WorkflowTemplate |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<WorkflowTemplate> |
parser() |
WorkflowTemplate.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ID_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int PLACEMENT_FIELD_NUMBER
public static final int JOBS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getId()
Required. The template id. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
string id = 2;getId in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.ByteString getIdBytes()
Required. The template id. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
string id = 2;getIdBytes in interface WorkflowTemplateOrBuilderpublic String getName()
Output only. The "resource name" of the template, as described
in https://cloud.google.com/apis/design/resource_names of the form
`projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
string name = 1;getName in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. The "resource name" of the template, as described
in https://cloud.google.com/apis/design/resource_names of the form
`projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
string name = 1;getNameBytes in interface WorkflowTemplateOrBuilderpublic 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;getVersion in interface WorkflowTemplateOrBuilderpublic boolean hasCreateTime()
Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4;hasCreateTime in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4;getCreateTime in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time template was created.
.google.protobuf.Timestamp create_time = 4;getCreateTimeOrBuilder in interface WorkflowTemplateOrBuilderpublic boolean hasUpdateTime()
Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5;hasUpdateTime in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5;getUpdateTime in interface WorkflowTemplateOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time template was last updated.
.google.protobuf.Timestamp update_time = 5;getUpdateTimeOrBuilder in interface WorkflowTemplateOrBuilderpublic int getLabelsCount()
WorkflowTemplateOrBuilderOptional. 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;getLabelsCount in interface WorkflowTemplateOrBuilderpublic 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;containsLabels in interface WorkflowTemplateOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface WorkflowTemplateOrBuilderpublic 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;getLabelsMap in interface WorkflowTemplateOrBuilderpublic 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;getLabelsOrDefault in interface WorkflowTemplateOrBuilderpublic 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;getLabelsOrThrow in interface WorkflowTemplateOrBuilderpublic boolean hasPlacement()
Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7;hasPlacement in interface WorkflowTemplateOrBuilderpublic WorkflowTemplatePlacement getPlacement()
Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7;getPlacement in interface WorkflowTemplateOrBuilderpublic WorkflowTemplatePlacementOrBuilder getPlacementOrBuilder()
Required. WorkflowTemplate scheduling information.
.google.cloud.dataproc.v1.WorkflowTemplatePlacement placement = 7;getPlacementOrBuilder in interface WorkflowTemplateOrBuilderpublic List<OrderedJob> getJobsList()
Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8;getJobsList in interface WorkflowTemplateOrBuilderpublic List<? extends OrderedJobOrBuilder> getJobsOrBuilderList()
Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8;getJobsOrBuilderList in interface WorkflowTemplateOrBuilderpublic int getJobsCount()
Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8;getJobsCount in interface WorkflowTemplateOrBuilderpublic OrderedJob getJobs(int index)
Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8;getJobs in interface WorkflowTemplateOrBuilderpublic OrderedJobOrBuilder getJobsOrBuilder(int index)
Required. The Directed Acyclic Graph of Jobs to submit.
repeated .google.cloud.dataproc.v1.OrderedJob jobs = 8;getJobsOrBuilder in interface WorkflowTemplateOrBuilderpublic 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;getParametersList in interface WorkflowTemplateOrBuilderpublic 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;getParametersOrBuilderList in interface WorkflowTemplateOrBuilderpublic 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;getParametersCount in interface WorkflowTemplateOrBuilderpublic 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;getParameters in interface WorkflowTemplateOrBuilderpublic 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;getParametersOrBuilder in interface WorkflowTemplateOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static WorkflowTemplate parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static WorkflowTemplate parseFrom(InputStream input) throws IOException
IOExceptionpublic static WorkflowTemplate parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static WorkflowTemplate parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static WorkflowTemplate parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static WorkflowTemplate parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static WorkflowTemplate parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic WorkflowTemplate.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static WorkflowTemplate.Builder newBuilder()
public static WorkflowTemplate.Builder newBuilder(WorkflowTemplate prototype)
public WorkflowTemplate.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected WorkflowTemplate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static WorkflowTemplate getDefaultInstance()
public static com.google.protobuf.Parser<WorkflowTemplate> parser()
public com.google.protobuf.Parser<WorkflowTemplate> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public WorkflowTemplate getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2019 Google LLC. All rights reserved.