google-cloud-bigtable-v2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0737459cc90f1fe20794fb497bcc57047e8b67934ba6a8d6527404d1136fa1e
-  data.tar.gz: d1a4b9e035936f086684083119e8bf733a659cb4f825b0c5cacb307a74e218b3
+  metadata.gz: '08a9e41ea94e68ddb3d297aafa5e420d07736c56a795a31c795cb11dbe4b4077'
+  data.tar.gz: '09f849268a8b63151c6fff58db18f771f98b049f43e10abbc86bf65d54c919c3'
 SHA512:
-  metadata.gz: f3e298db1b3df4ad53a86a1eb1c0e527d5d4ad82bc60619c61dfdc09c7b8c08061a6693a138032e939343022e968ffad43743d42eda9820c2f6294cbc17660fa
-  data.tar.gz: df582ceb50406f8b4581207fdffbfecf260d9fbd74dcfeeb9fb75a6f8d820e45262cbc6702e5b2acc89f6103e9d726d3cba9b5d49328421a0bf5f8373b9465c4
+  metadata.gz: cf882b40e299c3c36d9eca1f048c659a3c2432ec2bdef6095a9b24bb269afa6b4c1a01ec823f223adbe6ea2779a444e52ee412981c77cc7d90cc0152fa04f1ef
+  data.tar.gz: 5ee72d966dfb41ac6d2297c0fe5c9d42dbee95b511f9ad0baf46ec259c11e5429a2fae69e5ee0d495abfa2f093638b328a3c30c6b7bbe9e1618010d125e7e5ba

data/README.md

@@ -6,6 +6,12 @@ Cloud Bigtable is a fully managed, scalable NoSQL database service for large ana
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Cloud Bigtable V2 API. Most users should consider using
+the main client gem,
+[google-cloud-bigtable](https://rubygems.org/gems/google-cloud-bigtable).
+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-bigtable`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-bigtable-v2`.
+_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-bigtable`.
+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-bigtable-v2`.
+
+### 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/bigtable/v2/bigtable_services_pb.rb

@@ -38,27 +38,27 @@ module Google
             # rows and cells may be broken up across multiple responses, but
             # atomicity of each row will still be preserved. See the
             # ReadRowsResponse documentation for details.
-            rpc :ReadRows, Google::Cloud::Bigtable::V2::ReadRowsRequest, stream(Google::Cloud::Bigtable::V2::ReadRowsResponse)
+            rpc :ReadRows, ::Google::Cloud::Bigtable::V2::ReadRowsRequest, stream(::Google::Cloud::Bigtable::V2::ReadRowsResponse)
             # Returns a sample of row keys in the table. The returned row keys will
             # delimit contiguous sections of the table of approximately equal size,
             # which can be used to break up the data for distributed tasks like
             # mapreduces.
-            rpc :SampleRowKeys, Google::Cloud::Bigtable::V2::SampleRowKeysRequest, stream(Google::Cloud::Bigtable::V2::SampleRowKeysResponse)
+            rpc :SampleRowKeys, ::Google::Cloud::Bigtable::V2::SampleRowKeysRequest, stream(::Google::Cloud::Bigtable::V2::SampleRowKeysResponse)
             # Mutates a row atomically. Cells already present in the row are left
             # unchanged unless explicitly changed by `mutation`.
-            rpc :MutateRow, Google::Cloud::Bigtable::V2::MutateRowRequest, Google::Cloud::Bigtable::V2::MutateRowResponse
+            rpc :MutateRow, ::Google::Cloud::Bigtable::V2::MutateRowRequest, ::Google::Cloud::Bigtable::V2::MutateRowResponse
             # Mutates multiple rows in a batch. Each individual row is mutated
             # atomically as in MutateRow, but the entire batch is not executed
             # atomically.
-            rpc :MutateRows, Google::Cloud::Bigtable::V2::MutateRowsRequest, stream(Google::Cloud::Bigtable::V2::MutateRowsResponse)
+            rpc :MutateRows, ::Google::Cloud::Bigtable::V2::MutateRowsRequest, stream(::Google::Cloud::Bigtable::V2::MutateRowsResponse)
             # Mutates a row atomically based on the output of a predicate Reader filter.
-            rpc :CheckAndMutateRow, Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest, Google::Cloud::Bigtable::V2::CheckAndMutateRowResponse
+            rpc :CheckAndMutateRow, ::Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest, ::Google::Cloud::Bigtable::V2::CheckAndMutateRowResponse
             # Modifies a row atomically on the server. The method reads the latest
             # existing timestamp and value from the specified columns and writes a new
             # entry based on pre-defined read/modify/write rules. The new value for the
             # timestamp is the greater of the existing timestamp or the current server
             # time. The method returns the new contents of all modified cells.
-            rpc :ReadModifyWriteRow, Google::Cloud::Bigtable::V2::ReadModifyWriteRowRequest, Google::Cloud::Bigtable::V2::ReadModifyWriteRowResponse
+            rpc :ReadModifyWriteRow, ::Google::Cloud::Bigtable::V2::ReadModifyWriteRowRequest, ::Google::Cloud::Bigtable::V2::ReadModifyWriteRowResponse
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/bigtable/v2.rb

@@ -33,3 +33,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v2", "_helpers.rb"
+require "google/cloud/bigtable/v2/_helpers" if ::File.file? helper_path

data/lib/google/cloud/bigtable/v2/bigtable/client.rb

@@ -66,22 +66,52 @@ module Google
                 default_config = Client::Configuration.new parent_config
 
                 default_config.rpcs.read_rows.timeout = 43_200.0
+                default_config.rpcs.read_rows.retry_policy = {
+                  initial_delay: 0.01,
+                  max_delay:     60.0,
+                  multiplier:    2,
+                  retry_codes:   []
+                }
 
                 default_config.rpcs.sample_row_keys.timeout = 60.0
+                default_config.rpcs.sample_row_keys.retry_policy = {
+                  initial_delay: 0.01,
+                  max_delay:     60.0,
+                  multiplier:    2,
+                  retry_codes:   []
+                }
 
                 default_config.rpcs.mutate_row.timeout = 60.0
                 default_config.rpcs.mutate_row.retry_policy = {
                   initial_delay: 0.01,
                   max_delay:     60.0,
                   multiplier:    2,
-                  retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
+                  retry_codes:   [14, 4]
                 }
 
                 default_config.rpcs.mutate_rows.timeout = 600.0
+                default_config.rpcs.mutate_rows.retry_policy = {
+                  initial_delay: 0.01,
+                  max_delay:     60.0,
+                  multiplier:    2,
+                  retry_codes:   []
+                }
 
                 default_config.rpcs.check_and_mutate_row.timeout = 20.0
+                default_config.rpcs.check_and_mutate_row.retry_policy = {
+                  initial_delay: 0.01,
+                  max_delay:     60.0,
+                  multiplier:    2,
+                  retry_codes:   []
+                }
 
                 default_config.rpcs.read_modify_write_row.timeout = 20.0
+                default_config.rpcs.read_modify_write_row.retry_policy = {
+                  initial_delay: 0.01,
+                  max_delay:     60.0,
+                  multiplier:    2,
+                  retry_codes:   []
+                }
 
                 default_config
               end
@@ -144,7 +174,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
@@ -732,7 +768,7 @@ module Google
 
               config_attr :endpoint,      "bigtable.googleapis.com", ::String
               config_attr :credentials,   nil do |value|
-                allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
@@ -772,7 +808,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:

data/lib/google/cloud/bigtable/v2/bigtable/helpers.rb

@@ -19,4 +19,6 @@ Google::Cloud::Bigtable::V2::Bigtable::Client.configure do |config|
   config.channel_args ||= {}
   config.channel_args["grpc.max_send_message_length"] = -1
   config.channel_args["grpc.max_receive_message_length"] = -1
+  config.channel_args["grpc.keepalive_time_ms"] = 30_000 # Sets 30s as Google Frontends allows keepalive pings at 30s
+  config.channel_args["grpc.keepalive_timeout_ms"] = 10_000 # Conservative timeout at 10s
 end

data/lib/google/cloud/bigtable/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Bigtable
       module V2
-        VERSION = "0.1.0"
+        VERSION = "0.2.0"
       end
     end
   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/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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 {
     #        ...
     #      }
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable-v2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -151,7 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Cloud Bigtable is a fully managed, scalable NoSQL database service for
-  large analytical and operational workloads.
+  large analytical and operational workloads. Note that google-cloud-bigtable-v2 is
+  a version-specific client library. For most uses, we recommend installing the main
+  client library google-cloud-bigtable instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Bigtable V2 API