Interface WorkflowMetadataOrBuilder (4.18.0)

public interface WorkflowMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsParameters(String key)

public abstract boolean containsParameters(String key)

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

map<string, string> parameters = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getClusterName()

public abstract String getClusterName()

Output only. The name of the target cluster.

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

Returns
TypeDescription
String

The clusterName.

getClusterNameBytes()

public abstract ByteString getClusterNameBytes()

Output only. The name of the target cluster.

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

Returns
TypeDescription
ByteString

The bytes for clusterName.

getClusterUuid()

public abstract String getClusterUuid()

Output only. The UUID of target cluster.

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

Returns
TypeDescription
String

The clusterUuid.

getClusterUuidBytes()

public abstract ByteString getClusterUuidBytes()

Output only. The UUID of target cluster.

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

Returns
TypeDescription
ByteString

The bytes for clusterUuid.

getCreateCluster()

public abstract ClusterOperation getCreateCluster()

Output only. The create cluster operation metadata.

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

Returns
TypeDescription
ClusterOperation

The createCluster.

getCreateClusterOrBuilder()

public abstract ClusterOperationOrBuilder getCreateClusterOrBuilder()

Output only. The create cluster operation metadata.

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

Returns
TypeDescription
ClusterOperationOrBuilder

getDagEndTime()

public abstract 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
TypeDescription
Timestamp

The dagEndTime.

getDagEndTimeOrBuilder()

public abstract 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
TypeDescription
TimestampOrBuilder

getDagStartTime()

public abstract 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
TypeDescription
Timestamp

The dagStartTime.

getDagStartTimeOrBuilder()

public abstract 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
TypeDescription
TimestampOrBuilder

getDagTimeout()

public abstract 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
TypeDescription
Duration

The dagTimeout.

getDagTimeoutOrBuilder()

public abstract 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
TypeDescription
DurationOrBuilder

getDeleteCluster()

public abstract ClusterOperation getDeleteCluster()

Output only. The delete cluster operation metadata.

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

Returns
TypeDescription
ClusterOperation

The deleteCluster.

getDeleteClusterOrBuilder()

public abstract ClusterOperationOrBuilder getDeleteClusterOrBuilder()

Output only. The delete cluster operation metadata.

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

Returns
TypeDescription
ClusterOperationOrBuilder

getEndTime()

public abstract Timestamp getEndTime()

Output only. Workflow end time.

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

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

Output only. Workflow end time.

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

Returns
TypeDescription
TimestampOrBuilder

getGraph()

public abstract WorkflowGraph getGraph()

Output only. The workflow graph.

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

Returns
TypeDescription
WorkflowGraph

The graph.

getGraphOrBuilder()

public abstract WorkflowGraphOrBuilder getGraphOrBuilder()

Output only. The workflow graph.

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

Returns
TypeDescription
WorkflowGraphOrBuilder

getParameters()

public abstract Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,String>

getParametersCount()

public abstract int getParametersCount()

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

map<string, string> parameters = 8;

Returns
TypeDescription
int

getParametersMap()

public abstract Map<String,String> getParametersMap()

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

map<string, string> parameters = 8;

Returns
TypeDescription
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public abstract String getParametersOrDefault(String key, String defaultValue)

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

map<string, string> parameters = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getParametersOrThrow(String key)

public abstract String getParametersOrThrow(String key)

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

map<string, string> parameters = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getStartTime()

public abstract Timestamp getStartTime()

Output only. Workflow start time.

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

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Output only. Workflow start time.

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

Returns
TypeDescription
TimestampOrBuilder

getState()

public abstract WorkflowMetadata.State getState()

Output only. The workflow state.

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

Returns
TypeDescription
WorkflowMetadata.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The workflow state.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTemplate()

public abstract 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
TypeDescription
String

The template.

getTemplateBytes()

public abstract 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
TypeDescription
ByteString

The bytes for template.

getVersion()

public abstract int getVersion()

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

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

Returns
TypeDescription
int

The version.

hasCreateCluster()

public abstract boolean hasCreateCluster()

Output only. The create cluster operation metadata.

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

Returns
TypeDescription
boolean

Whether the createCluster field is set.

hasDagEndTime()

public abstract 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
TypeDescription
boolean

Whether the dagEndTime field is set.

hasDagStartTime()

public abstract 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
TypeDescription
boolean

Whether the dagStartTime field is set.

hasDagTimeout()

public abstract 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
TypeDescription
boolean

Whether the dagTimeout field is set.

hasDeleteCluster()

public abstract boolean hasDeleteCluster()

Output only. The delete cluster operation metadata.

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

Returns
TypeDescription
boolean

Whether the deleteCluster field is set.

hasEndTime()

public abstract boolean hasEndTime()

Output only. Workflow end time.

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

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasGraph()

public abstract boolean hasGraph()

Output only. The workflow graph.

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

Returns
TypeDescription
boolean

Whether the graph field is set.

hasStartTime()

public abstract boolean hasStartTime()

Output only. Workflow start time.

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

Returns
TypeDescription
boolean

Whether the startTime field is set.