google-cloud-spanner-v1 0.12.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80f73bcf0c62d9e0ac8b3180009f47be2bfdd94e4bb8257c5b1d0069fe8f9b77
4
- data.tar.gz: c820527330eba17eb8cb8cf57e6bd86316fd02173ef08e636afda74b8e583741
3
+ metadata.gz: 92a64954268d5d45e8155b8de772e2f357b6da8cbcd995f8047031d7aafe0259
4
+ data.tar.gz: fefeb3c5b5fd44834aa58e18e7570969e67d56eb9d4abeb1f666e361e4163626
5
5
  SHA512:
6
- metadata.gz: 40aadd7fb3c257b75747a38915e60549d4a3ab7088dc7464d6a5be497bc8d38eb6bb8b5f6d2a6c6dd9201478644b25cb30709caa71507efa3cb382879f989a29
7
- data.tar.gz: b4089e4023583b4d4cf99551b75056a1eb5c732c87e71506902a1355a4c4366c766aaa81c32500867075e1b128ffb02b701535ed825ad2017f3b9225688273fe
6
+ metadata.gz: 24f0226596c8760e608b4e75937f5b8ea2c8c53cf48a2f8a47cdbebccd8195fb16b493395317e7d95793b34d3f172668fe77aa01c8cdc23c42b872f2c56a119a
7
+ data.tar.gz: c612718e4fea858d0e7058d48edf21bb9680db30023e156b077c6032efcc580f92af8f7034378c0baa9dfc3406c150880f738115636316220fbd57d47006b4fb
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Ruby Client for the Cloud Spanner V1 API
2
2
 
3
- API Client library for the Cloud Spanner V1 API
3
+ Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
4
4
 
5
5
  Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
6
6
 
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
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/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
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
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
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
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -563,13 +563,11 @@ module Google
563
563
  # # Call the list_sessions method.
564
564
  # result = client.list_sessions request
565
565
  #
566
- # # The returned object is of type Gapic::PagedEnumerable. You can
567
- # # iterate over all elements by calling #each, and the enumerable
568
- # # will lazily make API calls to fetch subsequent pages. Other
569
- # # methods are also available for managing paging directly.
570
- # result.each do |response|
566
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
567
+ # # over elements, and API calls will be issued to fetch pages as needed.
568
+ # result.each do |item|
571
569
  # # Each element is of type ::Google::Cloud::Spanner::V1::Session.
572
- # p response
570
+ # p item
573
571
  # end
574
572
  #
575
573
  def list_sessions request, options = nil
@@ -724,7 +722,7 @@ module Google
724
722
  # @param options [::Gapic::CallOptions, ::Hash]
725
723
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
726
724
  #
727
- # @overload execute_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil)
725
+ # @overload execute_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil, data_boost_enabled: nil)
728
726
  # Pass arguments to `execute_sql` via keyword arguments. Note that at
729
727
  # least one keyword argument is required. To specify no parameters, or to keep all
730
728
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -798,6 +796,12 @@ module Google
798
796
  # Query optimizer configuration to use for the given query.
799
797
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
800
798
  # Common options for this request.
799
+ # @param data_boost_enabled [::Boolean]
800
+ # If this is for a partitioned read and this field is set to `true`, the
801
+ # request will be executed via Spanner independent compute resources.
802
+ #
803
+ # If the field is set to `true` but the request does not set
804
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
801
805
  #
802
806
  # @yield [response, operation] Access the result along with the RPC operation
803
807
  # @yieldparam response [::Google::Cloud::Spanner::V1::ResultSet]
@@ -880,7 +884,7 @@ module Google
880
884
  # @param options [::Gapic::CallOptions, ::Hash]
881
885
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
882
886
  #
883
- # @overload execute_streaming_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil)
887
+ # @overload execute_streaming_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil, data_boost_enabled: nil)
884
888
  # Pass arguments to `execute_streaming_sql` via keyword arguments. Note that at
885
889
  # least one keyword argument is required. To specify no parameters, or to keep all
886
890
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -954,6 +958,12 @@ module Google
954
958
  # Query optimizer configuration to use for the given query.
955
959
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
956
960
  # Common options for this request.
961
+ # @param data_boost_enabled [::Boolean]
962
+ # If this is for a partitioned read and this field is set to `true`, the
963
+ # request will be executed via Spanner independent compute resources.
964
+ #
965
+ # If the field is set to `true` but the request does not set
966
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
957
967
  #
958
968
  # @yield [response, operation] Access the result along with the RPC operation
959
969
  # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>]
@@ -972,13 +982,13 @@ module Google
972
982
  # # Create a request. To set request fields, pass in keyword arguments.
973
983
  # request = Google::Cloud::Spanner::V1::ExecuteSqlRequest.new
974
984
  #
975
- # # Call the execute_streaming_sql method.
976
- # result = client.execute_streaming_sql request
985
+ # # Call the execute_streaming_sql method to start streaming.
986
+ # output = client.execute_streaming_sql request
977
987
  #
978
- # # The returned object is a streamed enumerable yielding elements of
979
- # # type ::Google::Cloud::Spanner::V1::PartialResultSet.
980
- # result.each do |response|
981
- # p response
988
+ # # The returned object is a streamed enumerable yielding elements of type
989
+ # # ::Google::Cloud::Spanner::V1::PartialResultSet
990
+ # output.each do |current_response|
991
+ # p current_response
982
992
  # end
983
993
  #
984
994
  def execute_streaming_sql request, options = nil
@@ -1166,7 +1176,7 @@ module Google
1166
1176
  # @param options [::Gapic::CallOptions, ::Hash]
1167
1177
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1168
1178
  #
1169
- # @overload read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil)
1179
+ # @overload read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil, data_boost_enabled: nil)
1170
1180
  # Pass arguments to `read` via keyword arguments. Note that at
1171
1181
  # least one keyword argument is required. To specify no parameters, or to keep all
1172
1182
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1216,6 +1226,12 @@ module Google
1216
1226
  # PartitionReadRequest message used to create this partition_token.
1217
1227
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
1218
1228
  # Common options for this request.
1229
+ # @param data_boost_enabled [::Boolean]
1230
+ # If this is for a partitioned query and this field is set to `true`, the
1231
+ # request will be executed via Spanner independent compute resources.
1232
+ #
1233
+ # If the field is set to `true` but the request does not set
1234
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
1219
1235
  #
1220
1236
  # @yield [response, operation] Access the result along with the RPC operation
1221
1237
  # @yieldparam response [::Google::Cloud::Spanner::V1::ResultSet]
@@ -1298,7 +1314,7 @@ module Google
1298
1314
  # @param options [::Gapic::CallOptions, ::Hash]
1299
1315
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1300
1316
  #
1301
- # @overload streaming_read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil)
1317
+ # @overload streaming_read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil, data_boost_enabled: nil)
1302
1318
  # Pass arguments to `streaming_read` via keyword arguments. Note that at
1303
1319
  # least one keyword argument is required. To specify no parameters, or to keep all
1304
1320
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1348,6 +1364,12 @@ module Google
1348
1364
  # PartitionReadRequest message used to create this partition_token.
1349
1365
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
1350
1366
  # Common options for this request.
1367
+ # @param data_boost_enabled [::Boolean]
1368
+ # If this is for a partitioned query and this field is set to `true`, the
1369
+ # request will be executed via Spanner independent compute resources.
1370
+ #
1371
+ # If the field is set to `true` but the request does not set
1372
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
1351
1373
  #
1352
1374
  # @yield [response, operation] Access the result along with the RPC operation
1353
1375
  # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>]
@@ -1366,13 +1388,13 @@ module Google
1366
1388
  # # Create a request. To set request fields, pass in keyword arguments.
1367
1389
  # request = Google::Cloud::Spanner::V1::ReadRequest.new
1368
1390
  #
1369
- # # Call the streaming_read method.
1370
- # result = client.streaming_read request
1391
+ # # Call the streaming_read method to start streaming.
1392
+ # output = client.streaming_read request
1371
1393
  #
1372
- # # The returned object is a streamed enumerable yielding elements of
1373
- # # type ::Google::Cloud::Spanner::V1::PartialResultSet.
1374
- # result.each do |response|
1375
- # p response
1394
+ # # The returned object is a streamed enumerable yielding elements of type
1395
+ # # ::Google::Cloud::Spanner::V1::PartialResultSet
1396
+ # output.each do |current_response|
1397
+ # p current_response
1376
1398
  # end
1377
1399
  #
1378
1400
  def streaming_read request, options = nil
@@ -36,7 +36,7 @@ module Google
36
36
  # The Cloud Spanner API can be used to manage sessions and execute
37
37
  # transactions on data stored in Cloud Spanner databases.
38
38
  #
39
- # To load this service and instantiate a client:
39
+ # @example Load this service and instantiate a gRPC client
40
40
  #
41
41
  # require "google/cloud/spanner/v1/spanner"
42
42
  # client = ::Google::Cloud::Spanner::V1::Spanner::Client.new
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Spanner
23
23
  module V1
24
- VERSION = "0.12.0"
24
+ VERSION = "0.14.0"
25
25
  end
26
26
  end
27
27
  end
@@ -23,9 +23,9 @@ module Google
23
23
  module Cloud
24
24
  module Spanner
25
25
  ##
26
- # To load this package, including all its services, and instantiate a client:
26
+ # API client module.
27
27
  #
28
- # @example
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
29
  #
30
30
  # require "google/cloud/spanner/v1"
31
31
  # client = ::Google::Cloud::Spanner::V1::Spanner::Client.new
@@ -78,6 +78,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
78
78
  optional :seqno, :int64, 9
79
79
  optional :query_options, :message, 10, "google.spanner.v1.ExecuteSqlRequest.QueryOptions"
80
80
  optional :request_options, :message, 11, "google.spanner.v1.RequestOptions"
81
+ optional :data_boost_enabled, :bool, 15
81
82
  end
82
83
  add_message "google.spanner.v1.ExecuteSqlRequest.QueryOptions" do
83
84
  optional :optimizer_version, :string, 1
@@ -143,6 +144,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
143
144
  optional :resume_token, :bytes, 9
144
145
  optional :partition_token, :bytes, 10
145
146
  optional :request_options, :message, 11, "google.spanner.v1.RequestOptions"
147
+ optional :data_boost_enabled, :bool, 16
146
148
  end
147
149
  add_message "google.spanner.v1.BeginTransactionRequest" do
148
150
  optional :session, :string, 1
@@ -16,6 +16,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  end
17
17
  end
18
18
  add_message "google.spanner.v1.TransactionOptions.ReadWrite" do
19
+ optional :read_lock_mode, :enum, 1, "google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode"
20
+ end
21
+ add_enum "google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode" do
22
+ value :READ_LOCK_MODE_UNSPECIFIED, 0
23
+ value :PESSIMISTIC, 1
24
+ value :OPTIMISTIC, 2
19
25
  end
20
26
  add_message "google.spanner.v1.TransactionOptions.PartitionedDml" do
21
27
  end
@@ -49,6 +55,7 @@ module Google
49
55
  module V1
50
56
  TransactionOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions").msgclass
51
57
  TransactionOptions::ReadWrite = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.ReadWrite").msgclass
58
+ TransactionOptions::ReadWrite::ReadLockMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode").enummodule
52
59
  TransactionOptions::PartitionedDml = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.PartitionedDml").msgclass
53
60
  TransactionOptions::ReadOnly = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.TransactionOptions.ReadOnly").msgclass
54
61
  Transaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.Transaction").msgclass
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
@@ -308,6 +308,13 @@ module Google
308
308
  # @!attribute [rw] request_options
309
309
  # @return [::Google::Cloud::Spanner::V1::RequestOptions]
310
310
  # Common options for this request.
311
+ # @!attribute [rw] data_boost_enabled
312
+ # @return [::Boolean]
313
+ # If this is for a partitioned read and this field is set to `true`, the
314
+ # request will be executed via Spanner independent compute resources.
315
+ #
316
+ # If the field is set to `true` but the request does not set
317
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
311
318
  class ExecuteSqlRequest
312
319
  include ::Google::Protobuf::MessageExts
313
320
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -718,6 +725,13 @@ module Google
718
725
  # @!attribute [rw] request_options
719
726
  # @return [::Google::Cloud::Spanner::V1::RequestOptions]
720
727
  # Common options for this request.
728
+ # @!attribute [rw] data_boost_enabled
729
+ # @return [::Boolean]
730
+ # If this is for a partitioned query and this field is set to `true`, the
731
+ # request will be executed via Spanner independent compute resources.
732
+ #
733
+ # If the field is set to `true` but the request does not set
734
+ # `partition_token`, the API will return an `INVALID_ARGUMENT` error.
721
735
  class ReadRequest
722
736
  include ::Google::Protobuf::MessageExts
723
737
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -50,7 +50,8 @@ module Google
50
50
  #
51
51
  # Queries on change streams must be performed with the snapshot read-only
52
52
  # transaction mode, specifying a strong read. Please see
53
- # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#strong TransactionOptions.ReadOnly.strong} for more details.
53
+ # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#strong TransactionOptions.ReadOnly.strong}
54
+ # for more details.
54
55
  #
55
56
  # 3. Partitioned DML. This type of transaction is used to execute
56
57
  # a single Partitioned DML statement. Partitioned DML partitions
@@ -186,7 +187,8 @@ module Google
186
187
  # Queries on change streams (see below for more details) must also specify
187
188
  # the strong read timestamp bound.
188
189
  #
189
- # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#strong TransactionOptions.ReadOnly.strong}.
190
+ # See
191
+ # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#strong TransactionOptions.ReadOnly.strong}.
190
192
  #
191
193
  # Exact staleness:
192
194
  #
@@ -207,7 +209,9 @@ module Google
207
209
  # equivalent boundedly stale concurrency modes. On the other hand,
208
210
  # boundedly stale reads usually return fresher results.
209
211
  #
210
- # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#read_timestamp TransactionOptions.ReadOnly.read_timestamp} and
212
+ # See
213
+ # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#read_timestamp TransactionOptions.ReadOnly.read_timestamp}
214
+ # and
211
215
  # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#exact_staleness TransactionOptions.ReadOnly.exact_staleness}.
212
216
  #
213
217
  # Bounded staleness:
@@ -237,7 +241,9 @@ module Google
237
241
  # which rows will be read, it can only be used with single-use
238
242
  # read-only transactions.
239
243
  #
240
- # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#max_staleness TransactionOptions.ReadOnly.max_staleness} and
244
+ # See
245
+ # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#max_staleness TransactionOptions.ReadOnly.max_staleness}
246
+ # and
241
247
  # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#min_read_timestamp TransactionOptions.ReadOnly.min_read_timestamp}.
242
248
  #
243
249
  # Old read timestamps and garbage collection:
@@ -366,9 +372,33 @@ module Google
366
372
 
367
373
  # Message type to initiate a read-write transaction. Currently this
368
374
  # transaction type has no options.
375
+ # @!attribute [rw] read_lock_mode
376
+ # @return [::Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode]
377
+ # Read lock mode for the transaction.
369
378
  class ReadWrite
370
379
  include ::Google::Protobuf::MessageExts
371
380
  extend ::Google::Protobuf::MessageExts::ClassMethods
381
+
382
+ # `ReadLockMode` is used to set the read lock mode for read-write
383
+ # transactions.
384
+ module ReadLockMode
385
+ # Default value.
386
+ #
387
+ # If the value is not specified, the pessimistic read lock is used.
388
+ READ_LOCK_MODE_UNSPECIFIED = 0
389
+
390
+ # Pessimistic lock mode.
391
+ #
392
+ # Read locks are acquired immediately on read.
393
+ PESSIMISTIC = 1
394
+
395
+ # Optimistic lock mode.
396
+ #
397
+ # Locks for reads within the transaction are not acquired on read.
398
+ # Instead the locks are acquired on a commit to validate that
399
+ # read/queried data has not changed since the transaction started.
400
+ OPTIMISTIC = 2
401
+ end
372
402
  end
373
403
 
374
404
  # Message type to initiate a Partitioned DML transaction.
@@ -439,7 +469,8 @@ module Google
439
469
  # @!attribute [rw] return_read_timestamp
440
470
  # @return [::Boolean]
441
471
  # If true, the Cloud Spanner-selected read timestamp is included in
442
- # the {::Google::Cloud::Spanner::V1::Transaction Transaction} message that describes the transaction.
472
+ # the {::Google::Cloud::Spanner::V1::Transaction Transaction} message that describes
473
+ # the transaction.
443
474
  class ReadOnly
444
475
  include ::Google::Protobuf::MessageExts
445
476
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -474,7 +505,8 @@ module Google
474
505
  # {::Google::Cloud::Spanner::V1::Spanner::Client#read Read} or
475
506
  # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql} call runs.
476
507
  #
477
- # See {::Google::Cloud::Spanner::V1::TransactionOptions TransactionOptions} for more information about transactions.
508
+ # See {::Google::Cloud::Spanner::V1::TransactionOptions TransactionOptions} for more
509
+ # information about transactions.
478
510
  # @!attribute [rw] single_use
479
511
  # @return [::Google::Cloud::Spanner::V1::TransactionOptions]
480
512
  # Execute the read or SQL query in a temporary transaction.
@@ -487,7 +519,8 @@ module Google
487
519
  # @return [::Google::Cloud::Spanner::V1::TransactionOptions]
488
520
  # Begin a new transaction and execute this read or SQL query in
489
521
  # it. The transaction ID of the new transaction is returned in
490
- # {::Google::Cloud::Spanner::V1::ResultSetMetadata#transaction ResultSetMetadata.transaction}, which is a {::Google::Cloud::Spanner::V1::Transaction Transaction}.
522
+ # {::Google::Cloud::Spanner::V1::ResultSetMetadata#transaction ResultSetMetadata.transaction},
523
+ # which is a {::Google::Cloud::Spanner::V1::Transaction Transaction}.
491
524
  class TransactionSelector
492
525
  include ::Google::Protobuf::MessageExts
493
526
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-spanner-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.0
4
+ version: 0.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-18 00:00:00.000000000 Z
11
+ date: 2023-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.12'
19
+ version: 0.18.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.12'
29
+ version: 0.18.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,14 +50,14 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: 1.26.1
53
+ version: 1.26.3
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 1.26.1
60
+ version: 1.26.3
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: minitest
63
63
  requirement: !ruby/object:Gem::Requirement
@@ -186,7 +186,9 @@ files:
186
186
  - lib/google/spanner/v1/transaction_pb.rb
187
187
  - lib/google/spanner/v1/type_pb.rb
188
188
  - proto_docs/README.md
189
+ - proto_docs/google/api/client.rb
189
190
  - proto_docs/google/api/field_behavior.rb
191
+ - proto_docs/google/api/launch_stage.rb
190
192
  - proto_docs/google/api/resource.rb
191
193
  - proto_docs/google/protobuf/any.rb
192
194
  - proto_docs/google/protobuf/duration.rb
@@ -221,8 +223,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
221
223
  - !ruby/object:Gem::Version
222
224
  version: '0'
223
225
  requirements: []
224
- rubygems_version: 3.3.14
226
+ rubygems_version: 3.4.2
225
227
  signing_key:
226
228
  specification_version: 4
227
- summary: API Client library for the Cloud Spanner V1 API
229
+ summary: Cloud Spanner is a managed, mission-critical, globally consistent and scalable
230
+ relational database service.
228
231
  test_files: []