google-cloud-bigtable-v2 1.12.0 → 1.14.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.
@@ -31,6 +31,8 @@ module Google
31
31
  # @!attribute [rw] selective_gapic_generation
32
32
  # @return [::Google::Api::SelectiveGapicGeneration]
33
33
  # Configuration for which RPCs should be generated in the GAPIC client.
34
+ #
35
+ # Note: This field should not be used in most cases.
34
36
  class CommonLanguageSettings
35
37
  include ::Google::Protobuf::MessageExts
36
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ module Google
141
143
  #
142
144
  # Example of a YAML configuration::
143
145
  #
144
- # publishing:
145
- # java_settings:
146
- # library_package: com.google.cloud.pubsub.v1
146
+ # publishing:
147
+ # library_settings:
148
+ # java_settings:
149
+ # library_package: com.google.cloud.pubsub.v1
147
150
  # @!attribute [rw] service_class_names
148
151
  # @return [::Google::Protobuf::Map{::String => ::String}]
149
152
  # Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ module Google
155
158
  #
156
159
  # Example of a YAML configuration::
157
160
  #
158
- # publishing:
159
- # java_settings:
160
- # service_class_names:
161
- # - google.pubsub.v1.Publisher: TopicAdmin
162
- # - google.pubsub.v1.Subscriber: SubscriptionAdmin
161
+ # publishing:
162
+ # java_settings:
163
+ # service_class_names:
164
+ # - google.pubsub.v1.Publisher: TopicAdmin
165
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
163
166
  # @!attribute [rw] common
164
167
  # @return [::Google::Api::CommonLanguageSettings]
165
168
  # Some settings.
@@ -190,6 +193,20 @@ module Google
190
193
  # @!attribute [rw] common
191
194
  # @return [::Google::Api::CommonLanguageSettings]
192
195
  # Some settings.
196
+ # @!attribute [rw] library_package
197
+ # @return [::String]
198
+ # The package name to use in Php. Clobbers the php_namespace option
199
+ # set in the protobuf. This should be used **only** by APIs
200
+ # who have already set the language_settings.php.package_name" field
201
+ # in gapic.yaml. API teams should use the protobuf php_namespace option
202
+ # where possible.
203
+ #
204
+ # Example of a YAML configuration::
205
+ #
206
+ # publishing:
207
+ # library_settings:
208
+ # php_settings:
209
+ # library_package: Google\Cloud\PubSub\V1
193
210
  class PhpSettings
194
211
  include ::Google::Protobuf::MessageExts
195
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ module Google
318
335
  # service names and values are the name to be used for the service client
319
336
  # and call options.
320
337
  #
321
- # publishing:
322
- # go_settings:
323
- # renamed_services:
324
- # Publisher: TopicAdmin
338
+ # Example:
339
+ #
340
+ # publishing:
341
+ # go_settings:
342
+ # renamed_services:
343
+ # Publisher: TopicAdmin
325
344
  class GoSettings
326
345
  include ::Google::Protobuf::MessageExts
327
346
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ module Google
344
363
  #
345
364
  # Example:
346
365
  #
347
- # publishing:
348
- # method_settings:
349
- # - selector: google.storage.control.v2.StorageControl.CreateFolder
350
- # # method settings for CreateFolder...
366
+ # publishing:
367
+ # method_settings:
368
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
369
+ # # method settings for CreateFolder...
351
370
  # @!attribute [rw] long_running
352
371
  # @return [::Google::Api::MethodSettings::LongRunning]
353
372
  # Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ module Google
356
375
  #
357
376
  # Example of a YAML configuration::
358
377
  #
359
- # publishing:
360
- # method_settings:
361
- # - selector: google.cloud.speech.v2.Speech.BatchRecognize
362
- # long_running:
363
- # initial_poll_delay: 60s # 1 minute
364
- # poll_delay_multiplier: 1.5
365
- # max_poll_delay: 360s # 6 minutes
366
- # total_poll_timeout: 54000s # 90 minutes
378
+ # publishing:
379
+ # method_settings:
380
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
381
+ # long_running:
382
+ # initial_poll_delay: 60s # 1 minute
383
+ # poll_delay_multiplier: 1.5
384
+ # max_poll_delay: 360s # 6 minutes
385
+ # total_poll_timeout: 54000s # 90 minutes
367
386
  # @!attribute [rw] auto_populated_fields
368
387
  # @return [::Array<::String>]
369
388
  # List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ module Google
372
391
  #
373
392
  # Example of a YAML configuration:
374
393
  #
375
- # publishing:
376
- # method_settings:
377
- # - selector: google.example.v1.ExampleService.CreateExample
378
- # auto_populated_fields:
379
- # - request_id
394
+ # publishing:
395
+ # method_settings:
396
+ # - selector: google.example.v1.ExampleService.CreateExample
397
+ # auto_populated_fields:
398
+ # - request_id
399
+ # @!attribute [rw] batching
400
+ # @return [::Google::Api::BatchingConfigProto]
401
+ # Batching configuration for an API method in client libraries.
402
+ #
403
+ # Example of a YAML configuration:
404
+ #
405
+ # publishing:
406
+ # method_settings:
407
+ # - selector: google.example.v1.ExampleService.BatchCreateExample
408
+ # batching:
409
+ # element_count_threshold: 1000
410
+ # request_byte_threshold: 100000000
411
+ # delay_threshold_millis: 10
380
412
  class MethodSettings
381
413
  include ::Google::Protobuf::MessageExts
382
414
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ module Google
411
443
 
412
444
  # This message is used to configure the generation of a subset of the RPCs in
413
445
  # a service for client libraries.
446
+ #
447
+ # Note: This feature should not be used in most cases.
414
448
  # @!attribute [rw] methods
415
449
  # @return [::Array<::String>]
416
450
  # An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ module Google
428
462
  extend ::Google::Protobuf::MessageExts::ClassMethods
429
463
  end
430
464
 
465
+ # `BatchingConfigProto` defines the batching configuration for an API method.
466
+ # @!attribute [rw] thresholds
467
+ # @return [::Google::Api::BatchingSettingsProto]
468
+ # The thresholds which trigger a batched request to be sent.
469
+ # @!attribute [rw] batch_descriptor
470
+ # @return [::Google::Api::BatchingDescriptorProto]
471
+ # The request and response fields used in batching.
472
+ class BatchingConfigProto
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # `BatchingSettingsProto` specifies a set of batching thresholds, each of
478
+ # which acts as a trigger to send a batch of messages as a request. At least
479
+ # one threshold must be positive nonzero.
480
+ # @!attribute [rw] element_count_threshold
481
+ # @return [::Integer]
482
+ # The number of elements of a field collected into a batch which, if
483
+ # exceeded, causes the batch to be sent.
484
+ # @!attribute [rw] request_byte_threshold
485
+ # @return [::Integer]
486
+ # The aggregated size of the batched field which, if exceeded, causes the
487
+ # batch to be sent. This size is computed by aggregating the sizes of the
488
+ # request field to be batched, not of the entire request message.
489
+ # @!attribute [rw] delay_threshold
490
+ # @return [::Google::Protobuf::Duration]
491
+ # The duration after which a batch should be sent, starting from the addition
492
+ # of the first message to that batch.
493
+ # @!attribute [rw] element_count_limit
494
+ # @return [::Integer]
495
+ # The maximum number of elements collected in a batch that could be accepted
496
+ # by server.
497
+ # @!attribute [rw] request_byte_limit
498
+ # @return [::Integer]
499
+ # The maximum size of the request that could be accepted by server.
500
+ # @!attribute [rw] flow_control_element_limit
501
+ # @return [::Integer]
502
+ # The maximum number of elements allowed by flow control.
503
+ # @!attribute [rw] flow_control_byte_limit
504
+ # @return [::Integer]
505
+ # The maximum size of data allowed by flow control.
506
+ # @!attribute [rw] flow_control_limit_exceeded_behavior
507
+ # @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
508
+ # The behavior to take when the flow control limit is exceeded.
509
+ class BatchingSettingsProto
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
514
+ # `BatchingDescriptorProto` specifies the fields of the request message to be
515
+ # used for batching, and, optionally, the fields of the response message to be
516
+ # used for demultiplexing.
517
+ # @!attribute [rw] batched_field
518
+ # @return [::String]
519
+ # The repeated field in the request message to be aggregated by batching.
520
+ # @!attribute [rw] discriminator_fields
521
+ # @return [::Array<::String>]
522
+ # A list of the fields in the request message. Two requests will be batched
523
+ # together only if the values of every field specified in
524
+ # `request_discriminator_fields` is equal between the two requests.
525
+ # @!attribute [rw] subresponse_field
526
+ # @return [::String]
527
+ # Optional. When present, indicates the field in the response message to be
528
+ # used to demultiplex the response into multiple response messages, in
529
+ # correspondence with the multiple request messages originally batched
530
+ # together.
531
+ class BatchingDescriptorProto
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
431
536
  # The organization for which the client libraries are being published.
432
537
  # Affects the url where generated docs are published, etc.
433
538
  module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module Google
469
574
  # Publish the library to package managers like nuget.org and npmjs.com.
470
575
  PACKAGE_MANAGER = 20
471
576
  end
577
+
578
+ # The behavior to take when the flow control limit is exceeded.
579
+ module FlowControlLimitExceededBehaviorProto
580
+ # Default behavior, system-defined.
581
+ UNSET_BEHAVIOR = 0
582
+
583
+ # Stop operation, raise error.
584
+ THROW_EXCEPTION = 1
585
+
586
+ # Pause operation until limit clears.
587
+ BLOCK = 2
588
+
589
+ # Continue operation, disregard limit.
590
+ IGNORE = 3
591
+ end
472
592
  end
473
593
  end
@@ -49,9 +49,13 @@ module Google
49
49
  # app_profile_id: profiles/prof_qux
50
50
  # }
51
51
  #
52
- # The routing header consists of one or multiple key-value pairs. Every key
53
- # and value must be percent-encoded, and joined together in the format of
54
- # `key1=value1&key2=value2`.
52
+ # The routing header consists of one or multiple key-value pairs. The order of
53
+ # the key-value pairs is undefined, the order of the `routing_parameters` in
54
+ # the `RoutingRule` only matters for the evaluation order of the path
55
+ # templates when `field` is the same. See the examples below for more details.
56
+ #
57
+ # Every key and value in the routing header must be percent-encoded,
58
+ # and joined together in the following format: `key1=value1&key2=value2`.
55
59
  # The examples below skip the percent-encoding for readability.
56
60
  #
57
61
  # Example 1
@@ -211,6 +211,12 @@ module Google
211
211
  # @return [::String]
212
212
  # This value specifies routing for replication. If not specified, the
213
213
  # "default" application profile will be used.
214
+ # @!attribute [rw] row_range
215
+ # @return [::Google::Cloud::Bigtable::V2::RowRange]
216
+ # Optional. The row range to sample. If not specified, samples
217
+ # from all rows.
218
+ # The output will always return the end key in the range as the last sample
219
+ # returned.
214
220
  class SampleRowKeysRequest
215
221
  include ::Google::Protobuf::MessageExts
216
222
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -219,17 +225,21 @@ module Google
219
225
  # Response message for Bigtable.SampleRowKeys.
220
226
  # @!attribute [rw] row_key
221
227
  # @return [::String]
222
- # Sorted streamed sequence of sample row keys in the table. The table might
223
- # have contents before the first row key in the list and after the last one,
224
- # but a key containing the empty string indicates "end of table" and will be
225
- # the last response given, if present.
228
+ # Sorted streamed sequence of sample row keys in the table, restricted to
229
+ # the row_range if specified in the request. The table might have contents
230
+ # before the first row key in the list and after the last one, but a key
231
+ # containing the empty string indicates "end of table" and will be the last
232
+ # response given, if present and within the row-range specified in the
233
+ # request.
226
234
  # Note that row keys in this list may not have ever been written to or read
227
235
  # from, and users should therefore not make any assumptions about the row key
228
236
  # structure that are specific to their use case.
229
237
  # @!attribute [rw] offset_bytes
230
238
  # @return [::Integer]
231
239
  # Approximate total storage space used by all rows in the table which precede
232
- # `row_key`. Buffering the contents of all rows between two subsequent
240
+ # `row_key` (and if a row-range is specified in the request, which follow
241
+ # what would have been the previous sample before the row-range start).
242
+ # Buffering the contents of all rows between two subsequent
233
243
  # samples would require space roughly equal to the difference in their
234
244
  # `offset_bytes` fields.
235
245
  class SampleRowKeysResponse
@@ -837,6 +847,14 @@ module Google
837
847
  # inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
838
848
  # `Value.type` must match the corresponding `param_types` entry, or be
839
849
  # rejected with `INVALID_ARGUMENT`.
850
+ # @!attribute [rw] view_parameters
851
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}]
852
+ # Optional. This map provides the runtime values returned by the
853
+ # VIEW_PARAMETERS() function calls, typically used for user-level scoping of
854
+ # data based on identity.
855
+ #
856
+ # The key is the name of the view parameter e.g. `user_id`, and
857
+ # the value is the parameter value e.g. `alice@example.com`.
840
858
  class ExecuteQueryRequest
841
859
  include ::Google::Protobuf::MessageExts
842
860
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -849,6 +867,15 @@ module Google
849
867
  include ::Google::Protobuf::MessageExts
850
868
  extend ::Google::Protobuf::MessageExts::ClassMethods
851
869
  end
870
+
871
+ # @!attribute [rw] key
872
+ # @return [::String]
873
+ # @!attribute [rw] value
874
+ # @return [::Google::Cloud::Bigtable::V2::Value]
875
+ class ViewParametersEntry
876
+ include ::Google::Protobuf::MessageExts
877
+ extend ::Google::Protobuf::MessageExts::ClassMethods
878
+ end
852
879
  end
853
880
 
854
881
  # Response message for Bigtable.ExecuteQuery
@@ -292,6 +292,18 @@ module Google
292
292
  extend ::Google::Protobuf::MessageExts::ClassMethods
293
293
  end
294
294
 
295
+ # Restricts the output to cells whose values match the given bitmask.
296
+ # @!attribute [rw] mask
297
+ # @return [::String]
298
+ # Required. Mask applied to the value.
299
+ # Evaluated as: `(value & mask) == mask`
300
+ # The mask length must exactly match the value length, otherwise the cell is
301
+ # not considered a match.
302
+ class ValueBitmask
303
+ include ::Google::Protobuf::MessageExts
304
+ extend ::Google::Protobuf::MessageExts::ClassMethods
305
+ end
306
+
295
307
  # Takes a row as input and produces an alternate view of the row based on
296
308
  # specified rules. For example, a RowFilter might trim down a row to include
297
309
  # just the cells from columns matching a given regular expression, or might
@@ -330,19 +342,19 @@ module Google
330
342
  # Applies several RowFilters to the data in sequence, progressively
331
343
  # narrowing the results.
332
344
  #
333
- # Note: The following fields are mutually exclusive: `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
345
+ # Note: The following fields are mutually exclusive: `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
334
346
  # @!attribute [rw] interleave
335
347
  # @return [::Google::Cloud::Bigtable::V2::RowFilter::Interleave]
336
348
  # Applies several RowFilters to the data in parallel and combines the
337
349
  # results.
338
350
  #
339
- # Note: The following fields are mutually exclusive: `interleave`, `chain`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
351
+ # Note: The following fields are mutually exclusive: `interleave`, `chain`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
340
352
  # @!attribute [rw] condition
341
353
  # @return [::Google::Cloud::Bigtable::V2::RowFilter::Condition]
342
354
  # Applies one of two possible RowFilters to the data based on the output of
343
355
  # a predicate RowFilter.
344
356
  #
345
- # Note: The following fields are mutually exclusive: `condition`, `chain`, `interleave`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
357
+ # Note: The following fields are mutually exclusive: `condition`, `chain`, `interleave`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
346
358
  # @!attribute [rw] sink
347
359
  # @return [::Boolean]
348
360
  # ADVANCED USE ONLY.
@@ -405,19 +417,19 @@ module Google
405
417
  # Cannot be used within the `predicate_filter`, `true_filter`, or
406
418
  # `false_filter` of a {::Google::Cloud::Bigtable::V2::RowFilter::Condition Condition}.
407
419
  #
408
- # Note: The following fields are mutually exclusive: `sink`, `chain`, `interleave`, `condition`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
420
+ # Note: The following fields are mutually exclusive: `sink`, `chain`, `interleave`, `condition`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
409
421
  # @!attribute [rw] pass_all_filter
410
422
  # @return [::Boolean]
411
423
  # Matches all cells, regardless of input. Functionally equivalent to
412
424
  # leaving `filter` unset, but included for completeness.
413
425
  #
414
- # Note: The following fields are mutually exclusive: `pass_all_filter`, `chain`, `interleave`, `condition`, `sink`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
426
+ # Note: The following fields are mutually exclusive: `pass_all_filter`, `chain`, `interleave`, `condition`, `sink`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
415
427
  # @!attribute [rw] block_all_filter
416
428
  # @return [::Boolean]
417
429
  # Does not match any cells, regardless of input. Useful for temporarily
418
430
  # disabling just part of a filter.
419
431
  #
420
- # Note: The following fields are mutually exclusive: `block_all_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
432
+ # Note: The following fields are mutually exclusive: `block_all_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
421
433
  # @!attribute [rw] row_key_regex_filter
422
434
  # @return [::String]
423
435
  # Matches only cells from rows whose keys satisfy the given RE2 regex. In
@@ -428,13 +440,13 @@ module Google
428
440
  # will not match the new line character `\n`, which may be present in a
429
441
  # binary key.
430
442
  #
431
- # Note: The following fields are mutually exclusive: `row_key_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
443
+ # Note: The following fields are mutually exclusive: `row_key_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
432
444
  # @!attribute [rw] row_sample_filter
433
445
  # @return [::Float]
434
446
  # Matches all cells from a row with probability p, and matches no cells
435
447
  # from the row with probability 1-p.
436
448
  #
437
- # Note: The following fields are mutually exclusive: `row_sample_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
449
+ # Note: The following fields are mutually exclusive: `row_sample_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
438
450
  # @!attribute [rw] family_name_regex_filter
439
451
  # @return [::String]
440
452
  # Matches only cells from columns whose families satisfy the given RE2
@@ -444,7 +456,7 @@ module Google
444
456
  # `\n`, it is sufficient to use `.` as a full wildcard when matching
445
457
  # column family names.
446
458
  #
447
- # Note: The following fields are mutually exclusive: `family_name_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
459
+ # Note: The following fields are mutually exclusive: `family_name_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
448
460
  # @!attribute [rw] column_qualifier_regex_filter
449
461
  # @return [::String]
450
462
  # Matches only cells from columns whose qualifiers satisfy the given RE2
@@ -454,17 +466,17 @@ module Google
454
466
  # character will not match the new line character `\n`, which may be
455
467
  # present in a binary qualifier.
456
468
  #
457
- # Note: The following fields are mutually exclusive: `column_qualifier_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
469
+ # Note: The following fields are mutually exclusive: `column_qualifier_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
458
470
  # @!attribute [rw] column_range_filter
459
471
  # @return [::Google::Cloud::Bigtable::V2::ColumnRange]
460
472
  # Matches only cells from columns within the given range.
461
473
  #
462
- # Note: The following fields are mutually exclusive: `column_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
474
+ # Note: The following fields are mutually exclusive: `column_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
463
475
  # @!attribute [rw] timestamp_range_filter
464
476
  # @return [::Google::Cloud::Bigtable::V2::TimestampRange]
465
477
  # Matches only cells with timestamps within the given range.
466
478
  #
467
- # Note: The following fields are mutually exclusive: `timestamp_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
479
+ # Note: The following fields are mutually exclusive: `timestamp_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
468
480
  # @!attribute [rw] value_regex_filter
469
481
  # @return [::String]
470
482
  # Matches only cells with values that satisfy the given regular expression.
@@ -473,26 +485,26 @@ module Google
473
485
  # will not match the new line character `\n`, which may be present in a
474
486
  # binary value.
475
487
  #
476
- # Note: The following fields are mutually exclusive: `value_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
488
+ # Note: The following fields are mutually exclusive: `value_regex_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
477
489
  # @!attribute [rw] value_range_filter
478
490
  # @return [::Google::Cloud::Bigtable::V2::ValueRange]
479
491
  # Matches only cells with values that fall within the given range.
480
492
  #
481
- # Note: The following fields are mutually exclusive: `value_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
493
+ # Note: The following fields are mutually exclusive: `value_range_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
482
494
  # @!attribute [rw] cells_per_row_offset_filter
483
495
  # @return [::Integer]
484
496
  # Skips the first N cells of each row, matching all subsequent cells.
485
497
  # If duplicate cells are present, as is possible when using an Interleave,
486
498
  # each copy of the cell is counted separately.
487
499
  #
488
- # Note: The following fields are mutually exclusive: `cells_per_row_offset_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
500
+ # Note: The following fields are mutually exclusive: `cells_per_row_offset_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
489
501
  # @!attribute [rw] cells_per_row_limit_filter
490
502
  # @return [::Integer]
491
503
  # Matches only the first N cells of each row.
492
504
  # If duplicate cells are present, as is possible when using an Interleave,
493
505
  # each copy of the cell is counted separately.
494
506
  #
495
- # Note: The following fields are mutually exclusive: `cells_per_row_limit_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
507
+ # Note: The following fields are mutually exclusive: `cells_per_row_limit_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
496
508
  # @!attribute [rw] cells_per_column_limit_filter
497
509
  # @return [::Integer]
498
510
  # Matches only the most recent N cells within each column. For example,
@@ -502,12 +514,12 @@ module Google
502
514
  # If duplicate cells are present, as is possible when using an Interleave,
503
515
  # each copy of the cell is counted separately.
504
516
  #
505
- # Note: The following fields are mutually exclusive: `cells_per_column_limit_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
517
+ # Note: The following fields are mutually exclusive: `cells_per_column_limit_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `strip_value_transformer`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
506
518
  # @!attribute [rw] strip_value_transformer
507
519
  # @return [::Boolean]
508
520
  # Replaces each cell's value with the empty string.
509
521
  #
510
- # Note: The following fields are mutually exclusive: `strip_value_transformer`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
522
+ # Note: The following fields are mutually exclusive: `strip_value_transformer`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `apply_label_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
511
523
  # @!attribute [rw] apply_label_transformer
512
524
  # @return [::String]
513
525
  # Applies the given label to all cells in the output row. This allows
@@ -524,7 +536,15 @@ module Google
524
536
  # will be applied to separate copies of the input. This may be relaxed in
525
537
  # the future.
526
538
  #
527
- # Note: The following fields are mutually exclusive: `apply_label_transformer`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
539
+ # Note: The following fields are mutually exclusive: `apply_label_transformer`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `value_bitmask_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
540
+ # @!attribute [rw] value_bitmask_filter
541
+ # @return [::Google::Cloud::Bigtable::V2::ValueBitmask]
542
+ # Matches only cells with values that satisfy the condition `(value & mask)
543
+ # == mask`.
544
+ # The mask length must exactly match the value length, otherwise the cell
545
+ # is not considered a match.
546
+ #
547
+ # Note: The following fields are mutually exclusive: `value_bitmask_filter`, `chain`, `interleave`, `condition`, `sink`, `pass_all_filter`, `block_all_filter`, `row_key_regex_filter`, `row_sample_filter`, `family_name_regex_filter`, `column_qualifier_regex_filter`, `column_range_filter`, `timestamp_range_filter`, `value_regex_filter`, `value_range_filter`, `cells_per_row_offset_filter`, `cells_per_row_limit_filter`, `cells_per_column_limit_filter`, `strip_value_transformer`, `apply_label_transformer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
528
548
  class RowFilter
529
549
  include ::Google::Protobuf::MessageExts
530
550
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -67,6 +67,12 @@ module Google
67
67
  # @!attribute [rw] peer_info
68
68
  # @return [::Boolean]
69
69
  # If the client can support using BigtablePeerInfo.
70
+ # @!attribute [rw] sessions_compatible
71
+ # @return [::Boolean]
72
+ # Indicates whether the client supports the Bigtable Sessions API.
73
+ # @!attribute [rw] sessions_required
74
+ # @return [::Boolean]
75
+ # Internal flag to force sessions for internal projects.
70
76
  class FeatureFlags
71
77
  include ::Google::Protobuf::MessageExts
72
78
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -31,13 +31,18 @@ module Google
31
31
  # @return [::Integer]
32
32
  # An opaque identifier for the application frontend which serviced this
33
33
  # request.
34
+ # @!attribute [rw] application_frontend_region
35
+ # @return [::String]
36
+ # The Cloud region of the application frontend that served this request.
34
37
  # @!attribute [rw] application_frontend_zone
38
+ # @deprecated This field is deprecated and may be removed in the next major version update.
35
39
  # @return [::String]
36
40
  # The Cloud zone of the application frontend that served this request.
37
41
  # @!attribute [rw] application_frontend_subzone
38
42
  # @return [::String]
39
43
  # The subzone of the application frontend that served this request, e.g. an
40
- # identifier for where within the zone the application frontend is.
44
+ # identifier for where within a zone (within the reported region) the
45
+ # application frontend is.
41
46
  # @!attribute [rw] transport_type
42
47
  # @return [::Google::Cloud::Bigtable::V2::PeerInfo::TransportType]
43
48
  class PeerInfo