google-cloud-bigtable-admin-v2 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f4a626f785e699393c2700bc86993e8144c23a0ff90f9dfa1f56277117b474
-  data.tar.gz: 7608be0bfdc048ca02d8ea8956803875406ae5e9bfeb56564740c5a2ef4200d6
+  metadata.gz: 45eeaf71ba8faefde2f2a52ab796329a34c201a0eea5bc1f896cce55a9a20740
+  data.tar.gz: e9d8b2de77dd4e0f14d39819c3a7b3a82d107ce3ab919d9755f2e7624fa0fffa
 SHA512:
-  metadata.gz: ddea900bdaadc1c8429f84861347edf7cf40a7dbb6782f92d7439085372f6af38e454922c060a6c4bd963a4090ae1a8857e1aa2a2be70743fb992dcdde8d930f
-  data.tar.gz: 428a46c00c62bd2342296ee21edb33e7da3728c4f56a349eb0dda37b59672cea917259a4597ce6b5a51418e052ea36f529407f5a67f662945864f6821df8864c
+  metadata.gz: 9616e9674ebbd0505f5c94f96c9d7a813eb6d6947728c2c1a6181e92f7b1a63a799686009fb64f938d796ed6502336f4bffd98dc9977bfbb916afa50bc9ab573
+  data.tar.gz: e5fb3cd64bb7c8fe90979b68002f7656bf32b84ea27af57dde206edb8678a2e29f9a7913b32b8087b32c77c37cb69729a97ef8cff4335803b3f4da3711864e58

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest.new # (req
 response = client.create_instance request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigtable-admin-v2/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-bigtable-admin-v2/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/bigtable)

data/lib/google/bigtable/admin/v2/bigtable_instance_admin_pb.rb

@@ -120,6 +120,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.bigtable.admin.v2.UpdateAppProfileMetadata" do
     end
+    add_message "google.bigtable.admin.v2.ListHotTabletsRequest" do
+      optional :parent, :string, 1
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :end_time, :message, 3, "google.protobuf.Timestamp"
+      optional :page_size, :int32, 4
+      optional :page_token, :string, 5
+    end
+    add_message "google.bigtable.admin.v2.ListHotTabletsResponse" do
+      repeated :hot_tablets, :message, 1, "google.bigtable.admin.v2.HotTablet"
+      optional :next_page_token, :string, 2
+    end
   end
 end
 
@@ -152,6 +163,8 @@ module Google
           UpdateAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateAppProfileRequest").msgclass
           DeleteAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.DeleteAppProfileRequest").msgclass
           UpdateAppProfileMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateAppProfileMetadata").msgclass
+          ListHotTabletsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ListHotTabletsRequest").msgclass
+          ListHotTabletsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ListHotTabletsResponse").msgclass
         end
       end
     end

data/lib/google/bigtable/admin/v2/bigtable_instance_admin_services_pb.rb

@@ -108,6 +108,9 @@ module Google
               rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
               # Returns permissions that the caller has on the specified instance resource.
               rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
+              # Lists hot tablets in a cluster, within the time range provided. Hot
+              # tablets are ordered based on CPU usage.
+              rpc :ListHotTablets, ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest, ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsResponse
             end
 
             Stub = Service.rpc_stub_class

data/lib/google/bigtable/admin/v2/instance_pb.rb

@@ -79,6 +79,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :cluster_id, :string, 1
       optional :allow_transactional_writes, :bool, 2
     end
+    add_message "google.bigtable.admin.v2.HotTablet" do
+      optional :name, :string, 1
+      optional :table_name, :string, 2
+      optional :start_time, :message, 3, "google.protobuf.Timestamp"
+      optional :end_time, :message, 4, "google.protobuf.Timestamp"
+      optional :start_key, :string, 5
+      optional :end_key, :string, 6
+      optional :node_cpu_usage_percent, :float, 7
+    end
   end
 end
 
@@ -100,6 +109,7 @@ module Google
           AppProfile = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile").msgclass
           AppProfile::MultiClusterRoutingUseAny = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny").msgclass
           AppProfile::SingleClusterRouting = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.SingleClusterRouting").msgclass
+          HotTablet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.HotTablet").msgclass
         end
       end
     end

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

@@ -146,6 +146,11 @@ module Google
                     initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14, 4]
                   }
 
+                  default_config.rpcs.list_hot_tablets.timeout = 60.0
+                  default_config.rpcs.list_hot_tablets.retry_policy = {
+                    initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14, 4]
+                  }
+
                   default_config
                 end
                 yield @configure if block_given?
@@ -2153,6 +2158,122 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Lists hot tablets in a cluster, within the time range provided. Hot
+              # tablets are ordered based on CPU usage.
+              #
+              # @overload list_hot_tablets(request, options = nil)
+              #   Pass arguments to `list_hot_tablets` via a request object, either of type
+              #   {::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest, ::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 list_hot_tablets(parent: nil, start_time: nil, end_time: nil, page_size: nil, page_token: nil)
+              #   Pass arguments to `list_hot_tablets` 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 parent [::String]
+              #     Required. The cluster name to list hot tablets.
+              #     Value is in the following form:
+              #     `projects/{project}/instances/{instance}/clusters/{cluster}`.
+              #   @param start_time [::Google::Protobuf::Timestamp, ::Hash]
+              #     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 end_time [::Google::Protobuf::Timestamp, ::Hash]
+              #     The end time to list hot tablets.
+              #   @param page_size [::Integer]
+              #     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 page_token [::String]
+              #     The value of `next_page_token` returned by a previous call.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/bigtable/admin/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest.new
+              #
+              #   # Call the list_hot_tablets method.
+              #   result = client.list_hot_tablets 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::Bigtable::Admin::V2::HotTablet.
+              #     p response
+              #   end
+              #
+              def list_hot_tablets request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest
+
+                # 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.list_hot_tablets.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::Bigtable::Admin::V2::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                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_hot_tablets.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_hot_tablets.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @bigtable_instance_admin_stub.call_rpc :list_hot_tablets, request, options: options do |response, operation|
+                  response = ::Gapic::PagedEnumerable.new @bigtable_instance_admin_stub, :list_hot_tablets, request, response, operation, 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 BigtableInstanceAdmin API.
               #
@@ -2388,6 +2509,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :test_iam_permissions
+                  ##
+                  # RPC-specific configuration for `list_hot_tablets`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_hot_tablets
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -2431,6 +2557,8 @@ module Google
                     @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
                     test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
                     @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
+                    list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
+                    @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config
 
                     yield self if block_given?
                   end

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

@@ -22,7 +22,7 @@ module Google
     module Bigtable
       module Admin
         module V2
-          VERSION = "0.8.1"
+          VERSION = "0.9.0"
         end
       end
     end

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

@@ -27,6 +27,8 @@ module Google
         ##
         # To load this package, including all its services, and instantiate a client:
         #
+        # @example
+        #
         #     require "google/cloud/bigtable/admin/v2"
         #     client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new
         #

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

@@ -399,6 +399,60 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Request message for BigtableInstanceAdmin.ListHotTablets.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The cluster name to list hot tablets.
+          #     Value is in the following form:
+          #     `projects/{project}/instances/{instance}/clusters/{cluster}`.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     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.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The end time to list hot tablets.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     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.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The value of `next_page_token` returned by a previous call.
+          class ListHotTabletsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for BigtableInstanceAdmin.ListHotTablets.
+          # @!attribute [rw] hot_tablets
+          #   @return [::Array<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
+          #     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.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     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.
+          class ListHotTabletsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

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

@@ -292,6 +292,42 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             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.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique name of the hot tablet. Values are of the form
+          #     `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`.
+          # @!attribute [rw] table_name
+          #   @return [::String]
+          #     Name of the table that contains the tablet. Values are of the form
+          #     `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
+          # @!attribute [r] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The start time of the hot tablet.
+          # @!attribute [r] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The end time of the hot tablet.
+          # @!attribute [rw] start_key
+          #   @return [::String]
+          #     Tablet Start Key (inclusive).
+          # @!attribute [rw] end_key
+          #   @return [::String]
+          #     Tablet End Key (inclusive).
+          # @!attribute [r] node_cpu_usage_percent
+          #   @return [::Float]
+          #     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).
+          class HotTablet
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable-admin-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Bigtable Admin V2 API