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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 51f4a626f785e699393c2700bc86993e8144c23a0ff90f9dfa1f56277117b474
4
- data.tar.gz: 7608be0bfdc048ca02d8ea8956803875406ae5e9bfeb56564740c5a2ef4200d6
3
+ metadata.gz: cc00e8dac52b4e098d39e16fe3235c363db3836a5f0baa36ec36c953c2897897
4
+ data.tar.gz: d58b5a918e0285546727d221dfdbe4d95ac34f7c23b014ad3a5bdd537719a668
5
5
  SHA512:
6
- metadata.gz: ddea900bdaadc1c8429f84861347edf7cf40a7dbb6782f92d7439085372f6af38e454922c060a6c4bd963a4090ae1a8857e1aa2a2be70743fb992dcdde8d930f
7
- data.tar.gz: 428a46c00c62bd2342296ee21edb33e7da3728c4f56a349eb0dda37b59672cea917259a4597ce6b5a51418e052ea36f529407f5a67f662945864f6821df8864c
6
+ metadata.gz: d704e8ee018d9b7c622d1fc77a083d85ac923ee95b4ec4db327ea442cfc64d31fbe69dfbd1667f78a0bb2ec9dd723623ad54e3a60ada6add141150b28b304f93
7
+ data.tar.gz: c53e4b6d5e435f45ea5ff6e3586356c34018d9066cd574052ff3013a681cf27eaca1a85be83922cb6196cea7b9896f56dded447085d2d4cd37651f502bd8f7cf
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest.new # (req
37
37
  response = client.create_instance request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigtable-admin-v2/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-bigtable-admin-v2/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/bigtable)
@@ -120,6 +120,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
120
120
  end
121
121
  add_message "google.bigtable.admin.v2.UpdateAppProfileMetadata" do
122
122
  end
123
+ add_message "google.bigtable.admin.v2.ListHotTabletsRequest" do
124
+ optional :parent, :string, 1
125
+ optional :start_time, :message, 2, "google.protobuf.Timestamp"
126
+ optional :end_time, :message, 3, "google.protobuf.Timestamp"
127
+ optional :page_size, :int32, 4
128
+ optional :page_token, :string, 5
129
+ end
130
+ add_message "google.bigtable.admin.v2.ListHotTabletsResponse" do
131
+ repeated :hot_tablets, :message, 1, "google.bigtable.admin.v2.HotTablet"
132
+ optional :next_page_token, :string, 2
133
+ end
123
134
  end
124
135
  end
125
136
 
@@ -152,6 +163,8 @@ module Google
152
163
  UpdateAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateAppProfileRequest").msgclass
153
164
  DeleteAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.DeleteAppProfileRequest").msgclass
154
165
  UpdateAppProfileMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateAppProfileMetadata").msgclass
166
+ ListHotTabletsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ListHotTabletsRequest").msgclass
167
+ ListHotTabletsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ListHotTabletsResponse").msgclass
155
168
  end
156
169
  end
157
170
  end
@@ -108,6 +108,9 @@ module Google
108
108
  rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
109
109
  # Returns permissions that the caller has on the specified instance resource.
110
110
  rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
111
+ # Lists hot tablets in a cluster, within the time range provided. Hot
112
+ # tablets are ordered based on CPU usage.
113
+ rpc :ListHotTablets, ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest, ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsResponse
111
114
  end
112
115
 
113
116
  Stub = Service.rpc_stub_class
@@ -79,6 +79,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
79
79
  optional :cluster_id, :string, 1
80
80
  optional :allow_transactional_writes, :bool, 2
81
81
  end
82
+ add_message "google.bigtable.admin.v2.HotTablet" do
83
+ optional :name, :string, 1
84
+ optional :table_name, :string, 2
85
+ optional :start_time, :message, 3, "google.protobuf.Timestamp"
86
+ optional :end_time, :message, 4, "google.protobuf.Timestamp"
87
+ optional :start_key, :string, 5
88
+ optional :end_key, :string, 6
89
+ optional :node_cpu_usage_percent, :float, 7
90
+ end
82
91
  end
83
92
  end
84
93
 
@@ -100,6 +109,7 @@ module Google
100
109
  AppProfile = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile").msgclass
101
110
  AppProfile::MultiClusterRoutingUseAny = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny").msgclass
102
111
  AppProfile::SingleClusterRouting = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.SingleClusterRouting").msgclass
112
+ HotTablet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.HotTablet").msgclass
103
113
  end
104
114
  end
105
115
  end
@@ -146,6 +146,11 @@ module Google
146
146
  initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14, 4]
147
147
  }
148
148
 
149
+ default_config.rpcs.list_hot_tablets.timeout = 60.0
150
+ default_config.rpcs.list_hot_tablets.retry_policy = {
151
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14, 4]
152
+ }
153
+
149
154
  default_config
150
155
  end
151
156
  yield @configure if block_given?
@@ -1904,7 +1909,7 @@ module Google
1904
1909
  # See the operation documentation for the appropriate value for this field.
1905
1910
  # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
1906
1911
  # OPTIONAL: A `GetPolicyOptions` object for specifying options to
1907
- # `GetIamPolicy`. This field is only used by Cloud IAM.
1912
+ # `GetIamPolicy`.
1908
1913
  #
1909
1914
  # @yield [response, operation] Access the result along with the RPC operation
1910
1915
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -1984,7 +1989,7 @@ module Google
1984
1989
  # @param options [::Gapic::CallOptions, ::Hash]
1985
1990
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1986
1991
  #
1987
- # @overload set_iam_policy(resource: nil, policy: nil)
1992
+ # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
1988
1993
  # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
1989
1994
  # least one keyword argument is required. To specify no parameters, or to keep all
1990
1995
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1997,6 +2002,12 @@ module Google
1997
2002
  # the policy is limited to a few 10s of KB. An empty policy is a
1998
2003
  # valid policy but certain Cloud Platform services (such as Projects)
1999
2004
  # might reject them.
2005
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2006
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
2007
+ # the fields in the mask will be modified. If no mask is provided, the
2008
+ # following default mask is used:
2009
+ #
2010
+ # `paths: "bindings, etag"`
2000
2011
  #
2001
2012
  # @yield [response, operation] Access the result along with the RPC operation
2002
2013
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -2153,6 +2164,122 @@ module Google
2153
2164
  raise ::Google::Cloud::Error.from_error(e)
2154
2165
  end
2155
2166
 
2167
+ ##
2168
+ # Lists hot tablets in a cluster, within the time range provided. Hot
2169
+ # tablets are ordered based on CPU usage.
2170
+ #
2171
+ # @overload list_hot_tablets(request, options = nil)
2172
+ # Pass arguments to `list_hot_tablets` via a request object, either of type
2173
+ # {::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest} or an equivalent Hash.
2174
+ #
2175
+ # @param request [::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest, ::Hash]
2176
+ # A request object representing the call parameters. Required. To specify no
2177
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2178
+ # @param options [::Gapic::CallOptions, ::Hash]
2179
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2180
+ #
2181
+ # @overload list_hot_tablets(parent: nil, start_time: nil, end_time: nil, page_size: nil, page_token: nil)
2182
+ # Pass arguments to `list_hot_tablets` via keyword arguments. Note that at
2183
+ # least one keyword argument is required. To specify no parameters, or to keep all
2184
+ # the default parameter values, pass an empty Hash as a request object (see above).
2185
+ #
2186
+ # @param parent [::String]
2187
+ # Required. The cluster name to list hot tablets.
2188
+ # Value is in the following form:
2189
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
2190
+ # @param start_time [::Google::Protobuf::Timestamp, ::Hash]
2191
+ # The start time to list hot tablets. The hot tablets in the response will
2192
+ # have start times between the requested start time and end time. Start time
2193
+ # defaults to Now if it is unset, and end time defaults to Now - 24 hours if
2194
+ # it is unset. The start time should be less than the end time, and the
2195
+ # maximum allowed time range between start time and end time is 48 hours.
2196
+ # Start time and end time should have values between Now and Now - 14 days.
2197
+ # @param end_time [::Google::Protobuf::Timestamp, ::Hash]
2198
+ # The end time to list hot tablets.
2199
+ # @param page_size [::Integer]
2200
+ # Maximum number of results per page.
2201
+ #
2202
+ # A page_size that is empty or zero lets the server choose the number of
2203
+ # items to return. A page_size which is strictly positive will return at most
2204
+ # that many items. A negative page_size will cause an error.
2205
+ #
2206
+ # Following the first request, subsequent paginated calls do not need a
2207
+ # page_size field. If a page_size is set in subsequent calls, it must match
2208
+ # the page_size given in the first request.
2209
+ # @param page_token [::String]
2210
+ # The value of `next_page_token` returned by a previous call.
2211
+ #
2212
+ # @yield [response, operation] Access the result along with the RPC operation
2213
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
2214
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2215
+ #
2216
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
2217
+ #
2218
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2219
+ #
2220
+ # @example Basic example
2221
+ # require "google/cloud/bigtable/admin/v2"
2222
+ #
2223
+ # # Create a client object. The client can be reused for multiple calls.
2224
+ # client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new
2225
+ #
2226
+ # # Create a request. To set request fields, pass in keyword arguments.
2227
+ # request = Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest.new
2228
+ #
2229
+ # # Call the list_hot_tablets method.
2230
+ # result = client.list_hot_tablets request
2231
+ #
2232
+ # # The returned object is of type Gapic::PagedEnumerable. You can
2233
+ # # iterate over all elements by calling #each, and the enumerable
2234
+ # # will lazily make API calls to fetch subsequent pages. Other
2235
+ # # methods are also available for managing paging directly.
2236
+ # result.each do |response|
2237
+ # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::HotTablet.
2238
+ # p response
2239
+ # end
2240
+ #
2241
+ def list_hot_tablets request, options = nil
2242
+ raise ::ArgumentError, "request must be provided" if request.nil?
2243
+
2244
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest
2245
+
2246
+ # Converts hash and nil to an options object
2247
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2248
+
2249
+ # Customize the options with defaults
2250
+ metadata = @config.rpcs.list_hot_tablets.metadata.to_h
2251
+
2252
+ # Set x-goog-api-client and x-goog-user-project headers
2253
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2254
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2255
+ gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
2256
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2257
+
2258
+ header_params = {}
2259
+ if request.parent
2260
+ header_params["parent"] = request.parent
2261
+ end
2262
+
2263
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2264
+ metadata[:"x-goog-request-params"] ||= request_params_header
2265
+
2266
+ options.apply_defaults timeout: @config.rpcs.list_hot_tablets.timeout,
2267
+ metadata: metadata,
2268
+ retry_policy: @config.rpcs.list_hot_tablets.retry_policy
2269
+
2270
+ options.apply_defaults timeout: @config.timeout,
2271
+ metadata: @config.metadata,
2272
+ retry_policy: @config.retry_policy
2273
+
2274
+ @bigtable_instance_admin_stub.call_rpc :list_hot_tablets, request, options: options do |response, operation|
2275
+ response = ::Gapic::PagedEnumerable.new @bigtable_instance_admin_stub, :list_hot_tablets, request, response, operation, options
2276
+ yield response, operation if block_given?
2277
+ return response
2278
+ end
2279
+ rescue ::GRPC::BadStatus => e
2280
+ raise ::Google::Cloud::Error.from_error(e)
2281
+ end
2282
+
2156
2283
  ##
2157
2284
  # Configuration class for the BigtableInstanceAdmin API.
2158
2285
  #
@@ -2388,6 +2515,11 @@ module Google
2388
2515
  # @return [::Gapic::Config::Method]
2389
2516
  #
2390
2517
  attr_reader :test_iam_permissions
2518
+ ##
2519
+ # RPC-specific configuration for `list_hot_tablets`
2520
+ # @return [::Gapic::Config::Method]
2521
+ #
2522
+ attr_reader :list_hot_tablets
2391
2523
 
2392
2524
  # @private
2393
2525
  def initialize parent_rpcs = nil
@@ -2431,6 +2563,8 @@ module Google
2431
2563
  @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
2432
2564
  test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
2433
2565
  @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
2566
+ list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
2567
+ @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config
2434
2568
 
2435
2569
  yield self if block_given?
2436
2570
  end
@@ -2190,7 +2190,7 @@ module Google
2190
2190
  # See the operation documentation for the appropriate value for this field.
2191
2191
  # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
2192
2192
  # OPTIONAL: A `GetPolicyOptions` object for specifying options to
2193
- # `GetIamPolicy`. This field is only used by Cloud IAM.
2193
+ # `GetIamPolicy`.
2194
2194
  #
2195
2195
  # @yield [response, operation] Access the result along with the RPC operation
2196
2196
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -2270,7 +2270,7 @@ module Google
2270
2270
  # @param options [::Gapic::CallOptions, ::Hash]
2271
2271
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2272
2272
  #
2273
- # @overload set_iam_policy(resource: nil, policy: nil)
2273
+ # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
2274
2274
  # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
2275
2275
  # least one keyword argument is required. To specify no parameters, or to keep all
2276
2276
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2283,6 +2283,12 @@ module Google
2283
2283
  # the policy is limited to a few 10s of KB. An empty policy is a
2284
2284
  # valid policy but certain Cloud Platform services (such as Projects)
2285
2285
  # might reject them.
2286
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2287
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
2288
+ # the fields in the mask will be modified. If no mask is provided, the
2289
+ # following default mask is used:
2290
+ #
2291
+ # `paths: "bindings, etag"`
2286
2292
  #
2287
2293
  # @yield [response, operation] Access the result along with the RPC operation
2288
2294
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigtable
23
23
  module Admin
24
24
  module V2
25
- VERSION = "0.8.1"
25
+ VERSION = "0.10.0"
26
26
  end
27
27
  end
28
28
  end
@@ -27,6 +27,8 @@ module Google
27
27
  ##
28
28
  # To load this package, including all its services, and instantiate a client:
29
29
  #
30
+ # @example
31
+ #
30
32
  # require "google/cloud/bigtable/admin/v2"
31
33
  # client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new
32
34
  #
@@ -399,6 +399,60 @@ module Google
399
399
  include ::Google::Protobuf::MessageExts
400
400
  extend ::Google::Protobuf::MessageExts::ClassMethods
401
401
  end
402
+
403
+ # Request message for BigtableInstanceAdmin.ListHotTablets.
404
+ # @!attribute [rw] parent
405
+ # @return [::String]
406
+ # Required. The cluster name to list hot tablets.
407
+ # Value is in the following form:
408
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
409
+ # @!attribute [rw] start_time
410
+ # @return [::Google::Protobuf::Timestamp]
411
+ # The start time to list hot tablets. The hot tablets in the response will
412
+ # have start times between the requested start time and end time. Start time
413
+ # defaults to Now if it is unset, and end time defaults to Now - 24 hours if
414
+ # it is unset. The start time should be less than the end time, and the
415
+ # maximum allowed time range between start time and end time is 48 hours.
416
+ # Start time and end time should have values between Now and Now - 14 days.
417
+ # @!attribute [rw] end_time
418
+ # @return [::Google::Protobuf::Timestamp]
419
+ # The end time to list hot tablets.
420
+ # @!attribute [rw] page_size
421
+ # @return [::Integer]
422
+ # Maximum number of results per page.
423
+ #
424
+ # A page_size that is empty or zero lets the server choose the number of
425
+ # items to return. A page_size which is strictly positive will return at most
426
+ # that many items. A negative page_size will cause an error.
427
+ #
428
+ # Following the first request, subsequent paginated calls do not need a
429
+ # page_size field. If a page_size is set in subsequent calls, it must match
430
+ # the page_size given in the first request.
431
+ # @!attribute [rw] page_token
432
+ # @return [::String]
433
+ # The value of `next_page_token` returned by a previous call.
434
+ class ListHotTabletsRequest
435
+ include ::Google::Protobuf::MessageExts
436
+ extend ::Google::Protobuf::MessageExts::ClassMethods
437
+ end
438
+
439
+ # Response message for BigtableInstanceAdmin.ListHotTablets.
440
+ # @!attribute [rw] hot_tablets
441
+ # @return [::Array<::Google::Cloud::Bigtable::Admin::V2::HotTablet>]
442
+ # List of hot tablets in the tables of the requested cluster that fall
443
+ # within the requested time range. Hot tablets are ordered by node cpu usage
444
+ # percent. If there are multiple hot tablets that correspond to the same
445
+ # tablet within a 15-minute interval, only the hot tablet with the highest
446
+ # node cpu usage will be included in the response.
447
+ # @!attribute [rw] next_page_token
448
+ # @return [::String]
449
+ # Set if not all hot tablets could be returned in a single response.
450
+ # Pass this value to `page_token` in another request to get the next
451
+ # page of results.
452
+ class ListHotTabletsResponse
453
+ include ::Google::Protobuf::MessageExts
454
+ extend ::Google::Protobuf::MessageExts::ClassMethods
455
+ end
402
456
  end
403
457
  end
404
458
  end
@@ -114,7 +114,8 @@ module Google
114
114
  # @return [::Integer]
115
115
  # The cpu utilization that the Autoscaler should be trying to achieve.
116
116
  # This number is on a scale from 0 (no utilization) to
117
- # 100 (total utilization).
117
+ # 100 (total utilization), and is limited between 10 and 80, otherwise it
118
+ # will return INVALID_ARGUMENT error.
118
119
  class AutoscalingTargets
119
120
  include ::Google::Protobuf::MessageExts
120
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -200,7 +201,6 @@ module Google
200
201
  # `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
201
202
  # 2) Only regional keys can be used and the region of the CMEK key must
202
203
  # match the region of the cluster.
203
- # 3) All clusters within an instance must use the same CMEK key.
204
204
  class EncryptionConfig
205
205
  include ::Google::Protobuf::MessageExts
206
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -292,6 +292,42 @@ module Google
292
292
  extend ::Google::Protobuf::MessageExts::ClassMethods
293
293
  end
294
294
  end
295
+
296
+ # A tablet is a defined by a start and end key and is explained in
297
+ # https://cloud.google.com/bigtable/docs/overview#architecture and
298
+ # https://cloud.google.com/bigtable/docs/performance#optimization.
299
+ # A Hot tablet is a tablet that exhibits high average cpu usage during the time
300
+ # interval from start time to end time.
301
+ # @!attribute [rw] name
302
+ # @return [::String]
303
+ # The unique name of the hot tablet. Values are of the form
304
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`.
305
+ # @!attribute [rw] table_name
306
+ # @return [::String]
307
+ # Name of the table that contains the tablet. Values are of the form
308
+ # `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
309
+ # @!attribute [r] start_time
310
+ # @return [::Google::Protobuf::Timestamp]
311
+ # Output only. The start time of the hot tablet.
312
+ # @!attribute [r] end_time
313
+ # @return [::Google::Protobuf::Timestamp]
314
+ # Output only. The end time of the hot tablet.
315
+ # @!attribute [rw] start_key
316
+ # @return [::String]
317
+ # Tablet Start Key (inclusive).
318
+ # @!attribute [rw] end_key
319
+ # @return [::String]
320
+ # Tablet End Key (inclusive).
321
+ # @!attribute [r] node_cpu_usage_percent
322
+ # @return [::Float]
323
+ # Output only. The average CPU usage spent by a node on this tablet over the start_time to
324
+ # end_time time range. The percentage is the amount of CPU used by the node
325
+ # to serve the tablet, from 0% (tablet was not interacted with) to 100% (the
326
+ # node spent all cycles serving the hot tablet).
327
+ class HotTablet
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
295
331
  end
296
332
  end
297
333
  end
@@ -31,6 +31,13 @@ module Google
31
31
  # the policy is limited to a few 10s of KB. An empty policy is a
32
32
  # valid policy but certain Cloud Platform services (such as Projects)
33
33
  # might reject them.
34
+ # @!attribute [rw] update_mask
35
+ # @return [::Google::Protobuf::FieldMask]
36
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
37
+ # the fields in the mask will be modified. If no mask is provided, the
38
+ # following default mask is used:
39
+ #
40
+ # `paths: "bindings, etag"`
34
41
  class SetIamPolicyRequest
35
42
  include ::Google::Protobuf::MessageExts
36
43
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -44,7 +51,7 @@ module Google
44
51
  # @!attribute [rw] options
45
52
  # @return [::Google::Iam::V1::GetPolicyOptions]
46
53
  # OPTIONAL: A `GetPolicyOptions` object for specifying options to
47
- # `GetIamPolicy`. This field is only used by Cloud IAM.
54
+ # `GetIamPolicy`.
48
55
  class GetIamPolicyRequest
49
56
  include ::Google::Protobuf::MessageExts
50
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -23,14 +23,24 @@ module Google
23
23
  # Encapsulates settings provided to GetIamPolicy.
24
24
  # @!attribute [rw] requested_policy_version
25
25
  # @return [::Integer]
26
- # Optional. The policy format version to be returned.
26
+ # Optional. The maximum policy version that will be used to format the
27
+ # policy.
27
28
  #
28
29
  # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
29
30
  # rejected.
30
31
  #
31
- # Requests for policies with any conditional bindings must specify version 3.
32
- # Policies without any conditional bindings may specify any valid value or
33
- # leave the field unset.
32
+ # Requests for policies with any conditional role bindings must specify
33
+ # version 3. Policies with no conditional role bindings may specify any valid
34
+ # value or leave the field unset.
35
+ #
36
+ # The policy in the response might use the policy version that you specified,
37
+ # or it might use a lower policy version. For example, if you specify version
38
+ # 3, but the policy has no conditional role bindings, the response uses
39
+ # version 1.
40
+ #
41
+ # To learn which resources support conditions in their IAM policies, see the
42
+ # [IAM
43
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
34
44
  class GetPolicyOptions
35
45
  include ::Google::Protobuf::MessageExts
36
46
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -20,19 +20,24 @@
20
20
  module Google
21
21
  module Iam
22
22
  module V1
23
- # Defines an Identity and Access Management (IAM) policy. It is used to
24
- # specify access control policies for Cloud Platform resources.
23
+ # An Identity and Access Management (IAM) policy, which specifies access
24
+ # controls for Google Cloud resources.
25
25
  #
26
26
  #
27
27
  # A `Policy` is a collection of `bindings`. A `binding` binds one or more
28
- # `members` to a single `role`. Members can be user accounts, service accounts,
29
- # Google groups, and domains (such as G Suite). A `role` is a named list of
30
- # permissions (defined by IAM or configured by users). A `binding` can
31
- # optionally specify a `condition`, which is a logic expression that further
32
- # constrains the role binding based on attributes about the request and/or
33
- # target resource.
28
+ # `members`, or principals, to a single `role`. Principals can be user
29
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
30
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
31
+ # role or a user-created custom role.
34
32
  #
35
- # **JSON Example**
33
+ # For some types of Google Cloud resources, a `binding` can also specify a
34
+ # `condition`, which is a logical expression that allows access to a resource
35
+ # only if the expression evaluates to `true`. A condition can add constraints
36
+ # based on attributes of the request, the resource, or both. To learn which
37
+ # resources support conditions in their IAM policies, see the
38
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
39
+ #
40
+ # **JSON example:**
36
41
  #
37
42
  # {
38
43
  # "bindings": [
@@ -47,18 +52,21 @@ module Google
47
52
  # },
48
53
  # {
49
54
  # "role": "roles/resourcemanager.organizationViewer",
50
- # "members": ["user:eve@example.com"],
55
+ # "members": [
56
+ # "user:eve@example.com"
57
+ # ],
51
58
  # "condition": {
52
59
  # "title": "expirable access",
53
60
  # "description": "Does not grant access after Sep 2020",
54
- # "expression": "request.time <
55
- # timestamp('2020-10-01T00:00:00.000Z')",
61
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
56
62
  # }
57
63
  # }
58
- # ]
64
+ # ],
65
+ # "etag": "BwWWja0YfJA=",
66
+ # "version": 3
59
67
  # }
60
68
  #
61
- # **YAML Example**
69
+ # **YAML example:**
62
70
  #
63
71
  # bindings:
64
72
  # - members:
@@ -74,30 +82,52 @@ module Google
74
82
  # title: expirable access
75
83
  # description: Does not grant access after Sep 2020
76
84
  # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
85
+ # etag: BwWWja0YfJA=
86
+ # version: 3
77
87
  #
78
88
  # For a description of IAM and its features, see the
79
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
89
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
80
90
  # @!attribute [rw] version
81
91
  # @return [::Integer]
82
92
  # Specifies the format of the policy.
83
93
  #
84
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
85
- # rejected.
94
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
95
+ # are rejected.
96
+ #
97
+ # Any operation that affects conditional role bindings must specify version
98
+ # `3`. This requirement applies to the following operations:
86
99
  #
87
- # Operations affecting conditional bindings must specify version 3. This can
88
- # be either setting a conditional policy, modifying a conditional binding,
89
- # or removing a binding (conditional or unconditional) from the stored
90
- # conditional policy.
91
- # Operations on non-conditional policies may specify any valid value or
92
- # leave the field unset.
100
+ # * Getting a policy that includes a conditional role binding
101
+ # * Adding a conditional role binding to a policy
102
+ # * Changing a conditional role binding in a policy
103
+ # * Removing any role binding, with or without a condition, from a policy
104
+ # that includes conditions
93
105
  #
94
- # If no etag is provided in the call to `setIamPolicy`, version compliance
95
- # checks against the stored policy is skipped.
106
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
107
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
108
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
109
+ # the conditions in the version `3` policy are lost.
110
+ #
111
+ # If a policy does not include any conditions, operations on that policy may
112
+ # specify any valid version or leave the field unset.
113
+ #
114
+ # To learn which resources support conditions in their IAM policies, see the
115
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
96
116
  # @!attribute [rw] bindings
97
117
  # @return [::Array<::Google::Iam::V1::Binding>]
98
- # Associates a list of `members` to a `role`. Optionally may specify a
99
- # `condition` that determines when binding is in effect.
100
- # `bindings` with no members will result in an error.
118
+ # Associates a list of `members`, or principals, with a `role`. Optionally,
119
+ # may specify a `condition` that determines how and when the `bindings` are
120
+ # applied. Each of the `bindings` must contain at least one principal.
121
+ #
122
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
123
+ # of these principals can be Google groups. Each occurrence of a principal
124
+ # counts towards these limits. For example, if the `bindings` grant 50
125
+ # different roles to `user:alice@example.com`, and not to any other
126
+ # principal, then you can add another 1,450 principals to the `bindings` in
127
+ # the `Policy`.
128
+ # @!attribute [rw] audit_configs
129
+ # @return [::Array<::Google::Iam::V1::AuditConfig>]
130
+ # Specifies cloud audit logging configuration for this policy.
101
131
  # @!attribute [rw] etag
102
132
  # @return [::String]
103
133
  # `etag` is used for optimistic concurrency control as a way to help
@@ -108,23 +138,23 @@ module Google
108
138
  # systems are expected to put that etag in the request to `setIamPolicy` to
109
139
  # ensure that their change will be applied to the same version of the policy.
110
140
  #
111
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
112
- # policy is overwritten. Due to blind-set semantics of an etag-less policy,
113
- # 'setIamPolicy' will not fail even if the incoming policy version does not
114
- # meet the requirements for modifying the stored policy.
141
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
142
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
143
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
144
+ # the conditions in the version `3` policy are lost.
115
145
  class Policy
116
146
  include ::Google::Protobuf::MessageExts
117
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
118
148
  end
119
149
 
120
- # Associates `members` with a `role`.
150
+ # Associates `members`, or principals, with a `role`.
121
151
  # @!attribute [rw] role
122
152
  # @return [::String]
123
- # Role that is assigned to `members`.
153
+ # Role that is assigned to the list of `members`, or principals.
124
154
  # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
125
155
  # @!attribute [rw] members
126
156
  # @return [::Array<::String>]
127
- # Specifies the identities requesting access for a Cloud Platform resource.
157
+ # Specifies the principals requesting access for a Cloud Platform resource.
128
158
  # `members` can have the following values:
129
159
  #
130
160
  # * `allUsers`: A special identifier that represents anyone who is
@@ -143,20 +173,160 @@ module Google
143
173
  # * `group:{emailid}`: An email address that represents a Google group.
144
174
  # For example, `admins@example.com`.
145
175
  #
176
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
177
+ # identifier) representing a user that has been recently deleted. For
178
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
179
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
180
+ # retains the role in the binding.
181
+ #
182
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
183
+ # unique identifier) representing a service account that has been recently
184
+ # deleted. For example,
185
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
186
+ # If the service account is undeleted, this value reverts to
187
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
188
+ # role in the binding.
189
+ #
190
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
191
+ # identifier) representing a Google group that has been recently
192
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
193
+ # the group is recovered, this value reverts to `group:{emailid}` and the
194
+ # recovered group retains the role in the binding.
195
+ #
146
196
  #
147
197
  # * `domain:{domain}`: The G Suite domain (primary) that represents all the
148
198
  # users of that domain. For example, `google.com` or `example.com`.
149
199
  # @!attribute [rw] condition
150
200
  # @return [::Google::Type::Expr]
151
201
  # The condition that is associated with this binding.
152
- # NOTE: An unsatisfied condition will not allow user access via current
153
- # binding. Different bindings, including their conditions, are examined
154
- # independently.
202
+ #
203
+ # If the condition evaluates to `true`, then this binding applies to the
204
+ # current request.
205
+ #
206
+ # If the condition evaluates to `false`, then this binding does not apply to
207
+ # the current request. However, a different role binding might grant the same
208
+ # role to one or more of the principals in this binding.
209
+ #
210
+ # To learn which resources support conditions in their IAM policies, see the
211
+ # [IAM
212
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
155
213
  class Binding
156
214
  include ::Google::Protobuf::MessageExts
157
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
158
216
  end
159
217
 
218
+ # Specifies the audit configuration for a service.
219
+ # The configuration determines which permission types are logged, and what
220
+ # identities, if any, are exempted from logging.
221
+ # An AuditConfig must have one or more AuditLogConfigs.
222
+ #
223
+ # If there are AuditConfigs for both `allServices` and a specific service,
224
+ # the union of the two AuditConfigs is used for that service: the log_types
225
+ # specified in each AuditConfig are enabled, and the exempted_members in each
226
+ # AuditLogConfig are exempted.
227
+ #
228
+ # Example Policy with multiple AuditConfigs:
229
+ #
230
+ # {
231
+ # "audit_configs": [
232
+ # {
233
+ # "service": "allServices",
234
+ # "audit_log_configs": [
235
+ # {
236
+ # "log_type": "DATA_READ",
237
+ # "exempted_members": [
238
+ # "user:jose@example.com"
239
+ # ]
240
+ # },
241
+ # {
242
+ # "log_type": "DATA_WRITE"
243
+ # },
244
+ # {
245
+ # "log_type": "ADMIN_READ"
246
+ # }
247
+ # ]
248
+ # },
249
+ # {
250
+ # "service": "sampleservice.googleapis.com",
251
+ # "audit_log_configs": [
252
+ # {
253
+ # "log_type": "DATA_READ"
254
+ # },
255
+ # {
256
+ # "log_type": "DATA_WRITE",
257
+ # "exempted_members": [
258
+ # "user:aliya@example.com"
259
+ # ]
260
+ # }
261
+ # ]
262
+ # }
263
+ # ]
264
+ # }
265
+ #
266
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
267
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
268
+ # aliya@example.com from DATA_WRITE logging.
269
+ # @!attribute [rw] service
270
+ # @return [::String]
271
+ # Specifies a service that will be enabled for audit logging.
272
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
273
+ # `allServices` is a special value that covers all services.
274
+ # @!attribute [rw] audit_log_configs
275
+ # @return [::Array<::Google::Iam::V1::AuditLogConfig>]
276
+ # The configuration for logging of each type of permission.
277
+ class AuditConfig
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Provides the configuration for logging a type of permissions.
283
+ # Example:
284
+ #
285
+ # {
286
+ # "audit_log_configs": [
287
+ # {
288
+ # "log_type": "DATA_READ",
289
+ # "exempted_members": [
290
+ # "user:jose@example.com"
291
+ # ]
292
+ # },
293
+ # {
294
+ # "log_type": "DATA_WRITE"
295
+ # }
296
+ # ]
297
+ # }
298
+ #
299
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
300
+ # jose@example.com from DATA_READ logging.
301
+ # @!attribute [rw] log_type
302
+ # @return [::Google::Iam::V1::AuditLogConfig::LogType]
303
+ # The log type that this config enables.
304
+ # @!attribute [rw] exempted_members
305
+ # @return [::Array<::String>]
306
+ # Specifies the identities that do not cause logging for this type of
307
+ # permission.
308
+ # Follows the same format of {::Google::Iam::V1::Binding#members Binding.members}.
309
+ class AuditLogConfig
310
+ include ::Google::Protobuf::MessageExts
311
+ extend ::Google::Protobuf::MessageExts::ClassMethods
312
+
313
+ # The list of valid permission types for which logging can be configured.
314
+ # Admin writes are always logged, and are not configurable.
315
+ module LogType
316
+ # Default case. Should never be this.
317
+ LOG_TYPE_UNSPECIFIED = 0
318
+
319
+ # Admin reads. Example: CloudIAM getIamPolicy
320
+ ADMIN_READ = 1
321
+
322
+ # Data writes. Example: CloudSQL Users create
323
+ DATA_WRITE = 2
324
+
325
+ # Data reads. Example: CloudSQL Users list
326
+ DATA_READ = 3
327
+ end
328
+ end
329
+
160
330
  # The difference delta between two policies.
161
331
  # @!attribute [rw] binding_deltas
162
332
  # @return [::Array<::Google::Iam::V1::BindingDelta>]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigtable-admin-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.1
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-11 00:00:00.000000000 Z
11
+ date: 2022-04-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -48,22 +48,16 @@ dependencies:
48
48
  name: grpc-google-iam-v1
49
49
  requirement: !ruby/object:Gem::Requirement
50
50
  requirements:
51
- - - ">="
52
- - !ruby/object:Gem::Version
53
- version: 0.6.10
54
- - - "<"
51
+ - - "~>"
55
52
  - !ruby/object:Gem::Version
56
- version: 2.a
53
+ version: '1.1'
57
54
  type: :runtime
58
55
  prerelease: false
59
56
  version_requirements: !ruby/object:Gem::Requirement
60
57
  requirements:
61
- - - ">="
62
- - !ruby/object:Gem::Version
63
- version: 0.6.10
64
- - - "<"
58
+ - - "~>"
65
59
  - !ruby/object:Gem::Version
66
- version: 2.a
60
+ version: '1.1'
67
61
  - !ruby/object:Gem::Dependency
68
62
  name: google-style
69
63
  requirement: !ruby/object:Gem::Requirement
@@ -247,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
247
241
  - !ruby/object:Gem::Version
248
242
  version: '0'
249
243
  requirements: []
250
- rubygems_version: 3.3.4
244
+ rubygems_version: 3.3.5
251
245
  signing_key:
252
246
  specification_version: 4
253
247
  summary: API Client library for the Cloud Bigtable Admin V2 API