google-cloud-workflows-executions-v1beta 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88102da31538db9498060e0dbd26b9603faaccc2fa6a6c58d4a401dd2c232306
-  data.tar.gz: 97a0a0eddb974e701249215bed36498ac113ee3177701b239be860c85d48fd72
+  metadata.gz: b99fb81ca080b971878f94f8a9fdd6140d32aabe88cd0b7395eec36081215ff6
+  data.tar.gz: bb89442de9215b5f3e16023cb6f8370191deb91e7547d359a537569010d67547
 SHA512:
-  metadata.gz: bf3b6dd8c2e035ddfc930c8a2e4a1c37b2fe3d6c5fea75f2255f0d4424be360a1d4a3a9e1d0d5c6c1975c3e112a291fd4e44ba80c5369acff83b93fa1c3638d2
-  data.tar.gz: e70efa328883e7b9216391c3b49e7d96d6f831b5053412172b210bdbc906c95ac6c08668893c17cf91f038d196bc5e8d807ef4947dc3af23c6b9e020cc276460
+  metadata.gz: 0bbb0b8e0f267f93343cd5a95e3a9b0d5bbc6d1fe76310cd714544bcbf0257069ffa00ed83dd0012c523bb1e999d6b668791098948ce8a26c752aefd77f465f9
+  data.tar.gz: '086cd7e637fa89eff55798f178a6242e5ec29267f39efec71a473196d35dc7809c198005ca80b36d7894c114ea4874116500467024321a9de52fdbd4e888f64c'

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-workflows-executions-v1beta
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Workflows::Executions::V1beta::Executions::Credentials}):
 
-1. `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `WORKFLOWS_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
+* `WORKFLOWS_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/workflows/executions/v1beta"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/workflows/executions/v1beta"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/workflows/executions/v1beta"

data/README.md

@@ -9,7 +9,7 @@ https://github.com/googleapis/google-cloud-ruby
 This gem is a _versioned_ client. It provides basic client classes for a
 specific version of the Workflows Executions V1beta API. Most users should consider using
 the main client gem,
-[google-cloud-workflows-executions](https://rubygems.org/gems/google-cloud-workflows-executions).
+[google-cloud-workflows](https://rubygems.org/gems/google-cloud-workflows).
 See the section below titled *Which client should I use?* for more information.
 
 ## Installation
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/workflows/executions/v1beta"
 
 client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
-request = my_create_request
+request = ::Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest.new # (request fields as keyword arguments...)
 response = client.list_executions request
 ```
 
@@ -83,7 +83,7 @@ about the Ruby support schedule.
 ## Which client should I use?
 
 Most modern Ruby client libraries for Google APIs come in two flavors: the main
-client library with a name such as `google-cloud-workflows-executions`,
+client library with a name such as `google-cloud-workflows`,
 and lower-level _versioned_ client libraries with names such as
 `google-cloud-workflows-executions-v1beta`.
 _In most cases, you should install the main client._
@@ -110,7 +110,7 @@ service version.
 
 We recommend that most users install the main client gem for a service. You can
 identify this gem as the one _without_ a version in its name, e.g.
-`google-cloud-workflows-executions`.
+`google-cloud-workflows`.
 The main client is recommended because it will embody the best practices for
 accessing the service, and may also provide more convenient interfaces or
 tighter integration into frameworks and third-party libraries. In addition, the

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

@@ -43,13 +43,12 @@ module Google
               # See {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client::Configuration}
               # for a description of the configuration fields.
               #
-              # ## Example
+              # @example
               #
-              # To modify the configuration for all Executions clients:
-              #
-              #     ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
-              #       config.timeout = 10.0
-              #     end
+              #   # Modify the configuration for all Executions clients
+              #   ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
               #
               # @yield [config] Configure the Client client.
               # @yieldparam config [Client::Configuration]
@@ -96,19 +95,15 @@ module Google
               ##
               # Create a new Executions client object.
               #
-              # ## Examples
-              #
-              # To create a new Executions client with the default
-              # configuration:
-              #
-              #     client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
+              # @example
               #
-              # To create a new Executions client with a custom
-              # configuration:
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
               #
-              #     client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
-              #       config.timeout = 10.0
-              #     end
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
               #
               # @yield [config] Configure the Executions client.
               # @yieldparam config [Client::Configuration]
@@ -128,14 +123,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                         @config.endpoint == Client.configure.endpoint &&
+                enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                          !@config.endpoint.split(".").first.include?("-")
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
-                if credentials.is_a?(String) || credentials.is_a?(Hash)
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
                 @quota_project_id = @config.quota_project
@@ -200,6 +194,27 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1beta::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::V1beta::Execution.
+              #     p response
+              #   end
+              #
               def list_executions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -217,16 +232,20 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::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
 
                 options.apply_defaults timeout:      @config.rpcs.list_executions.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.list_executions.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @executions_stub.call_rpc :list_executions, request, options: options do |response, operation|
@@ -271,6 +290,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1beta::CreateExecutionRequest.new
+              #
+              #   # Call the create_execution method.
+              #   result = client.create_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
+              #   p result
+              #
               def create_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -288,16 +322,20 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::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
 
                 options.apply_defaults timeout:      @config.rpcs.create_execution.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.create_execution.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @executions_stub.call_rpc :create_execution, request, options: options do |response, operation|
@@ -342,6 +380,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1beta::GetExecutionRequest.new
+              #
+              #   # Call the get_execution method.
+              #   result = client.get_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
+              #   p result
+              #
               def get_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -359,16 +412,20 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::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
 
                 options.apply_defaults timeout:      @config.rpcs.get_execution.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.get_execution.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @executions_stub.call_rpc :get_execution, request, options: options do |response, operation|
@@ -410,6 +467,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/workflows/executions/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workflows::Executions::V1beta::CancelExecutionRequest.new
+              #
+              #   # Call the cancel_execution method.
+              #   result = client.cancel_execution request
+              #
+              #   # The returned object is of type Google::Cloud::Workflows::Executions::V1beta::Execution.
+              #   p result
+              #
               def cancel_execution request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -427,16 +499,20 @@ module Google
                   gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::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
 
                 options.apply_defaults timeout:      @config.rpcs.cancel_execution.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.cancel_execution.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @executions_stub.call_rpc :cancel_execution, request, options: options do |response, operation|
@@ -460,22 +536,21 @@ module Google
               # Configuration can be applied globally to all clients, or to a single client
               # on construction.
               #
-              # # Examples
-              #
-              # To modify the global config, setting the timeout for list_executions
-              # to 20 seconds, and all remaining timeouts to 10 seconds:
-              #
-              #     ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
-              #       config.timeout = 10.0
-              #       config.rpcs.list_executions.timeout = 20.0
-              #     end
-              #
-              # To apply the above configuration only to a new client:
-              #
-              #     client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
-              #       config.timeout = 10.0
-              #       config.rpcs.list_executions.timeout = 20.0
-              #     end
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # list_executions to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_executions.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_executions.timeout = 20.0
+              #   end
               #
               # @!attribute [rw] endpoint
               #   The hostname or hostname:port of the service endpoint.

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

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/workflows/executions/v1beta/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/v1beta/executions.proto", :syntax => :proto3) do
     add_message "google.cloud.workflows.executions.v1beta.Execution" do

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

@@ -22,7 +22,7 @@ module Google
     module Workflows
       module Executions
         module V1beta
-          VERSION = "0.3.1"
+          VERSION = "0.3.5"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # 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
+      # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-workflows-executions-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -162,8 +162,7 @@ description: Workflows link series of serverless tasks together in an order you
   Workflows requires no infrastructure management and scales seamlessly with demand,
   including scaling down to zero.. Note that google-cloud-workflows-executions-v1beta
   is a version-specific client library. For most uses, we recommend installing the
-  main client library google-cloud-workflows-executions instead. See the readme for
-  more details.
+  main client library google-cloud-workflows instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []