google-apis-spanner_v1 0.5.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 800f4bc36b1b24d281ee038f5d95920ef9321dd0469b6e55ab130507e31874ca
4
- data.tar.gz: 4baecda7cbeddf24c81e9ba9a66514aa9e0cbfdce5b1b365328f3f13b54e57a8
3
+ metadata.gz: 9d298077ac6791fa4a61e2f2b6b65cf07ca365a438e5fdf3855201908a636e81
4
+ data.tar.gz: 73dd1e17d5cef167fc75816ea0306c93607ca71faf5802978d0260c46bb6f685
5
5
  SHA512:
6
- metadata.gz: 919a8ee4a4618bb4560f51ad70e19487efe42f401b8773905d58d7cf7bc8dedf80ef42286ae1724fec30951e56f85f7c3a53cbdd7ad83562a2564c0e7a6369d8
7
- data.tar.gz: e21cf255e2ffeb240a18c022a6ef6ed2f231e1a904ca16bb90ef24d104e8034fe814366db10e429957b2db458ba7c040626cfa62310edbfc30a45b3b1300c66c
6
+ metadata.gz: 3babd3de3ba956c13eba380f71fcc2deedbdeb038214ad2a3f1a88be08b68a7c103daf6f0ee45478bf0cf6a9f718b774284ca4d5d7e352b2adfc8b92e49d5c12
7
+ data.tar.gz: f7bd4236ac9abc7b6e87f70de14c0c66505bb703ca5ce4ef622a0a5accd482a7dbc05fa14fa6bb22553352fda8d38fcf334a8a88c5729a7d6499679e73d35374
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Release history for google-apis-spanner_v1
2
2
 
3
+ ### v0.10.0 (2021-05-22)
4
+
5
+ * Regenerated from discovery document revision 20210517
6
+ * Unspecified changes
7
+
8
+ ### v0.9.0 (2021-04-17)
9
+
10
+ * Regenerated from discovery document revision 20210405
11
+
12
+ ### v0.8.0 (2021-04-01)
13
+
14
+ * Regenerated from discovery document revision 20210325
15
+
16
+ ### v0.7.0 (2021-03-26)
17
+
18
+ * Regenerated from discovery document revision 20210318
19
+
20
+ ### v0.6.0 (2021-03-13)
21
+
22
+ * Regenerated from discovery document revision 20210309
23
+ * Regenerated using generator version 0.2.0
24
+
3
25
  ### v0.5.0 (2021-03-04)
4
26
 
5
27
  * Unspecified changes
@@ -30,7 +30,7 @@ module Google
30
30
  # This is NOT the gem version.
31
31
  VERSION = 'V1'
32
32
 
33
- # View and manage your data across Google Cloud Platform services
33
+ # See, edit, configure, and delete your Google Cloud Platform data
34
34
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
35
35
 
36
36
  # Administer your Spanner databases
@@ -364,6 +364,11 @@ module Google
364
364
  # @return [Google::Apis::SpannerV1::TransactionOptions]
365
365
  attr_accessor :options
366
366
 
367
+ # Common request options for various APIs.
368
+ # Corresponds to the JSON property `requestOptions`
369
+ # @return [Google::Apis::SpannerV1::RequestOptions]
370
+ attr_accessor :request_options
371
+
367
372
  def initialize(**args)
368
373
  update!(**args)
369
374
  end
@@ -371,6 +376,7 @@ module Google
371
376
  # Update properties of this object
372
377
  def update!(**args)
373
378
  @options = args[:options] if args.key?(:options)
379
+ @request_options = args[:request_options] if args.key?(:request_options)
374
380
  end
375
381
  end
376
382
 
@@ -494,6 +500,11 @@ module Google
494
500
  # @return [Array<Google::Apis::SpannerV1::Mutation>]
495
501
  attr_accessor :mutations
496
502
 
503
+ # Common request options for various APIs.
504
+ # Corresponds to the JSON property `requestOptions`
505
+ # @return [Google::Apis::SpannerV1::RequestOptions]
506
+ attr_accessor :request_options
507
+
497
508
  # If `true`, then statistics related to the transaction will be included in the
498
509
  # CommitResponse. Default value is `false`.
499
510
  # Corresponds to the JSON property `returnCommitStats`
@@ -677,6 +688,7 @@ module Google
677
688
  # Update properties of this object
678
689
  def update!(**args)
679
690
  @mutations = args[:mutations] if args.key?(:mutations)
691
+ @request_options = args[:request_options] if args.key?(:request_options)
680
692
  @return_commit_stats = args[:return_commit_stats] if args.key?(:return_commit_stats)
681
693
  @single_use_transaction = args[:single_use_transaction] if args.key?(:single_use_transaction)
682
694
  @transaction_id = args[:transaction_id] if args.key?(:transaction_id)
@@ -734,6 +746,45 @@ module Google
734
746
  end
735
747
  end
736
748
 
749
+ # A message representing context for a KeyRangeInfo, including a label, value,
750
+ # unit, and severity.
751
+ class ContextValue
752
+ include Google::Apis::Core::Hashable
753
+
754
+ # A message representing a user-facing string whose value may need to be
755
+ # translated before being displayed.
756
+ # Corresponds to the JSON property `label`
757
+ # @return [Google::Apis::SpannerV1::LocalizedString]
758
+ attr_accessor :label
759
+
760
+ # The severity of this context.
761
+ # Corresponds to the JSON property `severity`
762
+ # @return [String]
763
+ attr_accessor :severity
764
+
765
+ # The unit of the context value.
766
+ # Corresponds to the JSON property `unit`
767
+ # @return [String]
768
+ attr_accessor :unit
769
+
770
+ # The value for the context.
771
+ # Corresponds to the JSON property `value`
772
+ # @return [Float]
773
+ attr_accessor :value
774
+
775
+ def initialize(**args)
776
+ update!(**args)
777
+ end
778
+
779
+ # Update properties of this object
780
+ def update!(**args)
781
+ @label = args[:label] if args.key?(:label)
782
+ @severity = args[:severity] if args.key?(:severity)
783
+ @unit = args[:unit] if args.key?(:unit)
784
+ @value = args[:value] if args.key?(:value)
785
+ end
786
+ end
787
+
737
788
  # Metadata type for the operation returned by CreateBackup.
738
789
  class CreateBackupMetadata
739
790
  include Google::Apis::Core::Hashable
@@ -1024,6 +1075,85 @@ module Google
1024
1075
  end
1025
1076
  end
1026
1077
 
1078
+ # A message representing a derived metric.
1079
+ class DerivedMetric
1080
+ include Google::Apis::Core::Hashable
1081
+
1082
+ # A message representing a user-facing string whose value may need to be
1083
+ # translated before being displayed.
1084
+ # Corresponds to the JSON property `denominator`
1085
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1086
+ attr_accessor :denominator
1087
+
1088
+ # A message representing a user-facing string whose value may need to be
1089
+ # translated before being displayed.
1090
+ # Corresponds to the JSON property `numerator`
1091
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1092
+ attr_accessor :numerator
1093
+
1094
+ def initialize(**args)
1095
+ update!(**args)
1096
+ end
1097
+
1098
+ # Update properties of this object
1099
+ def update!(**args)
1100
+ @denominator = args[:denominator] if args.key?(:denominator)
1101
+ @numerator = args[:numerator] if args.key?(:numerator)
1102
+ end
1103
+ end
1104
+
1105
+ # A message representing the key visualizer diagnostic messages.
1106
+ class DiagnosticMessage
1107
+ include Google::Apis::Core::Hashable
1108
+
1109
+ # A message representing a user-facing string whose value may need to be
1110
+ # translated before being displayed.
1111
+ # Corresponds to the JSON property `info`
1112
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1113
+ attr_accessor :info
1114
+
1115
+ # A message representing a user-facing string whose value may need to be
1116
+ # translated before being displayed.
1117
+ # Corresponds to the JSON property `metric`
1118
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1119
+ attr_accessor :metric
1120
+
1121
+ # Whether this message is specific only for the current metric. By default
1122
+ # Diagnostics are shown for all metrics, regardless which metric is the
1123
+ # currently selected metric in the UI. However occasionally a metric will
1124
+ # generate so many messages that the resulting visual clutter becomes
1125
+ # overwhelming. In this case setting this to true, will show the diagnostic
1126
+ # messages for that metric only if it is the currently selected metric.
1127
+ # Corresponds to the JSON property `metricSpecific`
1128
+ # @return [Boolean]
1129
+ attr_accessor :metric_specific
1130
+ alias_method :metric_specific?, :metric_specific
1131
+
1132
+ # The severity of the diagnostic message.
1133
+ # Corresponds to the JSON property `severity`
1134
+ # @return [String]
1135
+ attr_accessor :severity
1136
+
1137
+ # A message representing a user-facing string whose value may need to be
1138
+ # translated before being displayed.
1139
+ # Corresponds to the JSON property `shortMessage`
1140
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1141
+ attr_accessor :short_message
1142
+
1143
+ def initialize(**args)
1144
+ update!(**args)
1145
+ end
1146
+
1147
+ # Update properties of this object
1148
+ def update!(**args)
1149
+ @info = args[:info] if args.key?(:info)
1150
+ @metric = args[:metric] if args.key?(:metric)
1151
+ @metric_specific = args[:metric_specific] if args.key?(:metric_specific)
1152
+ @severity = args[:severity] if args.key?(:severity)
1153
+ @short_message = args[:short_message] if args.key?(:short_message)
1154
+ end
1155
+ end
1156
+
1027
1157
  # A generic empty message that you can re-use to avoid defining duplicated empty
1028
1158
  # messages in your APIs. A typical example is to use it as the request or the
1029
1159
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -1102,6 +1232,11 @@ module Google
1102
1232
  class ExecuteBatchDmlRequest
1103
1233
  include Google::Apis::Core::Hashable
1104
1234
 
1235
+ # Common request options for various APIs.
1236
+ # Corresponds to the JSON property `requestOptions`
1237
+ # @return [Google::Apis::SpannerV1::RequestOptions]
1238
+ attr_accessor :request_options
1239
+
1105
1240
  # Required. A per-transaction sequence number used to identify this request.
1106
1241
  # This field makes each request idempotent such that if the request is received
1107
1242
  # multiple times, at most one will succeed. The sequence number must be
@@ -1134,6 +1269,7 @@ module Google
1134
1269
 
1135
1270
  # Update properties of this object
1136
1271
  def update!(**args)
1272
+ @request_options = args[:request_options] if args.key?(:request_options)
1137
1273
  @seqno = args[:seqno] if args.key?(:seqno)
1138
1274
  @statements = args[:statements] if args.key?(:statements)
1139
1275
  @transaction = args[:transaction] if args.key?(:transaction)
@@ -1232,6 +1368,11 @@ module Google
1232
1368
  # @return [Google::Apis::SpannerV1::QueryOptions]
1233
1369
  attr_accessor :query_options
1234
1370
 
1371
+ # Common request options for various APIs.
1372
+ # Corresponds to the JSON property `requestOptions`
1373
+ # @return [Google::Apis::SpannerV1::RequestOptions]
1374
+ attr_accessor :request_options
1375
+
1235
1376
  # If this request is resuming a previously interrupted SQL statement execution, `
1236
1377
  # resume_token` should be copied from the last PartialResultSet yielded before
1237
1378
  # the interruption. Doing this enables the new SQL statement execution to resume
@@ -1275,6 +1416,7 @@ module Google
1275
1416
  @partition_token = args[:partition_token] if args.key?(:partition_token)
1276
1417
  @query_mode = args[:query_mode] if args.key?(:query_mode)
1277
1418
  @query_options = args[:query_options] if args.key?(:query_options)
1419
+ @request_options = args[:request_options] if args.key?(:request_options)
1278
1420
  @resume_token = args[:resume_token] if args.key?(:resume_token)
1279
1421
  @seqno = args[:seqno] if args.key?(:seqno)
1280
1422
  @sql = args[:sql] if args.key?(:sql)
@@ -1430,6 +1572,49 @@ module Google
1430
1572
  end
1431
1573
  end
1432
1574
 
1575
+ # A message representing a (sparse) collection of hot keys for specific key
1576
+ # buckets.
1577
+ class IndexedHotKey
1578
+ include Google::Apis::Core::Hashable
1579
+
1580
+ # A (sparse) mapping from key bucket index to the index of the specific hot row
1581
+ # key for that key bucket. The index of the hot row key can be translated to the
1582
+ # actual row key via the ScanData.VisualizationData.indexed_keys repeated field.
1583
+ # Corresponds to the JSON property `sparseHotKeys`
1584
+ # @return [Hash<String,Fixnum>]
1585
+ attr_accessor :sparse_hot_keys
1586
+
1587
+ def initialize(**args)
1588
+ update!(**args)
1589
+ end
1590
+
1591
+ # Update properties of this object
1592
+ def update!(**args)
1593
+ @sparse_hot_keys = args[:sparse_hot_keys] if args.key?(:sparse_hot_keys)
1594
+ end
1595
+ end
1596
+
1597
+ # A message representing a (sparse) collection of KeyRangeInfos for specific key
1598
+ # buckets.
1599
+ class IndexedKeyRangeInfos
1600
+ include Google::Apis::Core::Hashable
1601
+
1602
+ # A (sparse) mapping from key bucket index to the KeyRangeInfos for that key
1603
+ # bucket.
1604
+ # Corresponds to the JSON property `keyRangeInfos`
1605
+ # @return [Hash<String,Google::Apis::SpannerV1::KeyRangeInfos>]
1606
+ attr_accessor :key_range_infos
1607
+
1608
+ def initialize(**args)
1609
+ update!(**args)
1610
+ end
1611
+
1612
+ # Update properties of this object
1613
+ def update!(**args)
1614
+ @key_range_infos = args[:key_range_infos] if args.key?(:key_range_infos)
1615
+ end
1616
+ end
1617
+
1433
1618
  # An isolated set of Cloud Spanner resources on which databases can be hosted.
1434
1619
  class Instance
1435
1620
  include Google::Apis::Core::Hashable
@@ -1618,6 +1803,97 @@ module Google
1618
1803
  end
1619
1804
  end
1620
1805
 
1806
+ # A message representing information for a key range (possibly one key).
1807
+ class KeyRangeInfo
1808
+ include Google::Apis::Core::Hashable
1809
+
1810
+ # The list of context values for this key range.
1811
+ # Corresponds to the JSON property `contextValues`
1812
+ # @return [Array<Google::Apis::SpannerV1::ContextValue>]
1813
+ attr_accessor :context_values
1814
+
1815
+ # The index of the end key in indexed_keys.
1816
+ # Corresponds to the JSON property `endKeyIndex`
1817
+ # @return [Fixnum]
1818
+ attr_accessor :end_key_index
1819
+
1820
+ # A message representing a user-facing string whose value may need to be
1821
+ # translated before being displayed.
1822
+ # Corresponds to the JSON property `info`
1823
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1824
+ attr_accessor :info
1825
+
1826
+ # The number of keys this range covers.
1827
+ # Corresponds to the JSON property `keysCount`
1828
+ # @return [Fixnum]
1829
+ attr_accessor :keys_count
1830
+
1831
+ # A message representing a user-facing string whose value may need to be
1832
+ # translated before being displayed.
1833
+ # Corresponds to the JSON property `metric`
1834
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1835
+ attr_accessor :metric
1836
+
1837
+ # The index of the start key in indexed_keys.
1838
+ # Corresponds to the JSON property `startKeyIndex`
1839
+ # @return [Fixnum]
1840
+ attr_accessor :start_key_index
1841
+
1842
+ # A message representing a user-facing string whose value may need to be
1843
+ # translated before being displayed.
1844
+ # Corresponds to the JSON property `unit`
1845
+ # @return [Google::Apis::SpannerV1::LocalizedString]
1846
+ attr_accessor :unit
1847
+
1848
+ # The value of the metric.
1849
+ # Corresponds to the JSON property `value`
1850
+ # @return [Float]
1851
+ attr_accessor :value
1852
+
1853
+ def initialize(**args)
1854
+ update!(**args)
1855
+ end
1856
+
1857
+ # Update properties of this object
1858
+ def update!(**args)
1859
+ @context_values = args[:context_values] if args.key?(:context_values)
1860
+ @end_key_index = args[:end_key_index] if args.key?(:end_key_index)
1861
+ @info = args[:info] if args.key?(:info)
1862
+ @keys_count = args[:keys_count] if args.key?(:keys_count)
1863
+ @metric = args[:metric] if args.key?(:metric)
1864
+ @start_key_index = args[:start_key_index] if args.key?(:start_key_index)
1865
+ @unit = args[:unit] if args.key?(:unit)
1866
+ @value = args[:value] if args.key?(:value)
1867
+ end
1868
+ end
1869
+
1870
+ # A message representing a list of specific information for multiple key ranges.
1871
+ class KeyRangeInfos
1872
+ include Google::Apis::Core::Hashable
1873
+
1874
+ # The list individual KeyRangeInfos.
1875
+ # Corresponds to the JSON property `infos`
1876
+ # @return [Array<Google::Apis::SpannerV1::KeyRangeInfo>]
1877
+ attr_accessor :infos
1878
+
1879
+ # The total size of the list of all KeyRangeInfos. This may be larger than the
1880
+ # number of repeated messages above. If that is the case, this number may be
1881
+ # used to determine how many are not being shown.
1882
+ # Corresponds to the JSON property `totalSize`
1883
+ # @return [Fixnum]
1884
+ attr_accessor :total_size
1885
+
1886
+ def initialize(**args)
1887
+ update!(**args)
1888
+ end
1889
+
1890
+ # Update properties of this object
1891
+ def update!(**args)
1892
+ @infos = args[:infos] if args.key?(:infos)
1893
+ @total_size = args[:total_size] if args.key?(:total_size)
1894
+ end
1895
+ end
1896
+
1621
1897
  # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the
1622
1898
  # keys are expected to be in the same table or index. The keys need not be
1623
1899
  # sorted in any particular way. If the same key is specified multiple times in
@@ -1855,6 +2131,32 @@ module Google
1855
2131
  end
1856
2132
  end
1857
2133
 
2134
+ # Response method from the ListScans method.
2135
+ class ListScansResponse
2136
+ include Google::Apis::Core::Hashable
2137
+
2138
+ # Token to retrieve the next page of results, or empty if there are no more
2139
+ # results in the list.
2140
+ # Corresponds to the JSON property `nextPageToken`
2141
+ # @return [String]
2142
+ attr_accessor :next_page_token
2143
+
2144
+ # Available scans based on the list query parameters.
2145
+ # Corresponds to the JSON property `scans`
2146
+ # @return [Array<Google::Apis::SpannerV1::Scan>]
2147
+ attr_accessor :scans
2148
+
2149
+ def initialize(**args)
2150
+ update!(**args)
2151
+ end
2152
+
2153
+ # Update properties of this object
2154
+ def update!(**args)
2155
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2156
+ @scans = args[:scans] if args.key?(:scans)
2157
+ end
2158
+ end
2159
+
1858
2160
  # The response for ListSessions.
1859
2161
  class ListSessionsResponse
1860
2162
  include Google::Apis::Core::Hashable
@@ -1881,6 +2183,179 @@ module Google
1881
2183
  end
1882
2184
  end
1883
2185
 
2186
+ # A message representing a user-facing string whose value may need to be
2187
+ # translated before being displayed.
2188
+ class LocalizedString
2189
+ include Google::Apis::Core::Hashable
2190
+
2191
+ # A map of arguments used when creating the localized message. Keys represent
2192
+ # parameter names which may be used by the localized version when substituting
2193
+ # dynamic values.
2194
+ # Corresponds to the JSON property `args`
2195
+ # @return [Hash<String,String>]
2196
+ attr_accessor :args
2197
+
2198
+ # The canonical English version of this message. If no token is provided or the
2199
+ # front-end has no message associated with the token, this text will be
2200
+ # displayed as-is.
2201
+ # Corresponds to the JSON property `message`
2202
+ # @return [String]
2203
+ attr_accessor :message
2204
+
2205
+ # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be
2206
+ # unique within the service.
2207
+ # Corresponds to the JSON property `token`
2208
+ # @return [String]
2209
+ attr_accessor :token
2210
+
2211
+ def initialize(**args)
2212
+ update!(**args)
2213
+ end
2214
+
2215
+ # Update properties of this object
2216
+ def update!(**args)
2217
+ @args = args[:args] if args.key?(:args)
2218
+ @message = args[:message] if args.key?(:message)
2219
+ @token = args[:token] if args.key?(:token)
2220
+ end
2221
+ end
2222
+
2223
+ # A message representing the actual monitoring data, values for each key bucket
2224
+ # over time, of a metric.
2225
+ class Metric
2226
+ include Google::Apis::Core::Hashable
2227
+
2228
+ # The aggregation function used to aggregate each key bucket
2229
+ # Corresponds to the JSON property `aggregation`
2230
+ # @return [String]
2231
+ attr_accessor :aggregation
2232
+
2233
+ # A message representing a user-facing string whose value may need to be
2234
+ # translated before being displayed.
2235
+ # Corresponds to the JSON property `category`
2236
+ # @return [Google::Apis::SpannerV1::LocalizedString]
2237
+ attr_accessor :category
2238
+
2239
+ # A message representing a derived metric.
2240
+ # Corresponds to the JSON property `derived`
2241
+ # @return [Google::Apis::SpannerV1::DerivedMetric]
2242
+ attr_accessor :derived
2243
+
2244
+ # A message representing a user-facing string whose value may need to be
2245
+ # translated before being displayed.
2246
+ # Corresponds to the JSON property `displayLabel`
2247
+ # @return [Google::Apis::SpannerV1::LocalizedString]
2248
+ attr_accessor :display_label
2249
+
2250
+ # Whether the metric has any non-zero data.
2251
+ # Corresponds to the JSON property `hasNonzeroData`
2252
+ # @return [Boolean]
2253
+ attr_accessor :has_nonzero_data
2254
+ alias_method :has_nonzero_data?, :has_nonzero_data
2255
+
2256
+ # The value that is considered hot for the metric. On a per metric basis hotness
2257
+ # signals high utilization and something that might potentially be a cause for
2258
+ # concern by the end user. hot_value is used to calibrate and scale visual color
2259
+ # scales.
2260
+ # Corresponds to the JSON property `hotValue`
2261
+ # @return [Float]
2262
+ attr_accessor :hot_value
2263
+
2264
+ # The (sparse) mapping from time index to an IndexedHotKey message, representing
2265
+ # those time intervals for which there are hot keys.
2266
+ # Corresponds to the JSON property `indexedHotKeys`
2267
+ # @return [Hash<String,Google::Apis::SpannerV1::IndexedHotKey>]
2268
+ attr_accessor :indexed_hot_keys
2269
+
2270
+ # The (sparse) mapping from time interval index to an IndexedKeyRangeInfos
2271
+ # message, representing those time intervals for which there are informational
2272
+ # messages concerning key ranges.
2273
+ # Corresponds to the JSON property `indexedKeyRangeInfos`
2274
+ # @return [Hash<String,Google::Apis::SpannerV1::IndexedKeyRangeInfos>]
2275
+ attr_accessor :indexed_key_range_infos
2276
+
2277
+ # A message representing a user-facing string whose value may need to be
2278
+ # translated before being displayed.
2279
+ # Corresponds to the JSON property `info`
2280
+ # @return [Google::Apis::SpannerV1::LocalizedString]
2281
+ attr_accessor :info
2282
+
2283
+ # A message representing a matrix of floats.
2284
+ # Corresponds to the JSON property `matrix`
2285
+ # @return [Google::Apis::SpannerV1::MetricMatrix]
2286
+ attr_accessor :matrix
2287
+
2288
+ # A message representing a user-facing string whose value may need to be
2289
+ # translated before being displayed.
2290
+ # Corresponds to the JSON property `unit`
2291
+ # @return [Google::Apis::SpannerV1::LocalizedString]
2292
+ attr_accessor :unit
2293
+
2294
+ # Whether the metric is visible to the end user.
2295
+ # Corresponds to the JSON property `visible`
2296
+ # @return [Boolean]
2297
+ attr_accessor :visible
2298
+ alias_method :visible?, :visible
2299
+
2300
+ def initialize(**args)
2301
+ update!(**args)
2302
+ end
2303
+
2304
+ # Update properties of this object
2305
+ def update!(**args)
2306
+ @aggregation = args[:aggregation] if args.key?(:aggregation)
2307
+ @category = args[:category] if args.key?(:category)
2308
+ @derived = args[:derived] if args.key?(:derived)
2309
+ @display_label = args[:display_label] if args.key?(:display_label)
2310
+ @has_nonzero_data = args[:has_nonzero_data] if args.key?(:has_nonzero_data)
2311
+ @hot_value = args[:hot_value] if args.key?(:hot_value)
2312
+ @indexed_hot_keys = args[:indexed_hot_keys] if args.key?(:indexed_hot_keys)
2313
+ @indexed_key_range_infos = args[:indexed_key_range_infos] if args.key?(:indexed_key_range_infos)
2314
+ @info = args[:info] if args.key?(:info)
2315
+ @matrix = args[:matrix] if args.key?(:matrix)
2316
+ @unit = args[:unit] if args.key?(:unit)
2317
+ @visible = args[:visible] if args.key?(:visible)
2318
+ end
2319
+ end
2320
+
2321
+ # A message representing a matrix of floats.
2322
+ class MetricMatrix
2323
+ include Google::Apis::Core::Hashable
2324
+
2325
+ # The rows of the matrix.
2326
+ # Corresponds to the JSON property `rows`
2327
+ # @return [Array<Google::Apis::SpannerV1::MetricMatrixRow>]
2328
+ attr_accessor :rows
2329
+
2330
+ def initialize(**args)
2331
+ update!(**args)
2332
+ end
2333
+
2334
+ # Update properties of this object
2335
+ def update!(**args)
2336
+ @rows = args[:rows] if args.key?(:rows)
2337
+ end
2338
+ end
2339
+
2340
+ # A message representing a row of a matrix of floats.
2341
+ class MetricMatrixRow
2342
+ include Google::Apis::Core::Hashable
2343
+
2344
+ # The columns of the row.
2345
+ # Corresponds to the JSON property `cols`
2346
+ # @return [Array<Float>]
2347
+ attr_accessor :cols
2348
+
2349
+ def initialize(**args)
2350
+ update!(**args)
2351
+ end
2352
+
2353
+ # Update properties of this object
2354
+ def update!(**args)
2355
+ @cols = args[:cols] if args.key?(:cols)
2356
+ end
2357
+ end
2358
+
1884
2359
  # A modification to one or more Cloud Spanner rows. Mutations can be applied to
1885
2360
  # a Cloud Spanner database by sending them in a Commit call.
1886
2361
  class Mutation
@@ -2489,22 +2964,87 @@ module Google
2489
2964
  end
2490
2965
  end
2491
2966
 
2967
+ # A message representing a key prefix node in the key prefix hierarchy. for eg.
2968
+ # Bigtable keyspaces are lexicographically ordered mappings of keys to values.
2969
+ # Keys often have a shared prefix structure where users use the keys to organize
2970
+ # data. Eg ///employee In this case Keysight will possibly use one node for a
2971
+ # company and reuse it for all employees that fall under the company. Doing so
2972
+ # improves legibility in the UI.
2973
+ class PrefixNode
2974
+ include Google::Apis::Core::Hashable
2975
+
2976
+ # Whether this corresponds to a data_source name.
2977
+ # Corresponds to the JSON property `dataSourceNode`
2978
+ # @return [Boolean]
2979
+ attr_accessor :data_source_node
2980
+ alias_method :data_source_node?, :data_source_node
2981
+
2982
+ # The depth in the prefix hierarchy.
2983
+ # Corresponds to the JSON property `depth`
2984
+ # @return [Fixnum]
2985
+ attr_accessor :depth
2986
+
2987
+ # The index of the end key bucket of the range that this node spans.
2988
+ # Corresponds to the JSON property `endIndex`
2989
+ # @return [Fixnum]
2990
+ attr_accessor :end_index
2991
+
2992
+ # The index of the start key bucket of the range that this node spans.
2993
+ # Corresponds to the JSON property `startIndex`
2994
+ # @return [Fixnum]
2995
+ attr_accessor :start_index
2996
+
2997
+ # The string represented by the prefix node.
2998
+ # Corresponds to the JSON property `word`
2999
+ # @return [String]
3000
+ attr_accessor :word
3001
+
3002
+ def initialize(**args)
3003
+ update!(**args)
3004
+ end
3005
+
3006
+ # Update properties of this object
3007
+ def update!(**args)
3008
+ @data_source_node = args[:data_source_node] if args.key?(:data_source_node)
3009
+ @depth = args[:depth] if args.key?(:depth)
3010
+ @end_index = args[:end_index] if args.key?(:end_index)
3011
+ @start_index = args[:start_index] if args.key?(:start_index)
3012
+ @word = args[:word] if args.key?(:word)
3013
+ end
3014
+ end
3015
+
2492
3016
  # Query optimizer configuration.
2493
3017
  class QueryOptions
2494
3018
  include Google::Apis::Core::Hashable
2495
3019
 
3020
+ # An option to control the selection of optimizer statistics package. This
3021
+ # parameter allows individual queries to use a different query optimizer
3022
+ # statistics package. Specifying `latest` as a value instructs Cloud Spanner to
3023
+ # use the latest generated statistics package. If not specified, Cloud Spanner
3024
+ # uses the statistics package set at the database level options, or the latest
3025
+ # package if the database option is not set. The statistics package requested by
3026
+ # the query has to be exempt from garbage collection. This can be achieved with
3027
+ # the following DDL statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false)
3028
+ # ``` The list of available statistics packages can be queried from `
3029
+ # INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an
3030
+ # invalid optimizer statistics package or with a statistics package that allows
3031
+ # garbage collection fails with an `INVALID_ARGUMENT` error.
3032
+ # Corresponds to the JSON property `optimizerStatisticsPackage`
3033
+ # @return [String]
3034
+ attr_accessor :optimizer_statistics_package
3035
+
2496
3036
  # An option to control the selection of optimizer version. This parameter allows
2497
- # individual queries to pick different query optimizer versions. Specifying "
2498
- # latest" as a value instructs Cloud Spanner to use the latest supported query
2499
- # optimizer version. If not specified, Cloud Spanner uses optimizer version set
2500
- # at the database level options. Any other positive integer (from the list of
2501
- # supported optimizer versions) overrides the default optimizer version for
3037
+ # individual queries to pick different query optimizer versions. Specifying `
3038
+ # latest` as a value instructs Cloud Spanner to use the latest supported query
3039
+ # optimizer version. If not specified, Cloud Spanner uses the optimizer version
3040
+ # set at the database level options. Any other positive integer (from the list
3041
+ # of supported optimizer versions) overrides the default optimizer version for
2502
3042
  # query execution. The list of supported optimizer versions can be queried from
2503
3043
  # SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an
2504
- # invalid optimizer version will fail with a syntax error (`INVALID_ARGUMENT`)
2505
- # status. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-
2506
- # optimizer for more information on managing the query optimizer. The `
2507
- # optimizer_version` statement hint has precedence over this setting.
3044
+ # invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://
3045
+ # cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more
3046
+ # information on managing the query optimizer. The `optimizer_version` statement
3047
+ # hint has precedence over this setting.
2508
3048
  # Corresponds to the JSON property `optimizerVersion`
2509
3049
  # @return [String]
2510
3050
  attr_accessor :optimizer_version
@@ -2515,6 +3055,7 @@ module Google
2515
3055
 
2516
3056
  # Update properties of this object
2517
3057
  def update!(**args)
3058
+ @optimizer_statistics_package = args[:optimizer_statistics_package] if args.key?(:optimizer_statistics_package)
2518
3059
  @optimizer_version = args[:optimizer_version] if args.key?(:optimizer_version)
2519
3060
  end
2520
3061
  end
@@ -2657,6 +3198,11 @@ module Google
2657
3198
  # @return [String]
2658
3199
  attr_accessor :partition_token
2659
3200
 
3201
+ # Common request options for various APIs.
3202
+ # Corresponds to the JSON property `requestOptions`
3203
+ # @return [Google::Apis::SpannerV1::RequestOptions]
3204
+ attr_accessor :request_options
3205
+
2660
3206
  # If this request is resuming a previously interrupted read, `resume_token`
2661
3207
  # should be copied from the last PartialResultSet yielded before the
2662
3208
  # interruption. Doing this enables the new read to resume where the last read
@@ -2689,6 +3235,7 @@ module Google
2689
3235
  @key_set = args[:key_set] if args.key?(:key_set)
2690
3236
  @limit = args[:limit] if args.key?(:limit)
2691
3237
  @partition_token = args[:partition_token] if args.key?(:partition_token)
3238
+ @request_options = args[:request_options] if args.key?(:request_options)
2692
3239
  @resume_token = args[:resume_token] if args.key?(:resume_token)
2693
3240
  @table = args[:table] if args.key?(:table)
2694
3241
  @transaction = args[:transaction] if args.key?(:transaction)
@@ -2743,6 +3290,50 @@ module Google
2743
3290
  end
2744
3291
  end
2745
3292
 
3293
+ # Common request options for various APIs.
3294
+ class RequestOptions
3295
+ include Google::Apis::Core::Hashable
3296
+
3297
+ # Priority for the request.
3298
+ # Corresponds to the JSON property `priority`
3299
+ # @return [String]
3300
+ attr_accessor :priority
3301
+
3302
+ # A per-request tag which can be applied to queries or reads, used for
3303
+ # statistics collection. Both request_tag and transaction_tag can be specified
3304
+ # for a read or query that belongs to a transaction. This field is ignored for
3305
+ # requests where it's not applicable (e.g. CommitRequest). Legal characters for `
3306
+ # request_tag` values are all printable characters (ASCII 32 - 126) and the
3307
+ # length of a request_tag is limited to 50 characters. Values that exceed this
3308
+ # limit are truncated.
3309
+ # Corresponds to the JSON property `requestTag`
3310
+ # @return [String]
3311
+ attr_accessor :request_tag
3312
+
3313
+ # A tag used for statistics collection about this transaction. Both request_tag
3314
+ # and transaction_tag can be specified for a read or query that belongs to a
3315
+ # transaction. The value of transaction_tag should be the same for all requests
3316
+ # belonging to the same transaction. If this request doesn’t belong to any
3317
+ # transaction, transaction_tag will be ignored. Legal characters for `
3318
+ # transaction_tag` values are all printable characters (ASCII 32 - 126) and the
3319
+ # length of a transaction_tag is limited to 50 characters. Values that exceed
3320
+ # this limit are truncated.
3321
+ # Corresponds to the JSON property `transactionTag`
3322
+ # @return [String]
3323
+ attr_accessor :transaction_tag
3324
+
3325
+ def initialize(**args)
3326
+ update!(**args)
3327
+ end
3328
+
3329
+ # Update properties of this object
3330
+ def update!(**args)
3331
+ @priority = args[:priority] if args.key?(:priority)
3332
+ @request_tag = args[:request_tag] if args.key?(:request_tag)
3333
+ @transaction_tag = args[:transaction_tag] if args.key?(:transaction_tag)
3334
+ end
3335
+ end
3336
+
2746
3337
  # Encryption configuration for the restored database.
2747
3338
  class RestoreDatabaseEncryptionConfig
2748
3339
  include Google::Apis::Core::Hashable
@@ -3013,6 +3604,87 @@ module Google
3013
3604
  end
3014
3605
  end
3015
3606
 
3607
+ # Scan is a structure which describes Cloud Key Visualizer scan information.
3608
+ class Scan
3609
+ include Google::Apis::Core::Hashable
3610
+
3611
+ # Additional information provided by the implementer.
3612
+ # Corresponds to the JSON property `details`
3613
+ # @return [Hash<String,Object>]
3614
+ attr_accessor :details
3615
+
3616
+ # The upper bound for when the scan is defined.
3617
+ # Corresponds to the JSON property `endTime`
3618
+ # @return [String]
3619
+ attr_accessor :end_time
3620
+
3621
+ # The unique name of the scan, specific to the Database service implementing
3622
+ # this interface.
3623
+ # Corresponds to the JSON property `name`
3624
+ # @return [String]
3625
+ attr_accessor :name
3626
+
3627
+ # ScanData contains Cloud Key Visualizer scan data used by the caller to
3628
+ # construct a visualization.
3629
+ # Corresponds to the JSON property `scanData`
3630
+ # @return [Google::Apis::SpannerV1::ScanData]
3631
+ attr_accessor :scan_data
3632
+
3633
+ # A range of time (inclusive) for when the scan is defined. The lower bound for
3634
+ # when the scan is defined.
3635
+ # Corresponds to the JSON property `startTime`
3636
+ # @return [String]
3637
+ attr_accessor :start_time
3638
+
3639
+ def initialize(**args)
3640
+ update!(**args)
3641
+ end
3642
+
3643
+ # Update properties of this object
3644
+ def update!(**args)
3645
+ @details = args[:details] if args.key?(:details)
3646
+ @end_time = args[:end_time] if args.key?(:end_time)
3647
+ @name = args[:name] if args.key?(:name)
3648
+ @scan_data = args[:scan_data] if args.key?(:scan_data)
3649
+ @start_time = args[:start_time] if args.key?(:start_time)
3650
+ end
3651
+ end
3652
+
3653
+ # ScanData contains Cloud Key Visualizer scan data used by the caller to
3654
+ # construct a visualization.
3655
+ class ScanData
3656
+ include Google::Apis::Core::Hashable
3657
+
3658
+ # Cloud Key Visualizer scan data. The range of time this information covers is
3659
+ # captured via the above time range fields. Note, this field is not available to
3660
+ # the ListScans method.
3661
+ # Corresponds to the JSON property `data`
3662
+ # @return [Google::Apis::SpannerV1::VisualizationData]
3663
+ attr_accessor :data
3664
+
3665
+ # The upper bound for when the contained data is defined.
3666
+ # Corresponds to the JSON property `endTime`
3667
+ # @return [String]
3668
+ attr_accessor :end_time
3669
+
3670
+ # A range of time (inclusive) for when the contained data is defined. The lower
3671
+ # bound for when the contained data is defined.
3672
+ # Corresponds to the JSON property `startTime`
3673
+ # @return [String]
3674
+ attr_accessor :start_time
3675
+
3676
+ def initialize(**args)
3677
+ update!(**args)
3678
+ end
3679
+
3680
+ # Update properties of this object
3681
+ def update!(**args)
3682
+ @data = args[:data] if args.key?(:data)
3683
+ @end_time = args[:end_time] if args.key?(:end_time)
3684
+ @start_time = args[:start_time] if args.key?(:start_time)
3685
+ end
3686
+ end
3687
+
3016
3688
  # A session in the Cloud Spanner API.
3017
3689
  class Session
3018
3690
  include Google::Apis::Core::Hashable
@@ -3891,6 +4563,16 @@ module Google
3891
4563
  # @return [String]
3892
4564
  attr_accessor :database
3893
4565
 
4566
+ # The progress of the UpdateDatabaseDdl operations. Currently, only index
4567
+ # creation statements will have a continuously updating progress. For non-index
4568
+ # creation statements, `progress[i]` will have start time and end time populated
4569
+ # with commit timestamp of operation, as well as a progress of 100% once the
4570
+ # operation has completed. `progress[i]` is the operation progress for `
4571
+ # statements[i]`.
4572
+ # Corresponds to the JSON property `progress`
4573
+ # @return [Array<Google::Apis::SpannerV1::OperationProgress>]
4574
+ attr_accessor :progress
4575
+
3894
4576
  # For an update this list contains all the statements. For an individual
3895
4577
  # statement, this list contains only that statement.
3896
4578
  # Corresponds to the JSON property `statements`
@@ -3913,6 +4595,7 @@ module Google
3913
4595
  def update!(**args)
3914
4596
  @commit_timestamps = args[:commit_timestamps] if args.key?(:commit_timestamps)
3915
4597
  @database = args[:database] if args.key?(:database)
4598
+ @progress = args[:progress] if args.key?(:progress)
3916
4599
  @statements = args[:statements] if args.key?(:statements)
3917
4600
  @throttled = args[:throttled] if args.key?(:throttled)
3918
4601
  end
@@ -4028,6 +4711,84 @@ module Google
4028
4711
  end
4029
4712
  end
4030
4713
 
4714
+ #
4715
+ class VisualizationData
4716
+ include Google::Apis::Core::Hashable
4717
+
4718
+ # The token signifying the end of a data_source.
4719
+ # Corresponds to the JSON property `dataSourceEndToken`
4720
+ # @return [String]
4721
+ attr_accessor :data_source_end_token
4722
+
4723
+ # The token delimiting a datasource name from the rest of a key in a data_source.
4724
+ # Corresponds to the JSON property `dataSourceSeparatorToken`
4725
+ # @return [String]
4726
+ attr_accessor :data_source_separator_token
4727
+
4728
+ # The list of messages (info, alerts, ...)
4729
+ # Corresponds to the JSON property `diagnosticMessages`
4730
+ # @return [Array<Google::Apis::SpannerV1::DiagnosticMessage>]
4731
+ attr_accessor :diagnostic_messages
4732
+
4733
+ # We discretize the entire keyspace into buckets. Assuming each bucket has an
4734
+ # inclusive keyrange and covers keys from k(i) ... k(n). In this case k(n) would
4735
+ # be an end key for a given range. end_key_string is the collection of all such
4736
+ # end keys
4737
+ # Corresponds to the JSON property `endKeyStrings`
4738
+ # @return [Array<String>]
4739
+ attr_accessor :end_key_strings
4740
+
4741
+ # Whether this scan contains PII.
4742
+ # Corresponds to the JSON property `hasPii`
4743
+ # @return [Boolean]
4744
+ attr_accessor :has_pii
4745
+ alias_method :has_pii?, :has_pii
4746
+
4747
+ # Keys of key ranges that contribute significantly to a given metric Can be
4748
+ # thought of as heavy hitters.
4749
+ # Corresponds to the JSON property `indexedKeys`
4750
+ # @return [Array<String>]
4751
+ attr_accessor :indexed_keys
4752
+
4753
+ # The token delimiting the key prefixes.
4754
+ # Corresponds to the JSON property `keySeparator`
4755
+ # @return [String]
4756
+ attr_accessor :key_separator
4757
+
4758
+ # The unit for the key: e.g. 'key' or 'chunk'.
4759
+ # Corresponds to the JSON property `keyUnit`
4760
+ # @return [String]
4761
+ attr_accessor :key_unit
4762
+
4763
+ # The list of data objects for each metric.
4764
+ # Corresponds to the JSON property `metrics`
4765
+ # @return [Array<Google::Apis::SpannerV1::Metric>]
4766
+ attr_accessor :metrics
4767
+
4768
+ # The list of extracted key prefix nodes used in the key prefix hierarchy.
4769
+ # Corresponds to the JSON property `prefixNodes`
4770
+ # @return [Array<Google::Apis::SpannerV1::PrefixNode>]
4771
+ attr_accessor :prefix_nodes
4772
+
4773
+ def initialize(**args)
4774
+ update!(**args)
4775
+ end
4776
+
4777
+ # Update properties of this object
4778
+ def update!(**args)
4779
+ @data_source_end_token = args[:data_source_end_token] if args.key?(:data_source_end_token)
4780
+ @data_source_separator_token = args[:data_source_separator_token] if args.key?(:data_source_separator_token)
4781
+ @diagnostic_messages = args[:diagnostic_messages] if args.key?(:diagnostic_messages)
4782
+ @end_key_strings = args[:end_key_strings] if args.key?(:end_key_strings)
4783
+ @has_pii = args[:has_pii] if args.key?(:has_pii)
4784
+ @indexed_keys = args[:indexed_keys] if args.key?(:indexed_keys)
4785
+ @key_separator = args[:key_separator] if args.key?(:key_separator)
4786
+ @key_unit = args[:key_unit] if args.key?(:key_unit)
4787
+ @metrics = args[:metrics] if args.key?(:metrics)
4788
+ @prefix_nodes = args[:prefix_nodes] if args.key?(:prefix_nodes)
4789
+ end
4790
+ end
4791
+
4031
4792
  # Arguments to insert, update, insert_or_update, and replace operations.
4032
4793
  class Write
4033
4794
  include Google::Apis::Core::Hashable