google-cloud-bigtable-admin-v2 0.2.0 → 0.5.1

data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/paths.rb

@@ -65,6 +65,29 @@ module Google
                 "projects/#{project}/instances/#{instance}/clusters/#{cluster}"
               end
 
+              ##
+              # Create a fully-qualified CryptoKeyVersion resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param key_ring [String]
+              # @param crypto_key [String]
+              # @param crypto_key_version [String]
+              #
+              # @return [::String]
+              def crypto_key_version_path project:, location:, key_ring:, crypto_key:, crypto_key_version:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
+                raise ::ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
+              end
+
               ##
               # Create a fully-qualified Instance resource string.
               #

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

@@ -22,7 +22,7 @@ module Google
     module Bigtable
       module Admin
         module V2
-          VERSION = "0.2.0"
+          VERSION = "0.5.1"
         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/bigtable/admin/v2/bigtable_table_admin.rb

@@ -27,8 +27,8 @@ module Google
           # @!attribute [rw] parent
           #   @return [::String]
           #     Required. The name of the instance in which to create the restored
-          #     table. This instance must be the parent of the source backup. Values are
-          #     of the form `projects/<project>/instances/<instance>`.
+          #     table. This instance must be in the same project as the source backup.
+          #     Values are of the form `projects/<project>/instances/<instance>`.
           # @!attribute [rw] table_id
           #   @return [::String]
           #     Required. The id of the table to create and restore to. This

data/proto_docs/google/bigtable/admin/v2/instance.rb

@@ -130,10 +130,30 @@ module Google
           #     (`CreationOnly`)
           #     The type of storage used by this cluster to serve its
           #     parent instance's tables, unless explicitly overridden.
+          # @!attribute [rw] encryption_config
+          #   @return [::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig]
+          #     Immutable. The encryption configuration for CMEK-protected clusters.
           class Cluster
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
+            # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
+            # cluster.
+            # @!attribute [rw] kms_key_name
+            #   @return [::String]
+            #     Describes the Cloud KMS encryption key that will be used to protect the
+            #     destination Bigtable cluster. The requirements for this key are:
+            #      1) The Cloud Bigtable service account associated with the project that
+            #      contains this cluster must be granted the
+            #      `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
+            #      2) Only regional keys can be used and the region of the CMEK key must
+            #      match the region of the cluster.
+            #     3) All clusters within an instance must use the same CMEK key.
+            class EncryptionConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Possible states of a cluster.
             module State
               # The state of the cluster could not be determined.
@@ -166,7 +186,7 @@ module Google
           #   @return [::String]
           #     (`OutputOnly`)
           #     The unique name of the app profile. Values are of the form
-          #     `projects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
+          #     `projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
           # @!attribute [rw] etag
           #   @return [::String]
           #     Strongly validated etag for optimistic concurrency control. Preserve the

data/proto_docs/google/bigtable/admin/v2/table.rb

@@ -39,8 +39,8 @@ module Google
           # Each table is served using the resources of its parent cluster.
           # @!attribute [rw] name
           #   @return [::String]
-          #     Output only. The unique name of the table. Values are of the form
-          #     `projects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
+          #     The unique name of the table. Values are of the form
+          #     `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
           #     Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
           # @!attribute [rw] cluster_states
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState}]
@@ -48,7 +48,7 @@ module Google
           #     If it could not be determined whether or not the table has data in a
           #     particular cluster (for example, if its zone is unavailable), then
           #     there will be an entry for the cluster with UNKNOWN `replication_status`.
-          #     Views: `REPLICATION_VIEW`, `FULL`
+          #     Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
           # @!attribute [rw] column_families
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}]
           #     (`CreationOnly`)
@@ -73,6 +73,13 @@ module Google
             # @!attribute [rw] replication_state
             #   @return [::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
             #     Output only. The state of replication for the table in this cluster.
+            # @!attribute [r] encryption_info
+            #   @return [::Array<::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo>]
+            #     Output only. The encryption information for the table in this cluster.
+            #     If the encryption key protecting this resource is customer managed, then
+            #     its version can be rotated in Cloud Key Management Service (Cloud KMS).
+            #     The primary version of the key and its status will be reflected here when
+            #     changes propagate from Cloud KMS.
             class ClusterState
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -151,6 +158,9 @@ module Google
               # state.
               REPLICATION_VIEW = 3
 
+              # Only populates 'name' and fields related to the table's encryption state.
+              ENCRYPTION_VIEW = 5
+
               # Populates all fields.
               FULL = 4
             end
@@ -208,6 +218,47 @@ module Google
             end
           end
 
+          # Encryption information for a given resource.
+          # If this resource is protected with customer managed encryption, the in-use
+          # Cloud Key Management Service (Cloud KMS) key version is specified along with
+          # its status.
+          # @!attribute [r] encryption_type
+          #   @return [::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo::EncryptionType]
+          #     Output only. The type of encryption used to protect this resource.
+          # @!attribute [r] encryption_status
+          #   @return [::Google::Rpc::Status]
+          #     Output only. The status of encrypt/decrypt calls on underlying data for
+          #     this resource. Regardless of status, the existing data is always encrypted
+          #     at rest.
+          # @!attribute [r] kms_key_version
+          #   @return [::String]
+          #     Output only. The version of the Cloud KMS key specified in the parent
+          #     cluster that is in use for the data underlying this table.
+          class EncryptionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Possible encryption types for a resource.
+            module EncryptionType
+              # Encryption type was not specified, though data at rest remains encrypted.
+              ENCRYPTION_TYPE_UNSPECIFIED = 0
+
+              # The data backing this resource is encrypted at rest with a key that is
+              # fully managed by Google. No key version or status will be populated.
+              # This is the default state.
+              GOOGLE_DEFAULT_ENCRYPTION = 1
+
+              # The data backing this resource is encrypted at rest with a key that is
+              # managed by the customer.
+              # The in-use version of the key and its status are populated for
+              # CMEK-protected tables.
+              # CMEK-protected backups are pinned to the key version that was in use at
+              # the time the backup was taken. This key version is populated but its
+              # status is not tracked and is reported as `UNKNOWN`.
+              CUSTOMER_MANAGED_ENCRYPTION = 2
+            end
+          end
+
           # A snapshot of a table at a particular time. A snapshot can be used as a
           # checkpoint for data restoration or a data source for a new table.
           #
@@ -219,7 +270,7 @@ module Google
           #   @return [::String]
           #     Output only. The unique name of the snapshot.
           #     Values are of the form
-          #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
+          #     `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
           # @!attribute [rw] source_table
           #   @return [::Google::Cloud::Bigtable::Admin::V2::Table]
           #     Output only. The source table at the time the snapshot was taken.
@@ -304,6 +355,9 @@ module Google
           # @!attribute [r] state
           #   @return [::Google::Cloud::Bigtable::Admin::V2::Backup::State]
           #     Output only. The current state of the backup.
+          # @!attribute [r] encryption_info
+          #   @return [::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo]
+          #     Output only. The encryption information for the backup.
           class Backup
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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/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-bigtable-admin-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,10 @@ 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-admin-v2
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-bigtable-admin instead. See the readme for more
+  details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -232,14 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Bigtable Admin V2 API