Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::WorkflowMetadata (v1.1.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::WorkflowMetadata.

A Dataproc workflow template resource.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#cluster_name

def cluster_name() -> ::String

Returns

(::String) — Output only. The name of the target cluster.

#cluster_uuid

def cluster_uuid() -> ::String

Returns

(::String) — Output only. The UUID of target cluster.

#create_cluster

def create_cluster() -> ::Google::Cloud::Dataproc::V1::ClusterOperation

Returns

(::Google::Cloud::Dataproc::V1::ClusterOperation) — Output only. The create cluster operation metadata.

#dag_end_time

def dag_end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.

#dag_start_time

def dag_start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.

#dag_timeout

def dag_timeout() -> ::Google::Protobuf::Duration

Returns

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

#delete_cluster

def delete_cluster() -> ::Google::Cloud::Dataproc::V1::ClusterOperation

Returns

(::Google::Cloud::Dataproc::V1::ClusterOperation) — Output only. The delete cluster operation metadata.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Workflow end time.

#graph

def graph() -> ::Google::Cloud::Dataproc::V1::WorkflowGraph

Returns

(::Google::Cloud::Dataproc::V1::WorkflowGraph) — Output only. The workflow graph.

#parameters

def parameters() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Map from parameter names to values that were used for those parameters.

#parameters=

def parameters=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Map from parameter names to values that were used for those parameters.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Map from parameter names to values that were used for those parameters.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Workflow start time.

#state

def state() -> ::Google::Cloud::Dataproc::V1::WorkflowMetadata::State

Returns

(::Google::Cloud::Dataproc::V1::WorkflowMetadata::State) — Output only. The workflow state.

#template

def template() -> ::String

Returns

(::String) —
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}

#version

def version() -> ::Integer

Returns

(::Integer) — Output only. The version of template at the time of workflow instantiation.