Class WorkflowMetadata (4.6.0) 

public final class WorkflowMetadata extends GeneratedMessageV3 implements WorkflowMetadataOrBuilder

A Dataproc workflow template resource.

Protobuf type google.cloud.dataproc.v1.WorkflowMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WorkflowMetadata

Static Fields

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_UUID_FIELD_NUMBER

public static final int CLUSTER_UUID_FIELD_NUMBER
Field Value
Type Description
int

CREATE_CLUSTER_FIELD_NUMBER

public static final int CREATE_CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

DAG_END_TIME_FIELD_NUMBER

public static final int DAG_END_TIME_FIELD_NUMBER
Field Value
Type Description
int

DAG_START_TIME_FIELD_NUMBER

public static final int DAG_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

DAG_TIMEOUT_FIELD_NUMBER

public static final int DAG_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

DELETE_CLUSTER_FIELD_NUMBER

public static final int DELETE_CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

GRAPH_FIELD_NUMBER

public static final int GRAPH_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TEMPLATE_FIELD_NUMBER

public static final int TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkflowMetadata getDefaultInstance()
Returns
Type Description
WorkflowMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WorkflowMetadata.Builder newBuilder()
Returns
Type Description
WorkflowMetadata.Builder

newBuilder(WorkflowMetadata prototype)

public static WorkflowMetadata.Builder newBuilder(WorkflowMetadata prototype)
Parameter
Name Description
prototype WorkflowMetadata
Returns
Type Description
WorkflowMetadata.Builder

parseDelimitedFrom(InputStream input)

public static WorkflowMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WorkflowMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkflowMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkflowMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WorkflowMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WorkflowMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkflowMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WorkflowMetadata> parser()
Returns
Type Description
Parser<WorkflowMetadata>

Methods

containsParameters(String key)

public boolean containsParameters(String key)

Map from parameter names to values that were used for those parameters.

map<string, string> parameters = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClusterName()

public String getClusterName()

Output only. The name of the target cluster.

string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Output only. The name of the target cluster.

string cluster_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clusterName.

getClusterUuid()

public String getClusterUuid()

Output only. The UUID of target cluster.

string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clusterUuid.

getClusterUuidBytes()

public ByteString getClusterUuidBytes()

Output only. The UUID of target cluster.

string cluster_uuid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clusterUuid.

getCreateCluster()

public ClusterOperation getCreateCluster()

Output only. The create cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ClusterOperation

The createCluster.

getCreateClusterOrBuilder()

public ClusterOperationOrBuilder getCreateClusterOrBuilder()

Output only. The create cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ClusterOperationOrBuilder

getDagEndTime()

public Timestamp getDagEndTime()

Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The dagEndTime.

getDagEndTimeOrBuilder()

public TimestampOrBuilder getDagEndTimeOrBuilder()

Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDagStartTime()

public Timestamp getDagStartTime()

Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The dagStartTime.

getDagStartTimeOrBuilder()

public TimestampOrBuilder getDagStartTimeOrBuilder()

Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDagTimeout()

public Duration getDagTimeout()

Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration).

.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Duration

The dagTimeout.

getDagTimeoutOrBuilder()

public DurationOrBuilder getDagTimeoutOrBuilder()

Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration).

.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public WorkflowMetadata getDefaultInstanceForType()
Returns
Type Description
WorkflowMetadata

getDeleteCluster()

public ClusterOperation getDeleteCluster()

Output only. The delete cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ClusterOperation

The deleteCluster.

getDeleteClusterOrBuilder()

public ClusterOperationOrBuilder getDeleteClusterOrBuilder()

Output only. The delete cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ClusterOperationOrBuilder

getEndTime()

public Timestamp getEndTime()

Output only. Workflow end time.

.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Workflow end time.

.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getGraph()

public WorkflowGraph getGraph()

Output only. The workflow graph.

.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowGraph

The graph.

getGraphOrBuilder()

public WorkflowGraphOrBuilder getGraphOrBuilder()

Output only. The workflow graph.

.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowGraphOrBuilder

getParameters()

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,String>

getParametersCount()

public int getParametersCount()

Map from parameter names to values that were used for those parameters.

map<string, string> parameters = 8;

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

Map from parameter names to values that were used for those parameters.

map<string, string> parameters = 8;

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

Map from parameter names to values that were used for those parameters.

map<string, string> parameters = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

Map from parameter names to values that were used for those parameters.

map<string, string> parameters = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<WorkflowMetadata> getParserForType()
Returns
Type Description
Parser<WorkflowMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. Workflow start time.

.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Workflow start time.

.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public WorkflowMetadata.State getState()

Output only. The workflow state.

.google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowMetadata.State

The state.

getStateValue()

public int getStateValue()

Output only. The workflow state.

.google.cloud.dataproc.v1.WorkflowMetadata.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTemplate()

public String getTemplate()

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 template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The template.

getTemplateBytes()

public ByteString getTemplateBytes()

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 template = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for template.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getVersion()

public int getVersion()

Output only. The version of template at the time of workflow instantiation.

int32 version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The version.

hasCreateCluster()

public boolean hasCreateCluster()

Output only. The create cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation create_cluster = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createCluster field is set.

hasDagEndTime()

public boolean hasDagEndTime()

Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

.google.protobuf.Timestamp dag_end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dagEndTime field is set.

hasDagStartTime()

public boolean hasDagStartTime()

Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

.google.protobuf.Timestamp dag_start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dagStartTime field is set.

hasDagTimeout()

public boolean hasDagTimeout()

Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration).

.google.protobuf.Duration dag_timeout = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dagTimeout field is set.

hasDeleteCluster()

public boolean hasDeleteCluster()

Output only. The delete cluster operation metadata.

.google.cloud.dataproc.v1.ClusterOperation delete_cluster = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteCluster field is set.

hasEndTime()

public boolean hasEndTime()

Output only. Workflow end time.

.google.protobuf.Timestamp end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasGraph()

public boolean hasGraph()

Output only. The workflow graph.

.google.cloud.dataproc.v1.WorkflowGraph graph = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the graph field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Workflow start time.

.google.protobuf.Timestamp start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WorkflowMetadata.Builder newBuilderForType()
Returns
Type Description
WorkflowMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkflowMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WorkflowMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WorkflowMetadata.Builder toBuilder()
Returns
Type Description
WorkflowMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException