google-cloud-workflows-executions-v1 0.1.0

data/lib/google/cloud/workflows/executions/v1/executions/paths.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Workflows
+      module Executions
+        module V1
+          module Executions
+            # Path helper methods for the Executions API.
+            module Paths
+              ##
+              # Create a fully-qualified Execution resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param workflow [String]
+              # @param execution [String]
+              #
+              # @return [::String]
+              def execution_path project:, location:, workflow:, execution:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                raise ::ArgumentError, "workflow cannot contain /" if workflow.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/workflows/#{workflow}/executions/#{execution}"
+              end
+
+              ##
+              # Create a fully-qualified Workflow resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/workflows/{workflow}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param workflow [String]
+              #
+              # @return [::String]
+              def workflow_path project:, location:, workflow:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/workflows/#{workflow}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/workflows/executions/v1/executions.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/workflows/executions/v1/version"
+
+require "google/cloud/workflows/executions/v1/executions/credentials"
+require "google/cloud/workflows/executions/v1/executions/paths"
+require "google/cloud/workflows/executions/v1/executions/client"
+
+module Google
+  module Cloud
+    module Workflows
+      module Executions
+        module V1
+          ##
+          # Executions is used to start and manage running instances of
+          # [Workflows][google.cloud.workflows.v1.Workflow] called executions.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/cloud/workflows/executions/v1/executions"
+          #     client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+          #
+          module Executions
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "executions", "helpers.rb"
+require "google/cloud/workflows/executions/v1/executions/helpers" if ::File.file? helper_path

data/lib/google/cloud/workflows/executions/v1/executions_pb.rb

@@ -0,0 +1,81 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/workflows/executions/v1/executions.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/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/workflows/executions/v1/executions.proto", :syntax => :proto3) do
+    add_message "google.cloud.workflows.executions.v1.Execution" do
+      optional :name, :string, 1
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :end_time, :message, 3, "google.protobuf.Timestamp"
+      optional :state, :enum, 4, "google.cloud.workflows.executions.v1.Execution.State"
+      optional :argument, :string, 5
+      optional :result, :string, 6
+      optional :error, :message, 7, "google.cloud.workflows.executions.v1.Execution.Error"
+      optional :workflow_revision_id, :string, 8
+    end
+    add_message "google.cloud.workflows.executions.v1.Execution.Error" do
+      optional :payload, :string, 1
+      optional :context, :string, 2
+    end
+    add_enum "google.cloud.workflows.executions.v1.Execution.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :ACTIVE, 1
+      value :SUCCEEDED, 2
+      value :FAILED, 3
+      value :CANCELLED, 4
+    end
+    add_message "google.cloud.workflows.executions.v1.ListExecutionsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :view, :enum, 4, "google.cloud.workflows.executions.v1.ExecutionView"
+    end
+    add_message "google.cloud.workflows.executions.v1.ListExecutionsResponse" do
+      repeated :executions, :message, 1, "google.cloud.workflows.executions.v1.Execution"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.workflows.executions.v1.CreateExecutionRequest" do
+      optional :parent, :string, 1
+      optional :execution, :message, 2, "google.cloud.workflows.executions.v1.Execution"
+    end
+    add_message "google.cloud.workflows.executions.v1.GetExecutionRequest" do
+      optional :name, :string, 1
+      optional :view, :enum, 2, "google.cloud.workflows.executions.v1.ExecutionView"
+    end
+    add_message "google.cloud.workflows.executions.v1.CancelExecutionRequest" do
+      optional :name, :string, 1
+    end
+    add_enum "google.cloud.workflows.executions.v1.ExecutionView" do
+      value :EXECUTION_VIEW_UNSPECIFIED, 0
+      value :BASIC, 1
+      value :FULL, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Workflows
+      module Executions
+        module V1
+          Execution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution").msgclass
+          Execution::Error = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.Error").msgclass
+          Execution::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.State").enummodule
+          ListExecutionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.ListExecutionsRequest").msgclass
+          ListExecutionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.ListExecutionsResponse").msgclass
+          CreateExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.CreateExecutionRequest").msgclass
+          GetExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.GetExecutionRequest").msgclass
+          CancelExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.CancelExecutionRequest").msgclass
+          ExecutionView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.ExecutionView").enummodule
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/workflows/executions/v1/executions_services_pb.rb

@@ -0,0 +1,57 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/workflows/executions/v1/executions.proto for package 'google.cloud.workflows.executions.v1'
+# 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/workflows/executions/v1/executions_pb'
+
+module Google
+  module Cloud
+    module Workflows
+      module Executions
+        module V1
+          module Executions
+            # Executions is used to start and manage running instances of
+            # [Workflows][google.cloud.workflows.v1.Workflow] called executions.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.cloud.workflows.executions.v1.Executions'
+
+              # Returns a list of executions which belong to the workflow with
+              # the given name. The method returns executions of all workflow
+              # revisions. Returned executions are ordered by their start time (newest
+              # first).
+              rpc :ListExecutions, ::Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest, ::Google::Cloud::Workflows::Executions::V1::ListExecutionsResponse
+              # Creates a new execution using the latest revision of the given workflow.
+              rpc :CreateExecution, ::Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest, ::Google::Cloud::Workflows::Executions::V1::Execution
+              # Returns an execution of the given name.
+              rpc :GetExecution, ::Google::Cloud::Workflows::Executions::V1::GetExecutionRequest, ::Google::Cloud::Workflows::Executions::V1::Execution
+              # Cancels an execution of the given name.
+              rpc :CancelExecution, ::Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest, ::Google::Cloud::Workflows::Executions::V1::Execution
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/workflows/executions/v1/version.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Workflows
+      module Executions
+        module V1
+          VERSION = "0.1.0"
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/workflows/executions/v1.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+require "google/cloud/workflows/executions/v1/executions"
+require "google/cloud/workflows/executions/v1/version"
+
+module Google
+  module Cloud
+    module Workflows
+      module Executions
+        ##
+        # To load this package, including all its services, and instantiate a client:
+        #
+        #     require "google/cloud/workflows/executions/v1"
+        #     client = ::Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+        #
+        module V1
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "v1", "_helpers.rb"
+require "google/cloud/workflows/executions/v1/_helpers" if ::File.file? helper_path

data/lib/google-cloud-workflows-executions-v1.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/workflows/executions/v1"

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Workflows Executions V1 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,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    end
+  end
+end