Package com.google.cloud.dataproc.v1

Interface WorkflowMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WorkflowMetadata, WorkflowMetadata.Builder

public interface WorkflowMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsParameters(String key)	Map from parameter names to values that were used for those parameters.
String	getClusterName()	Output only.
com.google.protobuf.ByteString	getClusterNameBytes()	Output only.
String	getClusterUuid()	Output only.
com.google.protobuf.ByteString	getClusterUuidBytes()	Output only.
ClusterOperation	getCreateCluster()	Output only.
ClusterOperationOrBuilder	getCreateClusterOrBuilder()	Output only.
com.google.protobuf.Timestamp	getDagEndTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getDagEndTimeOrBuilder()	Output only.
com.google.protobuf.Timestamp	getDagStartTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getDagStartTimeOrBuilder()	Output only.
com.google.protobuf.Duration	getDagTimeout()	Output only.
com.google.protobuf.DurationOrBuilder	getDagTimeoutOrBuilder()	Output only.
ClusterOperation	getDeleteCluster()	Output only.
ClusterOperationOrBuilder	getDeleteClusterOrBuilder()	Output only.
com.google.protobuf.Timestamp	getEndTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder()	Output only.
WorkflowGraph	getGraph()	Output only.
WorkflowGraphOrBuilder	getGraphOrBuilder()	Output only.
Map<String,String>	getParameters()	Deprecated.
int	getParametersCount()	Map from parameter names to values that were used for those parameters.
Map<String,String>	getParametersMap()	Map from parameter names to values that were used for those parameters.
String	getParametersOrDefault(String key, String defaultValue)	Map from parameter names to values that were used for those parameters.
String	getParametersOrThrow(String key)	Map from parameter names to values that were used for those parameters.
com.google.protobuf.Timestamp	getStartTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder()	Output only.
WorkflowMetadata.State	getState()	Output only.
int	getStateValue()	Output only.
String	getTemplate()	Output only.
com.google.protobuf.ByteString	getTemplateBytes()	Output only.
int	getVersion()	Output only.
boolean	hasCreateCluster()	Output only.
boolean	hasDagEndTime()	Output only.
boolean	hasDagStartTime()	Output only.
boolean	hasDagTimeout()	Output only.
boolean	hasDeleteCluster()	Output only.
boolean	hasEndTime()	Output only.
boolean	hasGraph()	Output only.
boolean	hasStartTime()	Output only.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getTemplate

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:

The template.

getTemplateBytes

com.google.protobuf.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:

The bytes for template.

getVersion

int getVersion()

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

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

Returns:

The version.

hasCreateCluster

boolean hasCreateCluster()

 Output only. The create cluster operation metadata.
 

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

Returns:

Whether the createCluster field is set.

getCreateCluster

ClusterOperation getCreateCluster()

 Output only. The create cluster operation metadata.
 

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

Returns:

The createCluster.

getCreateClusterOrBuilder

ClusterOperationOrBuilder getCreateClusterOrBuilder()

 Output only. The create cluster operation metadata.
 

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

hasGraph

boolean hasGraph()

 Output only. The workflow graph.
 

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

Returns:

Whether the graph field is set.

getGraph

WorkflowGraph getGraph()

 Output only. The workflow graph.
 

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

Returns:

The graph.

getGraphOrBuilder

WorkflowGraphOrBuilder getGraphOrBuilder()

 Output only. The workflow graph.
 

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

hasDeleteCluster

boolean hasDeleteCluster()

 Output only. The delete cluster operation metadata.
 

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

Returns:

Whether the deleteCluster field is set.

getDeleteCluster

ClusterOperation getDeleteCluster()

 Output only. The delete cluster operation metadata.
 

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

Returns:

The deleteCluster.

getDeleteClusterOrBuilder

ClusterOperationOrBuilder getDeleteClusterOrBuilder()

 Output only. The delete cluster operation metadata.
 

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

getStateValue

int getStateValue()

 Output only. The workflow state.
 

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

Returns:

The enum numeric value on the wire for state.

getState

WorkflowMetadata.State getState()

 Output only. The workflow state.
 

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

Returns:

The state.

getClusterName

String getClusterName()

 Output only. The name of the target cluster.
 

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

Returns:

The clusterName.

getClusterNameBytes

com.google.protobuf.ByteString getClusterNameBytes()

 Output only. The name of the target cluster.
 

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

Returns:

The bytes for clusterName.

getParametersCount

int getParametersCount()

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

map<string, string> parameters = 8;

containsParameters

boolean containsParameters(String key)

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

map<string, string> parameters = 8;

getParameters

@Deprecated
Map<String,String> getParameters()

Deprecated.

Use getParametersMap() instead.

getParametersMap

Map<String,String> getParametersMap()

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

map<string, string> parameters = 8;

getParametersOrDefault

String getParametersOrDefault(String key,
                              String defaultValue)

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

map<string, string> parameters = 8;

getParametersOrThrow

String getParametersOrThrow(String key)

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

map<string, string> parameters = 8;

hasStartTime

boolean hasStartTime()

 Output only. Workflow start time.
 

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

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. Workflow start time.
 

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

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Workflow start time.
 

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

hasEndTime

boolean hasEndTime()

 Output only. Workflow end time.
 

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

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Output only. Workflow end time.
 

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

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. Workflow end time.
 

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

getClusterUuid

String getClusterUuid()

 Output only. The UUID of target cluster.
 

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

Returns:

The clusterUuid.

getClusterUuidBytes

com.google.protobuf.ByteString getClusterUuidBytes()

 Output only. The UUID of target cluster.
 

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

Returns:

The bytes for clusterUuid.

hasDagTimeout

boolean hasDagTimeout()

 Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 

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

Returns:

Whether the dagTimeout field is set.

getDagTimeout

com.google.protobuf.Duration getDagTimeout()

 Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 

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

Returns:

The dagTimeout.

getDagTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getDagTimeoutOrBuilder()

 Output only. The timeout duration for the DAG of jobs, expressed in seconds
 (see [JSON representation of
 duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
 

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

hasDagStartTime

boolean hasDagStartTime()

 Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
 

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

Returns:

Whether the dagStartTime field is set.

getDagStartTime

com.google.protobuf.Timestamp getDagStartTime()

 Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
 

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

Returns:

The dagStartTime.

getDagStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getDagStartTimeOrBuilder()

 Output only. DAG start time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG begins.
 

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

hasDagEndTime

boolean hasDagEndTime()

 Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
 

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

Returns:

Whether the dagEndTime field is set.

getDagEndTime

com.google.protobuf.Timestamp getDagEndTime()

 Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
 

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

Returns:

The dagEndTime.

getDagEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getDagEndTimeOrBuilder()

 Output only. DAG end time, only set for workflows with
 [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
 DAG ends.
 

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