Class: Google::Cloud::Dataproc::V1::WorkflowTemplate

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

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The time template was created.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#dag_timeout ⇒ ::Google::Protobuf::Duration

Returns Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.

Returns:

  • (::Google::Protobuf::Duration) —

    Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#id ⇒ ::String

Returns:

  • (::String) 


93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#jobs ⇒ ::Array<::Google::Cloud::Dataproc::V1::OrderedJob>

Returns Required. The Directed Acyclic Graph of Jobs to submit.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

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

Returns Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

No more than 32 labels can be associated with a template.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

    Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

    Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

    No more than 32 labels can be associated with a template.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#name ⇒ ::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}



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#parameters ⇒ ::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>

Returns Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#placement ⇒ ::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement

Returns Required. WorkflowTemplate scheduling information.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

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

Returns Output only. The time template was last updated.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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

#version ⇒ ::Integer

Returns Optional. Used to perform a consistent read-modify-write.

This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.

Returns:

  • (::Integer) —

    Optional. Used to perform a consistent read-modify-write.

    This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 93

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

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