google-cloud-workflows-executions-v1 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8815cfaeddaaf865ac84d9daa950b39b54fde853edb193c36090642f0fcaf87d
-  data.tar.gz: 0540c3015e2e4dbf9743d9e70c311f91dbbfbc42fc0296f48c489638448df461
+  metadata.gz: bd65ecdc84d8c9383fb461bcf1066423add7d42accded33773243ec7e256aef0
+  data.tar.gz: b206cf641102b02c626fd54ac6a5d42f00449c7e44fde42662a2ab303f394e56
 SHA512:
-  metadata.gz: a3c5c8fadcf536601b858fd3b819fd05071039ad6ef35ab6ba78dfb4f5808f7f4cfe515ecbfb2ebd4c35671c35187651c5b6da4d207b96f81e80c79ceb9d155d
-  data.tar.gz: 2fb80027ae63f05539ebcdea71e5db3bfc30367afa89ee504316d828f65683009201fd99702f13eb8772fb14a6de901339fb7da2bdf6bf06fc7823830f04fc63
+  metadata.gz: df028c85bfc18217ebdd9241377f352e731aa5723048a39c6f42342a8d4bae6ef1e525dbbf461a7095969691ee7e36650890a2eec52ba7fcd076d6d874a4a58c
+  data.tar.gz: 215d9b80086305e8f4b1001f2508dc886f2ff68e8ac0732d194afc4f39a4c436996f44e6c79bc5875e721d6350210ed3daa9565eacb97f7fa926de4f3d13e5cc

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

@@ -194,6 +194,27 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest.new
+              #
+              #   # Call the list_executions method.
+              #   result = client.list_executions request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can
+              #   # iterate over all elements by calling #each, and the enumerable
+              #   # will lazily make API calls to fetch subsequent pages. Other
+              #   # methods are also available for managing paging directly.
+              #   result.each do |response|
+              #     # Each element is of type ::Google::Cloud::Workflows::Executions::V1::Execution.
+              #     p response
+              #   end
+              #
               def list_executions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -211,9 +232,11 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "parent" => request.parent
-                }
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -267,6 +290,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest.new
+              #
+              #   # Call the create_execution method.
+              #   result = client.create_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
+              #   p result
+              #
               def create_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -284,9 +322,11 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "parent" => request.parent
-                }
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -340,6 +380,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1::GetExecutionRequest.new
+              #
+              #   # Call the get_execution method.
+              #   result = client.get_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
+              #   p result
+              #
               def get_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -357,9 +412,11 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -410,6 +467,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest.new
+              #
+              #   # Call the cancel_execution method.
+              #   result = client.cancel_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
+              #   p result
+              #
               def cancel_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -427,9 +499,11 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -1,13 +1,13 @@
 # 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'
+require 'google/protobuf'
+
 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
@@ -19,10 +19,25 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :result, :string, 6
       optional :error, :message, 7, "google.cloud.workflows.executions.v1.Execution.Error"
       optional :workflow_revision_id, :string, 8
+      optional :call_log_level, :enum, 9, "google.cloud.workflows.executions.v1.Execution.CallLogLevel"
+    end
+    add_message "google.cloud.workflows.executions.v1.Execution.StackTraceElement" do
+      optional :step, :string, 1
+      optional :routine, :string, 2
+      optional :position, :message, 3, "google.cloud.workflows.executions.v1.Execution.StackTraceElement.Position"
+    end
+    add_message "google.cloud.workflows.executions.v1.Execution.StackTraceElement.Position" do
+      optional :line, :int64, 1
+      optional :column, :int64, 2
+      optional :length, :int64, 3
+    end
+    add_message "google.cloud.workflows.executions.v1.Execution.StackTrace" do
+      repeated :elements, :message, 1, "google.cloud.workflows.executions.v1.Execution.StackTraceElement"
     end
     add_message "google.cloud.workflows.executions.v1.Execution.Error" do
       optional :payload, :string, 1
       optional :context, :string, 2
+      optional :stack_trace, :message, 3, "google.cloud.workflows.executions.v1.Execution.StackTrace"
     end
     add_enum "google.cloud.workflows.executions.v1.Execution.State" do
       value :STATE_UNSPECIFIED, 0
@@ -31,6 +46,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :FAILED, 3
       value :CANCELLED, 4
     end
+    add_enum "google.cloud.workflows.executions.v1.Execution.CallLogLevel" do
+      value :CALL_LOG_LEVEL_UNSPECIFIED, 0
+      value :LOG_ALL_CALLS, 1
+      value :LOG_ERRORS_ONLY, 2
+    end
     add_message "google.cloud.workflows.executions.v1.ListExecutionsRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -66,8 +86,12 @@ module Google
       module Executions
         module V1
           Execution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution").msgclass
+          Execution::StackTraceElement = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.StackTraceElement").msgclass
+          Execution::StackTraceElement::Position = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.StackTraceElement.Position").msgclass
+          Execution::StackTrace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.StackTrace").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
+          Execution::CallLogLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.executions.v1.Execution.CallLogLevel").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

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

@@ -22,7 +22,7 @@ module Google
     module Workflows
       module Executions
         module V1
-          VERSION = "0.1.0"
+          VERSION = "0.1.1"
         end
       end
     end

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

@@ -42,6 +42,10 @@ module Google
           #   @return [::String]
           #     Input parameters of the execution represented as a JSON string.
           #     The size limit is 32KB.
+          #
+          #     *Note*: If you are using the REST API directly to run your workflow, you
+          #     must escape any JSON string value of `argument`. Example:
+          #     `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
           # @!attribute [r] result
           #   @return [::String]
           #     Output only. Output of the execution represented as a JSON string. The
@@ -54,23 +58,71 @@ module Google
           # @!attribute [r] workflow_revision_id
           #   @return [::String]
           #     Output only. Revision of the workflow this execution is using.
+          # @!attribute [rw] call_log_level
+          #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel]
+          #     The call logging level associated to this execution.
           class Execution
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
+            # A single stack element (frame) where an error occurred.
+            # @!attribute [rw] step
+            #   @return [::String]
+            #     The step the error occurred at.
+            # @!attribute [rw] routine
+            #   @return [::String]
+            #     The routine where the error occurred.
+            # @!attribute [rw] position
+            #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
+            #     The source position information of the stack trace element.
+            class StackTraceElement
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Position contains source position information about the stack trace
+              # element such as line number, column number and length of the code block
+              # in bytes.
+              # @!attribute [rw] line
+              #   @return [::Integer]
+              #     The source code line number the current instruction was generated from.
+              # @!attribute [rw] column
+              #   @return [::Integer]
+              #     The source code column position (of the line) the current instruction
+              #     was generated from.
+              # @!attribute [rw] length
+              #   @return [::Integer]
+              #     The number of bytes of source code making up this stack trace element.
+              class Position
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # A collection of stack elements (frames) where an error occurred.
+            # @!attribute [rw] elements
+            #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
+            #     An array of stack elements.
+            class StackTrace
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Error describes why the execution was abnormally terminated.
             # @!attribute [rw] payload
             #   @return [::String]
-            #     Error payload returned by the execution, represented as a JSON string.
+            #     Error message and data returned represented as a JSON string.
             # @!attribute [rw] context
             #   @return [::String]
-            #     Human readable error context, helpful for debugging purposes.
+            #     Human-readable stack trace string.
+            # @!attribute [rw] stack_trace
+            #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
+            #     Stack trace with detailed information of where error was generated.
             class Error
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # Describes the current state of the execution. More states may be added
+            # Describes the current state of the execution. More states might be added
             # in the future.
             module State
               # Invalid state.
@@ -88,6 +140,20 @@ module Google
               # The execution was stopped intentionally.
               CANCELLED = 4
             end
+
+            # Describes the level of platform logging to apply to calls and call
+            # responses during workflow executions.
+            module CallLogLevel
+              # No call logging specified.
+              CALL_LOG_LEVEL_UNSPECIFIED = 0
+
+              # Log all call steps within workflows, all call returns, and all exceptions
+              # raised.
+              LOG_ALL_CALLS = 1
+
+              # Log only exceptions that are raised from call steps within workflows.
+              LOG_ERRORS_ONLY = 2
+            end
           end
 
           # Request for the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-workflows-executions-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common