google-cloud-bigtable-v2 1.3.0 → 1.5.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: c852dc1de947fb99936ea7d02fa91037fb4edb48b435d34d9f71f0cb4f7c92ad
4
- data.tar.gz: 28f31be47dba167271381efbec59b19a5356f9853cfd90a43127d295516cb8b4
3
+ metadata.gz: 82ca7e315fac1add7d5d0a0aaacafab97bcf1944abcba08b265bb88306bb14b6
4
+ data.tar.gz: 968acde60248c2e471f9f59168ebdf5ee186431419ec91e15a951dcbba412b03
5
5
  SHA512:
6
- metadata.gz: 4f04d05ef4e5b76ee01d9adb2f47fb8c894b840783352681a2ed358482be23fafa2e3a501900de3ec02ac4b9db266d161462ed6c5ad922cb5e6ef6cf4b791050
7
- data.tar.gz: cfdeb131e62f1d265ac8dd87fb9776cc37954e12b5fb2dea2eab993cd495d9bef9ec27f66a7bacb0218b1776fe05102def0b61cd1cfaf0d09ca18d0d920ff342
6
+ metadata.gz: 2b5b73834e222c229f21e2f8d6428a55e891dfb7c7ce5f83cb7065c0a5a0f2a44aec3f868369c65547eda5d0db9cd77ad173cc8f85ac34809692966e21839d02
7
+ data.tar.gz: efd4a79018e4f1af3e70b465db9785f977bc0d5ed7ee84e86b87787aba29fe1164b7e8be27ec42262602e87a5c85ad397d81ceb71323270b8415bf1b4ea004fb
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/bigtable)
44
44
  for general usage information.
45
45
 
46
- ## Enabling Logging
47
-
48
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
-
54
- Configuring a Ruby stdlib logger:
46
+ ## Debug Logging
47
+
48
+ This library comes with opt-in Debug Logging that can help you troubleshoot
49
+ your application's integration with the API. When logging is activated, key
50
+ events such as requests and responses, along with data payloads and metadata
51
+ such as headers and client configuration, are logged to the standard error
52
+ stream.
53
+
54
+ **WARNING:** Client Library Debug Logging includes your data payloads in
55
+ plaintext, which could include sensitive data such as PII for yourself or your
56
+ customers, private keys, or other security data that could be compromising if
57
+ leaked. Always practice good data hygiene with your application logs, and follow
58
+ the principle of least access. Google also recommends that Client Library Debug
59
+ Logging be enabled only temporarily during active debugging, and not used
60
+ permanently in production.
61
+
62
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
63
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
64
+ list of client library gem names. This will select the default logging behavior,
65
+ which writes logs to the standard error stream. On a local workstation, this may
66
+ result in logs appearing on the console. When running on a Google Cloud hosting
67
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
68
+ results in logs appearing alongside your application logs in the
69
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
70
+
71
+ You can customize logging by modifying the `logger` configuration when
72
+ constructing a client object. For example:
55
73
 
56
74
  ```ruby
75
+ require "google/cloud/bigtable/v2"
57
76
  require "logger"
58
77
 
59
- module MyLogger
60
- LOGGER = Logger.new $stderr, level: Logger::WARN
61
- def logger
62
- LOGGER
63
- end
64
- end
65
-
66
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
- module GRPC
68
- extend MyLogger
78
+ client = ::Google::Cloud::Bigtable::V2::Bigtable::Client.new do |config|
79
+ config.logger = Logger.new "my-app.log"
69
80
  end
70
81
  ```
71
82
 
72
-
73
83
  ## Google Cloud Samples
74
84
 
75
85
  To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
86
 
77
87
  ## Supported Ruby Versions
78
88
 
79
- This library is supported on Ruby 2.7+.
89
+ This library is supported on Ruby 3.0+.
80
90
 
81
91
  Google provides official support for Ruby versions that are actively supported
82
92
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -176,8 +176,28 @@ module Google
176
176
  universe_domain: @config.universe_domain,
177
177
  channel_args: @config.channel_args,
178
178
  interceptors: @config.interceptors,
179
- channel_pool_config: @config.channel_pool
179
+ channel_pool_config: @config.channel_pool,
180
+ logger: @config.logger
180
181
  )
182
+
183
+ @bigtable_stub.stub_logger&.info do |entry|
184
+ entry.set_system_name
185
+ entry.set_service
186
+ entry.message = "Created client for #{entry.service}"
187
+ entry.set_credentials_fields credentials
188
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
189
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
190
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
191
+ end
192
+ end
193
+
194
+ ##
195
+ # The logger used for request/response debug logging.
196
+ #
197
+ # @return [Logger]
198
+ #
199
+ def logger
200
+ @bigtable_stub.logger
181
201
  end
182
202
 
183
203
  # Service calls
@@ -312,7 +332,6 @@ module Google
312
332
 
313
333
  @bigtable_stub.call_rpc :read_rows, request, options: options do |response, operation|
314
334
  yield response, operation if block_given?
315
- return response
316
335
  end
317
336
  rescue ::GRPC::BadStatus => e
318
337
  raise ::Google::Cloud::Error.from_error(e)
@@ -424,7 +443,6 @@ module Google
424
443
 
425
444
  @bigtable_stub.call_rpc :sample_row_keys, request, options: options do |response, operation|
426
445
  yield response, operation if block_given?
427
- return response
428
446
  end
429
447
  rescue ::GRPC::BadStatus => e
430
448
  raise ::Google::Cloud::Error.from_error(e)
@@ -538,7 +556,6 @@ module Google
538
556
 
539
557
  @bigtable_stub.call_rpc :mutate_row, request, options: options do |response, operation|
540
558
  yield response, operation if block_given?
541
- return response
542
559
  end
543
560
  rescue ::GRPC::BadStatus => e
544
561
  raise ::Google::Cloud::Error.from_error(e)
@@ -656,7 +673,6 @@ module Google
656
673
 
657
674
  @bigtable_stub.call_rpc :mutate_rows, request, options: options do |response, operation|
658
675
  yield response, operation if block_given?
659
- return response
660
676
  end
661
677
  rescue ::GRPC::BadStatus => e
662
678
  raise ::Google::Cloud::Error.from_error(e)
@@ -783,7 +799,6 @@ module Google
783
799
 
784
800
  @bigtable_stub.call_rpc :check_and_mutate_row, request, options: options do |response, operation|
785
801
  yield response, operation if block_given?
786
- return response
787
802
  end
788
803
  rescue ::GRPC::BadStatus => e
789
804
  raise ::Google::Cloud::Error.from_error(e)
@@ -879,7 +894,6 @@ module Google
879
894
 
880
895
  @bigtable_stub.call_rpc :ping_and_warm, request, options: options do |response, operation|
881
896
  yield response, operation if block_given?
882
- return response
883
897
  end
884
898
  rescue ::GRPC::BadStatus => e
885
899
  raise ::Google::Cloud::Error.from_error(e)
@@ -997,7 +1011,6 @@ module Google
997
1011
 
998
1012
  @bigtable_stub.call_rpc :read_modify_write_row, request, options: options do |response, operation|
999
1013
  yield response, operation if block_given?
1000
- return response
1001
1014
  end
1002
1015
  rescue ::GRPC::BadStatus => e
1003
1016
  raise ::Google::Cloud::Error.from_error(e)
@@ -1096,7 +1109,6 @@ module Google
1096
1109
 
1097
1110
  @bigtable_stub.call_rpc :generate_initial_change_stream_partitions, request, options: options do |response, operation|
1098
1111
  yield response, operation if block_given?
1099
- return response
1100
1112
  end
1101
1113
  rescue ::GRPC::BadStatus => e
1102
1114
  raise ::Google::Cloud::Error.from_error(e)
@@ -1139,6 +1151,8 @@ module Google
1139
1151
  # be within the change stream retention period, less than or equal to the
1140
1152
  # current time, and after change stream creation, whichever is greater.
1141
1153
  # This value is inclusive and will be truncated to microsecond granularity.
1154
+ #
1155
+ # Note: The following fields are mutually exclusive: `start_time`, `continuation_tokens`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1142
1156
  # @param continuation_tokens [::Google::Cloud::Bigtable::V2::StreamContinuationTokens, ::Hash]
1143
1157
  # Tokens that describe how to resume reading a stream where reading
1144
1158
  # previously left off. If specified, changes will be read starting at the
@@ -1150,6 +1164,8 @@ module Google
1150
1164
  # of a partition merge, the union of the token partitions must exactly
1151
1165
  # cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
1152
1166
  # returned.
1167
+ #
1168
+ # Note: The following fields are mutually exclusive: `continuation_tokens`, `start_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1153
1169
  # @param end_time [::Google::Protobuf::Timestamp, ::Hash]
1154
1170
  # If specified, OK will be returned when the stream advances beyond
1155
1171
  # this time. Otherwise, changes will be continuously delivered on the stream.
@@ -1220,7 +1236,6 @@ module Google
1220
1236
 
1221
1237
  @bigtable_stub.call_rpc :read_change_stream, request, options: options do |response, operation|
1222
1238
  yield response, operation if block_given?
1223
- return response
1224
1239
  end
1225
1240
  rescue ::GRPC::BadStatus => e
1226
1241
  raise ::Google::Cloud::Error.from_error(e)
@@ -1351,7 +1366,6 @@ module Google
1351
1366
 
1352
1367
  @bigtable_stub.call_rpc :execute_query, request, options: options do |response, operation|
1353
1368
  yield response, operation if block_given?
1354
- return response
1355
1369
  end
1356
1370
  rescue ::GRPC::BadStatus => e
1357
1371
  raise ::Google::Cloud::Error.from_error(e)
@@ -1401,6 +1415,13 @@ module Google
1401
1415
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1402
1416
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1403
1417
  # * (`nil`) indicating no credentials
1418
+ #
1419
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1420
+ # external source for authentication to Google Cloud, you must validate it before
1421
+ # providing it to a Google API client library. Providing an unvalidated credential
1422
+ # configuration to Google APIs can compromise the security of your systems and data.
1423
+ # For more information, refer to [Validate credential configurations from external
1424
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1404
1425
  # @return [::Object]
1405
1426
  # @!attribute [rw] scope
1406
1427
  # The OAuth scopes
@@ -1440,6 +1461,11 @@ module Google
1440
1461
  # default endpoint URL. The default value of nil uses the environment
1441
1462
  # universe (usually the default "googleapis.com" universe).
1442
1463
  # @return [::String,nil]
1464
+ # @!attribute [rw] logger
1465
+ # A custom logger to use for request/response debug logging, or the value
1466
+ # `:default` (the default) to construct a default logger, or `nil` to
1467
+ # explicitly disable logging.
1468
+ # @return [::Logger,:default,nil]
1443
1469
  #
1444
1470
  class Configuration
1445
1471
  extend ::Gapic::Config
@@ -1464,6 +1490,7 @@ module Google
1464
1490
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1465
1491
  config_attr :quota_project, nil, ::String, nil
1466
1492
  config_attr :universe_domain, nil, ::String, nil
1493
+ config_attr :logger, :default, ::Logger, nil, :default
1467
1494
 
1468
1495
  # @private
1469
1496
  def initialize parent_config = nil
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Bigtable
23
23
  module V2
24
- VERSION = "1.3.0"
24
+ VERSION = "1.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -215,6 +215,12 @@ module Google
215
215
  # enabled. By default, asynchronous REST clients will not be generated.
216
216
  # This feature will be enabled by default 1 month after launching the
217
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
218
224
  class ExperimentalFeatures
219
225
  include ::Google::Protobuf::MessageExts
220
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -300,9 +306,28 @@ module Google
300
306
  # @!attribute [rw] common
301
307
  # @return [::Google::Api::CommonLanguageSettings]
302
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
303
319
  class GoSettings
304
320
  include ::Google::Protobuf::MessageExts
305
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
306
331
  end
307
332
 
308
333
  # Describes the generator configuration for a method.
@@ -181,10 +181,14 @@ module Google
181
181
  # @return [::Boolean]
182
182
  # Indicates that the client should drop all previous chunks for
183
183
  # `row_key`, as it will be re-read from the beginning.
184
+ #
185
+ # Note: The following fields are mutually exclusive: `reset_row`, `commit_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
184
186
  # @!attribute [rw] commit_row
185
187
  # @return [::Boolean]
186
188
  # Indicates that the client can safely process all previous chunks for
187
189
  # `row_key`, as its data has been fully read.
190
+ #
191
+ # Note: The following fields are mutually exclusive: `commit_row`, `reset_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
188
192
  class CellChunk
189
193
  include ::Google::Protobuf::MessageExts
190
194
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -544,6 +548,8 @@ module Google
544
548
  # be within the change stream retention period, less than or equal to the
545
549
  # current time, and after change stream creation, whichever is greater.
546
550
  # This value is inclusive and will be truncated to microsecond granularity.
551
+ #
552
+ # Note: The following fields are mutually exclusive: `start_time`, `continuation_tokens`. If a field in that set is populated, all other fields in the set will automatically be cleared.
547
553
  # @!attribute [rw] continuation_tokens
548
554
  # @return [::Google::Cloud::Bigtable::V2::StreamContinuationTokens]
549
555
  # Tokens that describe how to resume reading a stream where reading
@@ -556,6 +562,8 @@ module Google
556
562
  # of a partition merge, the union of the token partitions must exactly
557
563
  # cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
558
564
  # returned.
565
+ #
566
+ # Note: The following fields are mutually exclusive: `continuation_tokens`, `start_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
559
567
  # @!attribute [rw] end_time
560
568
  # @return [::Google::Protobuf::Timestamp]
561
569
  # If specified, OK will be returned when the stream advances beyond
@@ -575,12 +583,18 @@ module Google
575
583
  # @!attribute [rw] data_change
576
584
  # @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange]
577
585
  # A mutation to the partition.
586
+ #
587
+ # Note: The following fields are mutually exclusive: `data_change`, `heartbeat`, `close_stream`. If a field in that set is populated, all other fields in the set will automatically be cleared.
578
588
  # @!attribute [rw] heartbeat
579
589
  # @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::Heartbeat]
580
590
  # A periodic heartbeat message.
591
+ #
592
+ # Note: The following fields are mutually exclusive: `heartbeat`, `data_change`, `close_stream`. If a field in that set is populated, all other fields in the set will automatically be cleared.
581
593
  # @!attribute [rw] close_stream
582
594
  # @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream]
583
595
  # An indication that the stream should be closed.
596
+ #
597
+ # Note: The following fields are mutually exclusive: `close_stream`, `data_change`, `heartbeat`. If a field in that set is populated, all other fields in the set will automatically be cleared.
584
598
  class ReadChangeStreamResponse
585
599
  include ::Google::Protobuf::MessageExts
586
600
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -813,11 +827,15 @@ module Google
813
827
  # @return [::Google::Cloud::Bigtable::V2::ResultSetMetadata]
814
828
  # Structure of rows in this response stream. The first (and only the first)
815
829
  # response streamed from the server will be of this type.
830
+ #
831
+ # Note: The following fields are mutually exclusive: `metadata`, `results`. If a field in that set is populated, all other fields in the set will automatically be cleared.
816
832
  # @!attribute [rw] results
817
833
  # @return [::Google::Cloud::Bigtable::V2::PartialResultSet]
818
834
  # A partial result set with row data potentially including additional
819
835
  # instructions on how recent past and future partial responses should be
820
836
  # interpreted.
837
+ #
838
+ # Note: The following fields are mutually exclusive: `results`, `metadata`. If a field in that set is populated, all other fields in the set will automatically be cleared.
821
839
  class ExecuteQueryResponse
822
840
  include ::Google::Protobuf::MessageExts
823
841
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -117,31 +117,49 @@ module Google
117
117
  # @return [::String]
118
118
  # Represents a raw byte sequence with no type information.
119
119
  # The `type` field must be omitted.
120
+ #
121
+ # Note: The following fields are mutually exclusive: `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
120
122
  # @!attribute [rw] raw_timestamp_micros
121
123
  # @return [::Integer]
122
124
  # Represents a raw cell timestamp with no type information.
123
125
  # The `type` field must be omitted.
126
+ #
127
+ # Note: The following fields are mutually exclusive: `raw_timestamp_micros`, `raw_value`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
124
128
  # @!attribute [rw] bytes_value
125
129
  # @return [::String]
126
130
  # Represents a typed value transported as a byte sequence.
131
+ #
132
+ # Note: The following fields are mutually exclusive: `bytes_value`, `raw_value`, `raw_timestamp_micros`, `string_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
127
133
  # @!attribute [rw] string_value
128
134
  # @return [::String]
129
135
  # Represents a typed value transported as a string.
136
+ #
137
+ # Note: The following fields are mutually exclusive: `string_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
130
138
  # @!attribute [rw] int_value
131
139
  # @return [::Integer]
132
140
  # Represents a typed value transported as an integer.
141
+ #
142
+ # Note: The following fields are mutually exclusive: `int_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
143
  # @!attribute [rw] bool_value
134
144
  # @return [::Boolean]
135
145
  # Represents a typed value transported as a boolean.
146
+ #
147
+ # Note: The following fields are mutually exclusive: `bool_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `float_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
136
148
  # @!attribute [rw] float_value
137
149
  # @return [::Float]
138
150
  # Represents a typed value transported as a floating point number.
151
+ #
152
+ # Note: The following fields are mutually exclusive: `float_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
139
153
  # @!attribute [rw] timestamp_value
140
154
  # @return [::Google::Protobuf::Timestamp]
141
155
  # Represents a typed value transported as a timestamp.
156
+ #
157
+ # Note: The following fields are mutually exclusive: `timestamp_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `float_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
142
158
  # @!attribute [rw] date_value
143
159
  # @return [::Google::Type::Date]
144
160
  # Represents a typed value transported as a date.
161
+ #
162
+ # Note: The following fields are mutually exclusive: `date_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
145
163
  # @!attribute [rw] array_value
146
164
  # @return [::Google::Cloud::Bigtable::V2::ArrayValue]
147
165
  # Represents a typed value transported as a sequence of values.
@@ -149,6 +167,8 @@ module Google
149
167
  # `Value` must provide an explicit `type` on write. This `type` will
150
168
  # apply recursively to the nested `Struct` fields, `Array` elements,
151
169
  # or `Map` key/value pairs, which *must not* supply their own `type`.
170
+ #
171
+ # Note: The following fields are mutually exclusive: `array_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `float_value`, `timestamp_value`, `date_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
152
172
  class Value
153
173
  include ::Google::Protobuf::MessageExts
154
174
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -167,15 +187,23 @@ module Google
167
187
  # @!attribute [rw] start_key_closed
168
188
  # @return [::String]
169
189
  # Used when giving an inclusive lower bound for the range.
190
+ #
191
+ # Note: The following fields are mutually exclusive: `start_key_closed`, `start_key_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
170
192
  # @!attribute [rw] start_key_open
171
193
  # @return [::String]
172
194
  # Used when giving an exclusive lower bound for the range.
195
+ #
196
+ # Note: The following fields are mutually exclusive: `start_key_open`, `start_key_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
173
197
  # @!attribute [rw] end_key_open
174
198
  # @return [::String]
175
199
  # Used when giving an exclusive upper bound for the range.
200
+ #
201
+ # Note: The following fields are mutually exclusive: `end_key_open`, `end_key_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
176
202
  # @!attribute [rw] end_key_closed
177
203
  # @return [::String]
178
204
  # Used when giving an inclusive upper bound for the range.
205
+ #
206
+ # Note: The following fields are mutually exclusive: `end_key_closed`, `end_key_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
179
207
  class RowRange
180
208
  include ::Google::Protobuf::MessageExts
181
209
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,15 +231,23 @@ module Google
203
231
  # @!attribute [rw] start_qualifier_closed
204
232
  # @return [::String]
205
233
  # Used when giving an inclusive lower bound for the range.
234
+ #
235
+ # Note: The following fields are mutually exclusive: `start_qualifier_closed`, `start_qualifier_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
206
236
  # @!attribute [rw] start_qualifier_open
207
237
  # @return [::String]
208
238
  # Used when giving an exclusive lower bound for the range.
239
+ #
240
+ # Note: The following fields are mutually exclusive: `start_qualifier_open`, `start_qualifier_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
209
241
  # @!attribute [rw] end_qualifier_closed
210
242
  # @return [::String]
211
243
  # Used when giving an inclusive upper bound for the range.
244
+ #
245
+ # Note: The following fields are mutually exclusive: `end_qualifier_closed`, `end_qualifier_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
212
246
  # @!attribute [rw] end_qualifier_open
213
247
  # @return [::String]
214
248
  # Used when giving an exclusive upper bound for the range.
249
+ #
250
+ # Note: The following fields are mutually exclusive: `end_qualifier_open`, `end_qualifier_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
215
251
  class ColumnRange
216
252
  include ::Google::Protobuf::MessageExts
217
253
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -233,15 +269,23 @@ module Google
233
269
  # @!attribute [rw] start_value_closed
234
270
  # @return [::String]
235
271
  # Used when giving an inclusive lower bound for the range.
272
+ #
273
+ # Note: The following fields are mutually exclusive: `start_value_closed`, `start_value_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
236
274
  # @!attribute [rw] start_value_open
237
275
  # @return [::String]
238
276
  # Used when giving an exclusive lower bound for the range.
277
+ #
278
+ # Note: The following fields are mutually exclusive: `start_value_open`, `start_value_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
239
279
  # @!attribute [rw] end_value_closed
240
280
  # @return [::String]
241
281
  # Used when giving an inclusive upper bound for the range.
282
+ #
283
+ # Note: The following fields are mutually exclusive: `end_value_closed`, `end_value_open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
242
284
  # @!attribute [rw] end_value_open
243
285
  # @return [::String]
244
286
  # Used when giving an exclusive upper bound for the range.
287
+ #
288
+ # Note: The following fields are mutually exclusive: `end_value_open`, `end_value_closed`. If a field in that set is populated, all other fields in the set will automatically be cleared.
245
289
  class ValueRange
246
290
  include ::Google::Protobuf::MessageExts
247
291
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -284,14 +328,20 @@ module Google
284
328
  # @return [::Google::Cloud::Bigtable::V2::RowFilter::Chain]
285
329
  # Applies several RowFilters to the data in sequence, progressively
286
330
  # narrowing the results.
331
+ #
332
+ # 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.
287
333
  # @!attribute [rw] interleave
288
334
  # @return [::Google::Cloud::Bigtable::V2::RowFilter::Interleave]
289
335
  # Applies several RowFilters to the data in parallel and combines the
290
336
  # results.
337
+ #
338
+ # 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.
291
339
  # @!attribute [rw] condition
292
340
  # @return [::Google::Cloud::Bigtable::V2::RowFilter::Condition]
293
341
  # Applies one of two possible RowFilters to the data based on the output of
294
342
  # a predicate RowFilter.
343
+ #
344
+ # 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.
295
345
  # @!attribute [rw] sink
296
346
  # @return [::Boolean]
297
347
  # ADVANCED USE ONLY.
@@ -353,14 +403,20 @@ module Google
353
403
  #
354
404
  # Cannot be used within the `predicate_filter`, `true_filter`, or
355
405
  # `false_filter` of a {::Google::Cloud::Bigtable::V2::RowFilter::Condition Condition}.
406
+ #
407
+ # 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.
356
408
  # @!attribute [rw] pass_all_filter
357
409
  # @return [::Boolean]
358
410
  # Matches all cells, regardless of input. Functionally equivalent to
359
411
  # leaving `filter` unset, but included for completeness.
412
+ #
413
+ # 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.
360
414
  # @!attribute [rw] block_all_filter
361
415
  # @return [::Boolean]
362
416
  # Does not match any cells, regardless of input. Useful for temporarily
363
417
  # disabling just part of a filter.
418
+ #
419
+ # 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.
364
420
  # @!attribute [rw] row_key_regex_filter
365
421
  # @return [::String]
366
422
  # Matches only cells from rows whose keys satisfy the given RE2 regex. In
@@ -370,10 +426,14 @@ module Google
370
426
  # sequence must be used if a true wildcard is desired. The `.` character
371
427
  # will not match the new line character `\n`, which may be present in a
372
428
  # binary key.
429
+ #
430
+ # 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.
373
431
  # @!attribute [rw] row_sample_filter
374
432
  # @return [::Float]
375
433
  # Matches all cells from a row with probability p, and matches no cells
376
434
  # from the row with probability 1-p.
435
+ #
436
+ # 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.
377
437
  # @!attribute [rw] family_name_regex_filter
378
438
  # @return [::String]
379
439
  # Matches only cells from columns whose families satisfy the given RE2
@@ -382,6 +442,8 @@ module Google
382
442
  # Note that, since column families cannot contain the new line character
383
443
  # `\n`, it is sufficient to use `.` as a full wildcard when matching
384
444
  # column family names.
445
+ #
446
+ # 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.
385
447
  # @!attribute [rw] column_qualifier_regex_filter
386
448
  # @return [::String]
387
449
  # Matches only cells from columns whose qualifiers satisfy the given RE2
@@ -390,12 +452,18 @@ module Google
390
452
  # escape sequence must be used if a true wildcard is desired. The `.`
391
453
  # character will not match the new line character `\n`, which may be
392
454
  # present in a binary qualifier.
455
+ #
456
+ # 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.
393
457
  # @!attribute [rw] column_range_filter
394
458
  # @return [::Google::Cloud::Bigtable::V2::ColumnRange]
395
459
  # Matches only cells from columns within the given range.
460
+ #
461
+ # 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.
396
462
  # @!attribute [rw] timestamp_range_filter
397
463
  # @return [::Google::Cloud::Bigtable::V2::TimestampRange]
398
464
  # Matches only cells with timestamps within the given range.
465
+ #
466
+ # 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.
399
467
  # @!attribute [rw] value_regex_filter
400
468
  # @return [::String]
401
469
  # Matches only cells with values that satisfy the given regular expression.
@@ -403,19 +471,27 @@ module Google
403
471
  # sequence must be used if a true wildcard is desired. The `.` character
404
472
  # will not match the new line character `\n`, which may be present in a
405
473
  # binary value.
474
+ #
475
+ # 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.
406
476
  # @!attribute [rw] value_range_filter
407
477
  # @return [::Google::Cloud::Bigtable::V2::ValueRange]
408
478
  # Matches only cells with values that fall within the given range.
479
+ #
480
+ # 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.
409
481
  # @!attribute [rw] cells_per_row_offset_filter
410
482
  # @return [::Integer]
411
483
  # Skips the first N cells of each row, matching all subsequent cells.
412
484
  # If duplicate cells are present, as is possible when using an Interleave,
413
485
  # each copy of the cell is counted separately.
486
+ #
487
+ # 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.
414
488
  # @!attribute [rw] cells_per_row_limit_filter
415
489
  # @return [::Integer]
416
490
  # Matches only the first N cells of each row.
417
491
  # If duplicate cells are present, as is possible when using an Interleave,
418
492
  # each copy of the cell is counted separately.
493
+ #
494
+ # 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.
419
495
  # @!attribute [rw] cells_per_column_limit_filter
420
496
  # @return [::Integer]
421
497
  # Matches only the most recent N cells within each column. For example,
@@ -424,9 +500,13 @@ module Google
424
500
  # column `foo:bar2`.
425
501
  # If duplicate cells are present, as is possible when using an Interleave,
426
502
  # each copy of the cell is counted separately.
503
+ #
504
+ # 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.
427
505
  # @!attribute [rw] strip_value_transformer
428
506
  # @return [::Boolean]
429
507
  # Replaces each cell's value with the empty string.
508
+ #
509
+ # 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.
430
510
  # @!attribute [rw] apply_label_transformer
431
511
  # @return [::String]
432
512
  # Applies the given label to all cells in the output row. This allows
@@ -442,6 +522,8 @@ module Google
442
522
  # an Interleave to contain multiple `apply_label_transformers`, as they
443
523
  # will be applied to separate copies of the input. This may be relaxed in
444
524
  # the future.
525
+ #
526
+ # 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.
445
527
  class RowFilter
446
528
  include ::Google::Protobuf::MessageExts
447
529
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -521,21 +603,33 @@ module Google
521
603
  # @!attribute [rw] set_cell
522
604
  # @return [::Google::Cloud::Bigtable::V2::Mutation::SetCell]
523
605
  # Set a cell's value.
606
+ #
607
+ # Note: The following fields are mutually exclusive: `set_cell`, `add_to_cell`, `merge_to_cell`, `delete_from_column`, `delete_from_family`, `delete_from_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
524
608
  # @!attribute [rw] add_to_cell
525
609
  # @return [::Google::Cloud::Bigtable::V2::Mutation::AddToCell]
526
610
  # Incrementally updates an `Aggregate` cell.
611
+ #
612
+ # Note: The following fields are mutually exclusive: `add_to_cell`, `set_cell`, `merge_to_cell`, `delete_from_column`, `delete_from_family`, `delete_from_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
527
613
  # @!attribute [rw] merge_to_cell
528
614
  # @return [::Google::Cloud::Bigtable::V2::Mutation::MergeToCell]
529
615
  # Merges accumulated state to an `Aggregate` cell.
616
+ #
617
+ # Note: The following fields are mutually exclusive: `merge_to_cell`, `set_cell`, `add_to_cell`, `delete_from_column`, `delete_from_family`, `delete_from_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
530
618
  # @!attribute [rw] delete_from_column
531
619
  # @return [::Google::Cloud::Bigtable::V2::Mutation::DeleteFromColumn]
532
620
  # Deletes cells from a column.
621
+ #
622
+ # Note: The following fields are mutually exclusive: `delete_from_column`, `set_cell`, `add_to_cell`, `merge_to_cell`, `delete_from_family`, `delete_from_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
533
623
  # @!attribute [rw] delete_from_family
534
624
  # @return [::Google::Cloud::Bigtable::V2::Mutation::DeleteFromFamily]
535
625
  # Deletes cells from a column family.
626
+ #
627
+ # Note: The following fields are mutually exclusive: `delete_from_family`, `set_cell`, `add_to_cell`, `merge_to_cell`, `delete_from_column`, `delete_from_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
536
628
  # @!attribute [rw] delete_from_row
537
629
  # @return [::Google::Cloud::Bigtable::V2::Mutation::DeleteFromRow]
538
630
  # Deletes cells from the entire row.
631
+ #
632
+ # Note: The following fields are mutually exclusive: `delete_from_row`, `set_cell`, `add_to_cell`, `merge_to_cell`, `delete_from_column`, `delete_from_family`. If a field in that set is populated, all other fields in the set will automatically be cleared.
539
633
  class Mutation
540
634
  include ::Google::Protobuf::MessageExts
541
635
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -663,12 +757,16 @@ module Google
663
757
  # Rule specifying that `append_value` be appended to the existing value.
664
758
  # If the targeted cell is unset, it will be treated as containing the
665
759
  # empty string.
760
+ #
761
+ # Note: The following fields are mutually exclusive: `append_value`, `increment_amount`. If a field in that set is populated, all other fields in the set will automatically be cleared.
666
762
  # @!attribute [rw] increment_amount
667
763
  # @return [::Integer]
668
764
  # Rule specifying that `increment_amount` be added to the existing value.
669
765
  # If the targeted cell is unset, it will be treated as containing a zero.
670
766
  # Otherwise, the targeted cell must contain an 8-byte value (interpreted
671
767
  # as a 64-bit big-endian signed integer), or the entire request will fail.
768
+ #
769
+ # Note: The following fields are mutually exclusive: `increment_amount`, `append_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
672
770
  class ReadModifyWriteRule
673
771
  include ::Google::Protobuf::MessageExts
674
772
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,39 +48,63 @@ module Google
48
48
  # @!attribute [rw] bytes_type
49
49
  # @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
50
50
  # Bytes
51
+ #
52
+ # Note: The following fields are mutually exclusive: `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
51
53
  # @!attribute [rw] string_type
52
54
  # @return [::Google::Cloud::Bigtable::V2::Type::String]
53
55
  # String
56
+ #
57
+ # Note: The following fields are mutually exclusive: `string_type`, `bytes_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
54
58
  # @!attribute [rw] int64_type
55
59
  # @return [::Google::Cloud::Bigtable::V2::Type::Int64]
56
60
  # Int64
61
+ #
62
+ # Note: The following fields are mutually exclusive: `int64_type`, `bytes_type`, `string_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
57
63
  # @!attribute [rw] float32_type
58
64
  # @return [::Google::Cloud::Bigtable::V2::Type::Float32]
59
65
  # Float32
66
+ #
67
+ # Note: The following fields are mutually exclusive: `float32_type`, `bytes_type`, `string_type`, `int64_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
60
68
  # @!attribute [rw] float64_type
61
69
  # @return [::Google::Cloud::Bigtable::V2::Type::Float64]
62
70
  # Float64
71
+ #
72
+ # Note: The following fields are mutually exclusive: `float64_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
63
73
  # @!attribute [rw] bool_type
64
74
  # @return [::Google::Cloud::Bigtable::V2::Type::Bool]
65
75
  # Bool
76
+ #
77
+ # Note: The following fields are mutually exclusive: `bool_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
78
  # @!attribute [rw] timestamp_type
67
79
  # @return [::Google::Cloud::Bigtable::V2::Type::Timestamp]
68
80
  # Timestamp
81
+ #
82
+ # Note: The following fields are mutually exclusive: `timestamp_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
69
83
  # @!attribute [rw] date_type
70
84
  # @return [::Google::Cloud::Bigtable::V2::Type::Date]
71
85
  # Date
86
+ #
87
+ # Note: The following fields are mutually exclusive: `date_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `aggregate_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
72
88
  # @!attribute [rw] aggregate_type
73
89
  # @return [::Google::Cloud::Bigtable::V2::Type::Aggregate]
74
90
  # Aggregate
91
+ #
92
+ # Note: The following fields are mutually exclusive: `aggregate_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `struct_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
75
93
  # @!attribute [rw] struct_type
76
94
  # @return [::Google::Cloud::Bigtable::V2::Type::Struct]
77
95
  # Struct
96
+ #
97
+ # Note: The following fields are mutually exclusive: `struct_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `array_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
78
98
  # @!attribute [rw] array_type
79
99
  # @return [::Google::Cloud::Bigtable::V2::Type::Array]
80
100
  # Array
101
+ #
102
+ # Note: The following fields are mutually exclusive: `array_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `map_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
81
103
  # @!attribute [rw] map_type
82
104
  # @return [::Google::Cloud::Bigtable::V2::Type::Map]
83
105
  # Map
106
+ #
107
+ # Note: The following fields are mutually exclusive: `map_type`, `bytes_type`, `string_type`, `int64_type`, `float32_type`, `float64_type`, `bool_type`, `timestamp_type`, `date_type`, `aggregate_type`, `struct_type`, `array_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
84
108
  class Type
85
109
  include ::Google::Protobuf::MessageExts
86
110
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -127,9 +151,13 @@ module Google
127
151
  # @deprecated This field is deprecated and may be removed in the next major version update.
128
152
  # @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
129
153
  # Deprecated: if set, converts to an empty `utf8_bytes`.
154
+ #
155
+ # Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
130
156
  # @!attribute [rw] utf8_bytes
131
157
  # @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
132
158
  # Use `Utf8Bytes` encoding.
159
+ #
160
+ # Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
161
  class Encoding
134
162
  include ::Google::Protobuf::MessageExts
135
163
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,15 +325,23 @@ module Google
297
325
  # @!attribute [rw] sum
298
326
  # @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
299
327
  # Sum aggregator.
328
+ #
329
+ # Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
300
330
  # @!attribute [rw] hllpp_unique_count
301
331
  # @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
302
332
  # HyperLogLogPlusPlusUniqueCount aggregator.
333
+ #
334
+ # Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
303
335
  # @!attribute [rw] max
304
336
  # @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
305
337
  # Max aggregator.
338
+ #
339
+ # Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
306
340
  # @!attribute [rw] min
307
341
  # @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
308
342
  # Min aggregator.
343
+ #
344
+ # Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
309
345
  class Aggregate
310
346
  include ::Google::Protobuf::MessageExts
311
347
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigtable-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-11-13 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -94,7 +93,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
94
93
  licenses:
95
94
  - Apache-2.0
96
95
  metadata: {}
97
- post_install_message:
98
96
  rdoc_options: []
99
97
  require_paths:
100
98
  - lib
@@ -102,15 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
102
100
  requirements:
103
101
  - - ">="
104
102
  - !ruby/object:Gem::Version
105
- version: '2.7'
103
+ version: '3.0'
106
104
  required_rubygems_version: !ruby/object:Gem::Requirement
107
105
  requirements:
108
106
  - - ">="
109
107
  - !ruby/object:Gem::Version
110
108
  version: '0'
111
109
  requirements: []
112
- rubygems_version: 3.5.22
113
- signing_key:
110
+ rubygems_version: 3.6.2
114
111
  specification_version: 4
115
112
  summary: API for reading and writing the contents of Bigtable tables associated with
116
113
  a Google Cloud project.