google-apis-bigtableadmin_v2 0.17.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aca44b1653692a013308874110d1afcdd3c5ef9c77e01759331741336c3a343a
-  data.tar.gz: 90a422c883cc8dbd385ad50abfa9e80df7c97e5be1b3bdee1bbfd3927dc2ce4f
+  metadata.gz: be677b9cb735daf1437a80d5365a3521abf41a9d962b2b26955d85f980c8fc66
+  data.tar.gz: 5e9f352204f25a7edcefbca0e6fbc687439efaa32a8fe3a33dc6cf8eccb20347
 SHA512:
-  metadata.gz: bed2085fc4e1dec0f76637e949779e821ecbc994452b5e4ea5b15c2ed378c5267cdc9d1466d13d47a1f32092a1df4bf54d772650bccb978df05bbe003c0d844b
-  data.tar.gz: 705aefaa6363e97745f87614522ad6df46a91b811cbbb459d5880ceda89e48fec729cb8d30eca13aa7f557554312240dfaa38ac76ea573ecafef79a479fdde5b
+  metadata.gz: 06bba4ca1b81674667e1816301df81b57c2e754517abe7a9d7c0587cb4ca92b8c6c4794710eefede6bb8fe1ec5ee8b0cd18f2181c64baae1fe2c493f2f875d93
+  data.tar.gz: 345283ad2ec5452512793528e24c4be2990cfdcd3bfa3743c31f5ceabbf015a8abf4efef5e11a248c29ffc848eda0945119496f3674820146a511e82e266e886

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release history for google-apis-bigtableadmin_v2
 
+### v0.20.0 (2022-05-16)
+
+* Regenerated from discovery document revision 20220430
+
+### v0.19.0 (2022-04-24)
+
+* Regenerated from discovery document revision 20220412
+
+### v0.18.0 (2022-04-04)
+
+* Regenerated from discovery document revision 20220329
+
 ### v0.17.0 (2022-03-27)
 
 * Regenerated from discovery document revision 20220313

data/lib/google/apis/bigtableadmin_v2/classes.rb

@@ -91,8 +91,8 @@ module Google
       # "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE"
       # , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice,
       # this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also
-      # exempts jose@example.com from DATA_READ logging, and aliya@example.com from
-      # DATA_WRITE logging.
+      # exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com`
+      # from DATA_WRITE logging.
       class AuditConfig
         include Google::Apis::Core::Hashable
       
@@ -333,7 +333,7 @@ module Google
         # @return [Google::Apis::BigtableadminV2::Expr]
         attr_accessor :condition
       
-        # Specifies the principals requesting access for a Cloud Platform resource. `
+        # Specifies the principals requesting access for a Google Cloud resource. `
         # members` can have the following values: * `allUsers`: A special identifier
         # that represents anyone who is on the internet; with or without a Google
         # account. * `allAuthenticatedUsers`: A special identifier that represents
@@ -728,7 +728,6 @@ module Google
         # Required. The clusters to be created within the instance, mapped by desired
         # cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/
         # myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank.
-        # Currently, at most four clusters can be specified.
         # Corresponds to the JSON property `clusters`
         # @return [Hash<String,Google::Apis::BigtableadminV2::Cluster>]
         attr_accessor :clusters
@@ -838,8 +837,7 @@ module Google
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
-      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
-      # `Empty` is empty JSON object ````.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
       class Empty
         include Google::Apis::Core::Hashable
       
@@ -861,9 +859,8 @@ module Google
         # 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. Values are of the form `projects/`project`/locations/`
-        # location`/keyRings/`keyring`/cryptoKeys/`key``
+        # must match the region of the cluster. Values are of the form `projects/`
+        # project`/locations/`location`/keyRings/`keyring`/cryptoKeys/`key``
         # Corresponds to the JSON property `kmsKeyName`
         # @return [String]
         attr_accessor :kms_key_name
@@ -1090,6 +1087,69 @@ module Google
         end
       end
       
+      # A tablet is a defined by a start and end key and is explained in https://cloud.
+      # google.com/bigtable/docs/overview#architecture and https://cloud.google.com/
+      # bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits
+      # high average cpu usage during the time interval from start time to end time.
+      class HotTablet
+        include Google::Apis::Core::Hashable
+      
+        # Tablet End Key (inclusive).
+        # Corresponds to the JSON property `endKey`
+        # @return [String]
+        attr_accessor :end_key
+      
+        # Output only. The end time of the hot tablet.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # The unique name of the hot tablet. Values are of the form `projects/`project`/
+        # instances/`instance`/clusters/`cluster`/hotTablets/[a-zA-Z0-9_-]*`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. The average CPU usage spent by a node on this tablet over the
+        # start_time to end_time time range. The percentage is the amount of CPU used by
+        # the node to serve the tablet, from 0% (tablet was not interacted with) to 100%
+        # (the node spent all cycles serving the hot tablet).
+        # Corresponds to the JSON property `nodeCpuUsagePercent`
+        # @return [Float]
+        attr_accessor :node_cpu_usage_percent
+      
+        # Tablet Start Key (inclusive).
+        # Corresponds to the JSON property `startKey`
+        # @return [String]
+        attr_accessor :start_key
+      
+        # Output only. The start time of the hot tablet.
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        # Name of the table that contains the tablet. Values are of the form `projects/`
+        # project`/instances/`instance`/tables/_a-zA-Z0-9*`.
+        # Corresponds to the JSON property `tableName`
+        # @return [String]
+        attr_accessor :table_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_key = args[:end_key] if args.key?(:end_key)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @name = args[:name] if args.key?(:name)
+          @node_cpu_usage_percent = args[:node_cpu_usage_percent] if args.key?(:node_cpu_usage_percent)
+          @start_key = args[:start_key] if args.key?(:start_key)
+          @start_time = args[:start_time] if args.key?(:start_time)
+          @table_name = args[:table_name] if args.key?(:table_name)
+        end
+      end
+      
       # A collection of Bigtable Tables and the resources that serve them. All tables
       # in an instance are served from all Clusters in the instance.
       class Instance
@@ -1264,6 +1324,36 @@ module Google
         end
       end
       
+      # Response message for BigtableInstanceAdmin.ListHotTablets.
+      class ListHotTabletsResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of hot tablets in the tables of the requested cluster that fall within
+        # the requested time range. Hot tablets are ordered by node cpu usage percent.
+        # If there are multiple hot tablets that correspond to the same tablet within a
+        # 15-minute interval, only the hot tablet with the highest node cpu usage will
+        # be included in the response.
+        # Corresponds to the JSON property `hotTablets`
+        # @return [Array<Google::Apis::BigtableadminV2::HotTablet>]
+        attr_accessor :hot_tablets
+      
+        # Set if not all hot tablets could be returned in a single response. Pass this
+        # value to `page_token` in another request to get the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @hot_tablets = args[:hot_tablets] if args.key?(:hot_tablets)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for BigtableInstanceAdmin.ListInstances.
       class ListInstancesResponse
         include Google::Apis::Core::Hashable
@@ -2147,7 +2237,7 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The set of permissions to check for the `resource`. Permissions with wildcards
-        # (such as '*' or 'storage.*') are not allowed. For more information see [IAM
+        # (such as `*` or `storage.*`) are not allowed. For more information see [IAM
         # Overview](https://cloud.google.com/iam/docs/overview#permissions).
         # Corresponds to the JSON property `permissions`
         # @return [Array<String>]

data/lib/google/apis/bigtableadmin_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module BigtableadminV2
       # Version of the google-apis-bigtableadmin_v2 gem
-      GEM_VERSION = "0.17.0"
+      GEM_VERSION = "0.20.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220313"
+      REVISION = "20220430"
     end
   end
 end

data/lib/google/apis/bigtableadmin_v2/representations.rb

@@ -208,6 +208,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class HotTablet
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Instance
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -238,6 +244,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListHotTabletsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListInstancesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -708,6 +720,19 @@ module Google
         end
       end
       
+      class HotTablet
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_key, as: 'endKey'
+          property :end_time, as: 'endTime'
+          property :name, as: 'name'
+          property :node_cpu_usage_percent, as: 'nodeCpuUsagePercent'
+          property :start_key, as: 'startKey'
+          property :start_time, as: 'startTime'
+          property :table_name, as: 'tableName'
+        end
+      end
+      
       class Instance
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -757,6 +782,15 @@ module Google
         end
       end
       
+      class ListHotTabletsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :hot_tablets, as: 'hotTablets', class: Google::Apis::BigtableadminV2::HotTablet, decorator: Google::Apis::BigtableadminV2::HotTablet::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class ListInstancesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/bigtableadmin_v2/service.rb

@@ -299,8 +299,9 @@ module Google
         # Gets the access control policy for an instance resource. Returns an empty
         # policy if an instance exists but does not have a policy set.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being requested. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -407,8 +408,9 @@ module Google
         # Sets the access control policy on an instance resource. Replaces any existing
         # policy.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being specified. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being specified. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -441,8 +443,9 @@ module Google
         
         # Returns permissions that the caller has on the specified instance resource.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy detail is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy detail is being requested. See [
+        #   Resource names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1033,8 +1036,9 @@ module Google
         # Gets the access control policy for a Table resource. Returns an empty policy
         # if the resource exists but does not have a policy set.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being requested. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1187,8 +1191,9 @@ module Google
         # Sets the access control policy on a Table resource. Replaces any existing
         # policy.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being specified. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being specified. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1221,8 +1226,9 @@ module Google
         
         # Returns permissions that the caller has on the specified table resource.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy detail is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy detail is being requested. See [
+        #   Resource names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1253,6 +1259,60 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lists hot tablets in a cluster, within the time range provided. Hot tablets
+        # are ordered based on CPU usage.
+        # @param [String] parent
+        #   Required. The cluster name to list hot tablets. Value is in the following form:
+        #   `projects/`project`/instances/`instance`/clusters/`cluster``.
+        # @param [String] end_time
+        #   The end time to list hot tablets.
+        # @param [Fixnum] page_size
+        #   Maximum number of results per page. A page_size that is empty or zero lets the
+        #   server choose the number of items to return. A page_size which is strictly
+        #   positive will return at most that many items. A negative page_size will cause
+        #   an error. Following the first request, subsequent paginated calls do not need
+        #   a page_size field. If a page_size is set in subsequent calls, it must match
+        #   the page_size given in the first request.
+        # @param [String] page_token
+        #   The value of `next_page_token` returned by a previous call.
+        # @param [String] start_time
+        #   The start time to list hot tablets. The hot tablets in the response will have
+        #   start times between the requested start time and end time. Start time defaults
+        #   to Now if it is unset, and end time defaults to Now - 24 hours if it is unset.
+        #   The start time should be less than the end time, and the maximum allowed time
+        #   range between start time and end time is 48 hours. Start time and end time
+        #   should have values between Now and Now - 14 days.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::ListHotTabletsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::ListHotTabletsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_instance_cluster_hot_tablets(parent, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+parent}/hotTablets', options)
+          command.response_representation = Google::Apis::BigtableadminV2::ListHotTabletsResponse::Representation
+          command.response_class = Google::Apis::BigtableadminV2::ListHotTabletsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['endTime'] = end_time unless end_time.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['startTime'] = start_time unless start_time.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Checks replication consistency based on a consistency token, that is, if
         # replication has caught up based on the conditions specified in the token and
         # the check request.
@@ -1469,8 +1529,9 @@ module Google
         # Gets the access control policy for a Table resource. Returns an empty policy
         # if the resource exists but does not have a policy set.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being requested. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1627,8 +1688,9 @@ module Google
         # Sets the access control policy on a Table resource. Replaces any existing
         # policy.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy is being specified. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy is being specified. See [Resource
+        #   names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1661,8 +1723,9 @@ module Google
         
         # Returns permissions that the caller has on the specified table resource.
         # @param [String] resource
-        #   REQUIRED: The resource for which the policy detail is being requested. See the
-        #   operation documentation for the appropriate value for this field.
+        #   REQUIRED: The resource for which the policy detail is being requested. See [
+        #   Resource names](https://cloud.google.com/apis/design/resource_names) for the
+        #   appropriate value for this field.
         # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1728,8 +1791,8 @@ module Google
         #   The resource that owns the locations collection, if applicable.
         # @param [String] filter
         #   A filter to narrow down results to a preferred subset. The filtering language
-        #   accepts strings like "displayName=tokyo", and is documented in more detail in [
-        #   AIP-160](https://google.aip.dev/160).
+        #   accepts strings like `"displayName=tokyo"`, and is documented in more detail
+        #   in [AIP-160](https://google.aip.dev/160).
         # @param [Fixnum] page_size
         #   The maximum number of results to return. If not set, the service selects a
         #   default.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-bigtableadmin_v2
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-bigtableadmin_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-bigtableadmin_v2/v0.17.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-bigtableadmin_v2/v0.20.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-bigtableadmin_v2
 post_install_message: 
 rdoc_options: []