Class: Google::Cloud::Dataproc::V1::WorkflowMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataproc/v1/workflow_templates.rb

Overview

A Dataproc workflow template resource.

Defined Under Namespace

Modules: State Classes: ParametersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_name ⇒ ::String (readonly)

Returns Output only. The name of the target cluster.

Returns:

  • (::String) —

    Output only. The name of the target cluster.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#cluster_uuid ⇒ ::String (readonly)

Returns Output only. The UUID of target cluster.

Returns:

  • (::String) —

    Output only. The UUID of target cluster.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#create_cluster ⇒ ::Google::Cloud::Dataproc::V1::ClusterOperation (readonly)

Returns Output only. The create cluster operation metadata.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#dag_end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#dag_start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#dag_timeout ⇒ ::Google::Protobuf::Duration (readonly)

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

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#delete_cluster ⇒ ::Google::Cloud::Dataproc::V1::ClusterOperation (readonly)

Returns Output only. The delete cluster operation metadata.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Workflow end time.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#graph ⇒ ::Google::Cloud::Dataproc::V1::WorkflowGraph (readonly)

Returns Output only. The workflow graph.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#parameters ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Workflow start time.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#state ⇒ ::Google::Cloud::Dataproc::V1::WorkflowMetadata::State (readonly)

Returns Output only. The workflow state.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#template ⇒ ::String (readonly)

Returns 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}.

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}



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end

#version ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 426

class WorkflowMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParametersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The operation state.
  module State
    # Unused.
    UNKNOWN = 0

    # The operation has been created.
    PENDING = 1

    # The operation is running.
    RUNNING = 2

    # The operation is done; either cancelled or completed.
    DONE = 3
  end
end