google-cloud-workflows-v1beta 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2aca2c22c518bce02f54bea160800445f13e3c9b09708f09b6d4f9e99a56aae
-  data.tar.gz: 999db61aedbbb8821db7be3e48318e6302192d6935b1e95e0f3cae77bbbc6983
+  metadata.gz: 9ac9e8c1a0a59971bfb330fee0d9011169638e25df8d63a6d18e39a1daa85be3
+  data.tar.gz: 582f66d2ae06429e4dffbe20c1647562e0939397d5f6957bb734d558bc385ccd
 SHA512:
-  metadata.gz: f3e30f61175760283701816ba02256a3cdb1ea8eb9e4d5e6358dbe0c351a4ab80b5e0cd920b3463ac4d23e5f28c31fcea28a1c2c5455259a680f726a4eda4ae4
-  data.tar.gz: eca5e42a98e5c2c86924ab10a424c773edbc3b893cdab0a255795192c9b164233ab5086c8234e45c0639f1ec08ddbf63daf223753a4e5b36358ed72395d3ec14
+  metadata.gz: b7e0a3b871b4ddef5da8087731fb9cd3b002da1604fca9282f4a1f81f396a8d4886b9e65121175ef32c79385c132db22968baf6dda785b36780365b652f65024
+  data.tar.gz: c7f9d1de368562d284375167ef459ad753340e872b8e7b37c2e7521d72c08af7451d1eedd9a0820dfc75e3e9dc24c9075b87d47926c39c14ce8ebaf109fd1cfa

data/README.md

@@ -6,6 +6,12 @@ Workflows link series of serverless tasks together in an order you define. Combi
 
 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 V1beta API. Most users should consider using
+the main client gem,
+[google-cloud-workflows](https://rubygems.org/gems/google-cloud-workflows).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 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`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-workflows-v1beta`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+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`.
+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
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-workflows-v1beta`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Workflows
       module V1beta
-        VERSION = "0.1.1"
+        VERSION = "0.2.0"
       end
     end
   end

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

@@ -128,7 +128,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are 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 &&
+                                       !@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)
                 credentials = Credentials.new credentials, scope: @config.scope
               end

data/lib/google/cloud/workflows/v1beta/workflows/operations.rb

@@ -103,8 +103,13 @@ module Google
             # Lists operations that match the specified filter in the request. If the
             # server doesn't support this method, it returns `UNIMPLEMENTED`.
             #
-            # NOTE: the `name` binding below allows API services to override the binding
-            # to use different resource name schemes, such as `users/*/operations`.
+            # NOTE: the `name` binding allows API services to override the binding
+            # to use different resource name schemes, such as `users/*/operations`. To
+            # override the binding, API services can add a binding such as
+            # `"/v1/{name=users/*}/operations"` to their service configuration.
+            # For backwards compatibility, the default name includes the operations
+            # collection id, however overriding users must ensure the name binding
+            # is the parent resource, without the operations collection id.
             #
             # @overload list_operations(request, options = nil)
             #   Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     The name of the operation collection.
+            #     The name of the operation's parent resource.
             #   @param filter [::String]
             #     The standard list filter.
             #   @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Waits for the specified long-running operation until it is done or reaches
+            # at most a specified timeout, returning the latest state.  If the operation
+            # is already done, the latest state is immediately returned.  If the timeout
+            # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+            # timeout is used.  If the server does not support this method, it returns
+            # `google.rpc.Code.UNIMPLEMENTED`.
+            # Note that this method is on a best-effort basis.  It may return the latest
+            # state before the specified timeout (including immediately), meaning even an
+            # immediate response is no guarantee that the operation is done.
+            #
+            # @overload wait_operation(request, options = nil)
+            #   Pass arguments to `wait_operation` via a request object, either of type
+            #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload wait_operation(name: nil, timeout: nil)
+            #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     The name of the operation resource to wait on.
+            #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+            #     The maximum duration to wait before timing out. If left blank, the wait
+            #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+            #     If RPC context deadline is also specified, the shorter one will be used.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def wait_operation request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.wait_operation.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.wait_operation.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the Operations API.
             #
@@ -546,6 +624,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :cancel_operation
+                ##
+                # RPC-specific configuration for `wait_operation`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :wait_operation
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -557,6 +640,8 @@ module Google
                   @delete_operation = ::Gapic::Config::Method.new delete_operation_config
                   cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
                   @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                  wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
+                  @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                   yield self if block_given?
                 end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # 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
     end
   end
 end

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-workflows-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -154,7 +154,9 @@ description: Workflows link series of serverless tasks together in an order you
   Combine the power of Google Cloud's APIs, serverless products like Cloud Functions
   and Cloud Run, and calls to external APIs to create flexible serverless applications.
   Workflows requires no infrastructure management and scales seamlessly with demand,
-  including scaling down to zero..
+  including scaling down to zero.. Note that google-cloud-workflows-v1beta is a version-specific
+  client library. For most uses, we recommend installing the main client library google-cloud-workflows
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -180,6 +182,7 @@ files:
 - proto_docs/google/cloud/workflows/v1beta/workflows.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
+- proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb