google-cloud-dataproc-v1beta2 0.1.0

data/lib/google/cloud/dataproc/v1beta2/workflow_template_service/paths.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dataproc
+      module V1beta2
+        module WorkflowTemplateService
+          # Path helper methods for the WorkflowTemplateService API.
+          module Paths
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [String]
+            def location_path project:, location:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            ##
+            # Create a fully-qualified Region resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/regions/{region}`
+            #
+            # @param project [String]
+            # @param region [String]
+            #
+            # @return [String]
+            def region_path project:, region:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/regions/#{region}"
+            end
+
+            ##
+            # Create a fully-qualified WorkflowTemplate resource string.
+            #
+            # @overload workflow_template_path(project:, region:, workflow_template:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/regions/{region}/workflowTemplates/{workflow_template}`
+            #
+            #   @param project [String]
+            #   @param region [String]
+            #   @param workflow_template [String]
+            #
+            # @overload workflow_template_path(project:, location:, workflow_template:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/workflowTemplates/{workflow_template}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param workflow_template [String]
+            #
+            # @return [String]
+            def workflow_template_path **args
+              resources = {
+                "project:region:workflow_template"   => (proc do |project:, region:, workflow_template:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ArgumentError, "region cannot contain /" if region.to_s.include? "/"
+
+                  "projects/#{project}/regions/#{region}/workflowTemplates/#{workflow_template}"
+                end),
+                "location:project:workflow_template" => (proc do |project:, location:, workflow_template:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/workflowTemplates/#{workflow_template}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dataproc/v1beta2/workflow_templates_pb.rb

@@ -0,0 +1,189 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dataproc/v1beta2/workflow_templates.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/dataproc/v1beta2/clusters_pb'
+require 'google/cloud/dataproc/v1beta2/jobs_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/dataproc/v1beta2/workflow_templates.proto", :syntax => :proto3) do
+    add_message "google.cloud.dataproc.v1beta2.WorkflowTemplate" do
+      optional :id, :string, 2
+      optional :name, :string, 1
+      optional :version, :int32, 3
+      optional :create_time, :message, 4, "google.protobuf.Timestamp"
+      optional :update_time, :message, 5, "google.protobuf.Timestamp"
+      map :labels, :string, :string, 6
+      optional :placement, :message, 7, "google.cloud.dataproc.v1beta2.WorkflowTemplatePlacement"
+      repeated :jobs, :message, 8, "google.cloud.dataproc.v1beta2.OrderedJob"
+      repeated :parameters, :message, 9, "google.cloud.dataproc.v1beta2.TemplateParameter"
+    end
+    add_message "google.cloud.dataproc.v1beta2.WorkflowTemplatePlacement" do
+      oneof :placement do
+        optional :managed_cluster, :message, 1, "google.cloud.dataproc.v1beta2.ManagedCluster"
+        optional :cluster_selector, :message, 2, "google.cloud.dataproc.v1beta2.ClusterSelector"
+      end
+    end
+    add_message "google.cloud.dataproc.v1beta2.ManagedCluster" do
+      optional :cluster_name, :string, 2
+      optional :config, :message, 3, "google.cloud.dataproc.v1beta2.ClusterConfig"
+      map :labels, :string, :string, 4
+    end
+    add_message "google.cloud.dataproc.v1beta2.ClusterSelector" do
+      optional :zone, :string, 1
+      map :cluster_labels, :string, :string, 2
+    end
+    add_message "google.cloud.dataproc.v1beta2.OrderedJob" do
+      optional :step_id, :string, 1
+      map :labels, :string, :string, 8
+      optional :scheduling, :message, 9, "google.cloud.dataproc.v1beta2.JobScheduling"
+      repeated :prerequisite_step_ids, :string, 10
+      oneof :job_type do
+        optional :hadoop_job, :message, 2, "google.cloud.dataproc.v1beta2.HadoopJob"
+        optional :spark_job, :message, 3, "google.cloud.dataproc.v1beta2.SparkJob"
+        optional :pyspark_job, :message, 4, "google.cloud.dataproc.v1beta2.PySparkJob"
+        optional :hive_job, :message, 5, "google.cloud.dataproc.v1beta2.HiveJob"
+        optional :pig_job, :message, 6, "google.cloud.dataproc.v1beta2.PigJob"
+        optional :spark_r_job, :message, 11, "google.cloud.dataproc.v1beta2.SparkRJob"
+        optional :spark_sql_job, :message, 7, "google.cloud.dataproc.v1beta2.SparkSqlJob"
+        optional :presto_job, :message, 12, "google.cloud.dataproc.v1beta2.PrestoJob"
+      end
+    end
+    add_message "google.cloud.dataproc.v1beta2.TemplateParameter" do
+      optional :name, :string, 1
+      repeated :fields, :string, 2
+      optional :description, :string, 3
+      optional :validation, :message, 4, "google.cloud.dataproc.v1beta2.ParameterValidation"
+    end
+    add_message "google.cloud.dataproc.v1beta2.ParameterValidation" do
+      oneof :validation_type do
+        optional :regex, :message, 1, "google.cloud.dataproc.v1beta2.RegexValidation"
+        optional :values, :message, 2, "google.cloud.dataproc.v1beta2.ValueValidation"
+      end
+    end
+    add_message "google.cloud.dataproc.v1beta2.RegexValidation" do
+      repeated :regexes, :string, 1
+    end
+    add_message "google.cloud.dataproc.v1beta2.ValueValidation" do
+      repeated :values, :string, 1
+    end
+    add_message "google.cloud.dataproc.v1beta2.WorkflowMetadata" do
+      optional :template, :string, 1
+      optional :version, :int32, 2
+      optional :create_cluster, :message, 3, "google.cloud.dataproc.v1beta2.ClusterOperation"
+      optional :graph, :message, 4, "google.cloud.dataproc.v1beta2.WorkflowGraph"
+      optional :delete_cluster, :message, 5, "google.cloud.dataproc.v1beta2.ClusterOperation"
+      optional :state, :enum, 6, "google.cloud.dataproc.v1beta2.WorkflowMetadata.State"
+      optional :cluster_name, :string, 7
+      map :parameters, :string, :string, 8
+      optional :start_time, :message, 9, "google.protobuf.Timestamp"
+      optional :end_time, :message, 10, "google.protobuf.Timestamp"
+      optional :cluster_uuid, :string, 11
+    end
+    add_enum "google.cloud.dataproc.v1beta2.WorkflowMetadata.State" do
+      value :UNKNOWN, 0
+      value :PENDING, 1
+      value :RUNNING, 2
+      value :DONE, 3
+    end
+    add_message "google.cloud.dataproc.v1beta2.ClusterOperation" do
+      optional :operation_id, :string, 1
+      optional :error, :string, 2
+      optional :done, :bool, 3
+    end
+    add_message "google.cloud.dataproc.v1beta2.WorkflowGraph" do
+      repeated :nodes, :message, 1, "google.cloud.dataproc.v1beta2.WorkflowNode"
+    end
+    add_message "google.cloud.dataproc.v1beta2.WorkflowNode" do
+      optional :step_id, :string, 1
+      repeated :prerequisite_step_ids, :string, 2
+      optional :job_id, :string, 3
+      optional :state, :enum, 5, "google.cloud.dataproc.v1beta2.WorkflowNode.NodeState"
+      optional :error, :string, 6
+    end
+    add_enum "google.cloud.dataproc.v1beta2.WorkflowNode.NodeState" do
+      value :NODE_STATUS_UNSPECIFIED, 0
+      value :BLOCKED, 1
+      value :RUNNABLE, 2
+      value :RUNNING, 3
+      value :COMPLETED, 4
+      value :FAILED, 5
+    end
+    add_message "google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest" do
+      optional :parent, :string, 1
+      optional :template, :message, 2, "google.cloud.dataproc.v1beta2.WorkflowTemplate"
+    end
+    add_message "google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest" do
+      optional :name, :string, 1
+      optional :version, :int32, 2
+    end
+    add_message "google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest" do
+      optional :name, :string, 1
+      optional :version, :int32, 2
+      optional :instance_id, :string, 3
+      optional :request_id, :string, 5
+      map :parameters, :string, :string, 4
+    end
+    add_message "google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest" do
+      optional :parent, :string, 1
+      optional :template, :message, 2, "google.cloud.dataproc.v1beta2.WorkflowTemplate"
+      optional :instance_id, :string, 3
+      optional :request_id, :string, 4
+    end
+    add_message "google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest" do
+      optional :template, :message, 1, "google.cloud.dataproc.v1beta2.WorkflowTemplate"
+    end
+    add_message "google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.dataproc.v1beta2.ListWorkflowTemplatesResponse" do
+      repeated :templates, :message, 1, "google.cloud.dataproc.v1beta2.WorkflowTemplate"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest" do
+      optional :name, :string, 1
+      optional :version, :int32, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Dataproc
+      module V1beta2
+        WorkflowTemplate = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowTemplate").msgclass
+        WorkflowTemplatePlacement = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowTemplatePlacement").msgclass
+        ManagedCluster = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ManagedCluster").msgclass
+        ClusterSelector = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ClusterSelector").msgclass
+        OrderedJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.OrderedJob").msgclass
+        TemplateParameter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.TemplateParameter").msgclass
+        ParameterValidation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ParameterValidation").msgclass
+        RegexValidation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.RegexValidation").msgclass
+        ValueValidation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ValueValidation").msgclass
+        WorkflowMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowMetadata").msgclass
+        WorkflowMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowMetadata.State").enummodule
+        ClusterOperation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ClusterOperation").msgclass
+        WorkflowGraph = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowGraph").msgclass
+        WorkflowNode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowNode").msgclass
+        WorkflowNode::NodeState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.WorkflowNode.NodeState").enummodule
+        CreateWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest").msgclass
+        GetWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest").msgclass
+        InstantiateWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest").msgclass
+        InstantiateInlineWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest").msgclass
+        UpdateWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest").msgclass
+        ListWorkflowTemplatesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest").msgclass
+        ListWorkflowTemplatesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.ListWorkflowTemplatesResponse").msgclass
+        DeleteWorkflowTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/dataproc/v1beta2/workflow_templates_services_pb.rb

@@ -0,0 +1,104 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/dataproc/v1beta2/workflow_templates.proto for package 'google.cloud.dataproc.v1beta2'
+# Original file comments:
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/cloud/dataproc/v1beta2/workflow_templates_pb'
+
+module Google
+  module Cloud
+    module Dataproc
+      module V1beta2
+        module WorkflowTemplateService
+          # The API interface for managing Workflow Templates in the
+          # Dataproc API.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.dataproc.v1beta2.WorkflowTemplateService'
+
+            # Creates new workflow template.
+            rpc :CreateWorkflowTemplate, CreateWorkflowTemplateRequest, WorkflowTemplate
+            # Retrieves the latest workflow template.
+            #
+            # Can retrieve previously instantiated template by specifying optional
+            # version parameter.
+            rpc :GetWorkflowTemplate, GetWorkflowTemplateRequest, WorkflowTemplate
+            # Instantiates a template and begins execution.
+            #
+            # The returned Operation can be used to track execution of
+            # workflow by polling
+            # [operations.get][google.longrunning.Operations.GetOperation].
+            # The Operation will complete when entire workflow is finished.
+            #
+            # The running workflow can be aborted via
+            # [operations.cancel][google.longrunning.Operations.CancelOperation].
+            # This will cause any inflight jobs to be cancelled and workflow-owned
+            # clusters to be deleted.
+            #
+            # The [Operation.metadata][google.longrunning.Operation.metadata] will be
+            # [WorkflowMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#workflowmetadata).
+            # Also see [Using
+            # WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).
+            #
+            # On successful completion,
+            # [Operation.response][google.longrunning.Operation.response] will be
+            # [Empty][google.protobuf.Empty].
+            rpc :InstantiateWorkflowTemplate, InstantiateWorkflowTemplateRequest, Google::Longrunning::Operation
+            # Instantiates a template and begins execution.
+            #
+            # This method is equivalent to executing the sequence
+            # [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate],
+            # [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.DeleteWorkflowTemplate].
+            #
+            # The returned Operation can be used to track execution of
+            # workflow by polling
+            # [operations.get][google.longrunning.Operations.GetOperation].
+            # The Operation will complete when entire workflow is finished.
+            #
+            # The running workflow can be aborted via
+            # [operations.cancel][google.longrunning.Operations.CancelOperation].
+            # This will cause any inflight jobs to be cancelled and workflow-owned
+            # clusters to be deleted.
+            #
+            # The [Operation.metadata][google.longrunning.Operation.metadata] will be
+            # [WorkflowMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata).
+            # Also see [Using
+            # WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).
+            #
+            # On successful completion,
+            # [Operation.response][google.longrunning.Operation.response] will be
+            # [Empty][google.protobuf.Empty].
+            rpc :InstantiateInlineWorkflowTemplate, InstantiateInlineWorkflowTemplateRequest, Google::Longrunning::Operation
+            # Updates (replaces) workflow template. The updated template
+            # must contain version that matches the current server version.
+            rpc :UpdateWorkflowTemplate, UpdateWorkflowTemplateRequest, WorkflowTemplate
+            # Lists workflows that match the specified filter in the request.
+            rpc :ListWorkflowTemplates, ListWorkflowTemplatesRequest, ListWorkflowTemplatesResponse
+            # Deletes a workflow template. It does not cancel in-progress workflows.
+            rpc :DeleteWorkflowTemplate, DeleteWorkflowTemplateRequest, Google::Protobuf::Empty
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Dataproc V1beta2 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end