WorkflowTemplate (Google Cloud Dataproc Parent 4.0.8 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dataproc.v1.WorkflowTemplate

All Implemented Interfaces:

WorkflowTemplateOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable
```
public final class WorkflowTemplate
extends GeneratedMessageV3
implements WorkflowTemplateOrBuilder
```
```
 A Dataproc workflow template resource.
 
```
Protobuf type google.cloud.dataproc.v1.WorkflowTemplate
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WorkflowTemplate.Builder
A Dataproc workflow template resource.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`WorkflowTemplate.Builder` A Dataproc workflow template resource.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DAG_TIMEOUT_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`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Optional.
`boolean`	`equals(Object obj)`
`Timestamp`	`getCreateTime()` Output only.
`TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`Duration`	`getDagTimeout()` Optional.
`DurationOrBuilder`	`getDagTimeoutOrBuilder()` Optional.
`static WorkflowTemplate`	`getDefaultInstance()`
`WorkflowTemplate`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`String`	`getId()` `string id = 2 [(.google.api.field_behavior) = REQUIRED];`
`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.
`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.
`Parser<WorkflowTemplate>`	`getParserForType()`
`WorkflowTemplatePlacement`	`getPlacement()` Required.
`WorkflowTemplatePlacementOrBuilder`	`getPlacementOrBuilder()` Required.
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`Timestamp`	`getUpdateTime()` Output only.
`TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`int`	`getVersion()` Optional.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasDagTimeout()` Optional.
`int`	`hashCode()`
`boolean`	`hasPlacement()` Required.
`boolean`	`hasUpdateTime()` Output only.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static WorkflowTemplate.Builder`	`newBuilder()`
`static WorkflowTemplate.Builder`	`newBuilder(WorkflowTemplate prototype)`
`WorkflowTemplate.Builder`	`newBuilderForType()`
`protected WorkflowTemplate.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static WorkflowTemplate`	`parseDelimitedFrom(InputStream input)`
`static WorkflowTemplate`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static WorkflowTemplate`	`parseFrom(byte[] data)`
`static WorkflowTemplate`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static WorkflowTemplate`	`parseFrom(ByteBuffer data)`
`static WorkflowTemplate`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static WorkflowTemplate`	`parseFrom(ByteString data)`
`static WorkflowTemplate`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static WorkflowTemplate`	`parseFrom(CodedInputStream input)`
`static WorkflowTemplate`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static WorkflowTemplate`	`parseFrom(InputStream input)`
`static WorkflowTemplate`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<WorkflowTemplate>`	`parser()`
`WorkflowTemplate.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- ID_FIELD_NUMBER
```
public static final int ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VERSION_FIELD_NUMBER
```
public static final int VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PLACEMENT_FIELD_NUMBER
```
public static final int PLACEMENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JOBS_FIELD_NUMBER
```
public static final int JOBS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DAG_TIMEOUT_FIELD_NUMBER
```
public static final int DAG_TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getId
```
public String getId()
```
string id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getId in interface WorkflowTemplateOrBuilder

Returns:

The id.

getIdBytes
```
public ByteString getIdBytes()
```
string id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getIdBytes in interface WorkflowTemplateOrBuilder

Returns:

The bytes for id.

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

Specified by:: getName in interface WorkflowTemplateOrBuilder
Returns:: 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];

Specified by:: getNameBytes in interface WorkflowTemplateOrBuilder
Returns:: The bytes for name.

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

Specified by:: getVersion in interface WorkflowTemplateOrBuilder
Returns:: 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];
Specified by:

hasCreateTime in interface WorkflowTemplateOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public Timestamp getCreateTime()
```
```
 Output only. The time template was created.
 
```
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTime in interface WorkflowTemplateOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. The time template was created.
 
```
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTimeOrBuilder in interface WorkflowTemplateOrBuilder

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. The time template was last updated.
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasUpdateTime in interface WorkflowTemplateOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public Timestamp getUpdateTime()
```
```
 Output only. The time template was last updated.
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTime in interface WorkflowTemplateOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. The time template was last updated.
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTimeOrBuilder in interface WorkflowTemplateOrBuilder