google-cloud-spanner 1.6.3 → 1.6.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/LOGGING.md +1 -1
  4. data/OVERVIEW.md +1 -1
  5. data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb +29 -29
  6. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/iam_policy.rb +13 -13
  7. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb +28 -28
  8. data/lib/google/cloud/spanner/admin/database/v1/doc/google/longrunning/operations.rb +9 -9
  9. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb +8 -8
  10. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb +1 -1
  11. data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb +11 -11
  12. data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb +21 -21
  13. data/lib/google/cloud/spanner/admin/database/v1.rb +4 -4
  14. data/lib/google/cloud/spanner/admin/database.rb +4 -4
  15. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb +13 -13
  16. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb +28 -28
  17. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/longrunning/operations.rb +9 -9
  18. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb +8 -8
  19. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/empty.rb +1 -1
  20. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/field_mask.rb +7 -7
  21. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb +11 -11
  22. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb +30 -30
  23. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb +44 -44
  24. data/lib/google/cloud/spanner/admin/instance/v1.rb +4 -4
  25. data/lib/google/cloud/spanner/admin/instance.rb +4 -4
  26. data/lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb +3 -3
  27. data/lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb +1 -1
  28. data/lib/google/cloud/spanner/v1/doc/google/protobuf/struct.rb +11 -11
  29. data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb +7 -7
  30. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb +19 -19
  31. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb +6 -6
  32. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb +11 -11
  33. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb +33 -19
  34. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb +65 -39
  35. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb +91 -21
  36. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb +25 -25
  37. data/lib/google/cloud/spanner/v1/spanner_client.rb +139 -79
  38. data/lib/google/cloud/spanner/version.rb +1 -1
  39. data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +1 -1
  40. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +1 -1
  41. data/lib/google/spanner/v1/result_set_pb.rb +4 -0
  42. data/lib/google/spanner/v1/spanner_pb.rb +1 -0
  43. data/lib/google/spanner/v1/spanner_services_pb.rb +14 -6
  44. data/lib/google/spanner/v1/transaction_pb.rb +4 -0
  45. data/lib/google-cloud-spanner.rb +1 -1
  46. metadata +3 -3
@@ -24,7 +24,7 @@ module Google
24
24
  # @return [String]
25
25
  # A unique identifier for the instance configuration. Values
26
26
  # are of the form
27
- # +projects/<project>/instanceConfigs/[a-z][-a-z0-9]*+
27
+ # `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`
28
28
  # @!attribute [rw] display_name
29
29
  # @return [String]
30
30
  # The name of this instance configuration as it appears in UIs.
@@ -35,12 +35,12 @@ module Google
35
35
  # @return [String]
36
36
  # Required. A unique identifier for the instance, which cannot be changed
37
37
  # after the instance is created. Values are of the form
38
- # +projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]+. The final
38
+ # `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
39
39
  # segment of the name must be between 6 and 30 characters in length.
40
40
  # @!attribute [rw] config
41
41
  # @return [String]
42
42
  # Required. The name of the instance's configuration. Values are of the form
43
- # +projects/<project>/instanceConfigs/<configuration>+. See
43
+ # `projects/<project>/instanceConfigs/<configuration>`. See
44
44
  # also {Google::Spanner::Admin::Instance::V1::InstanceConfig InstanceConfig} and
45
45
  # {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs}.
46
46
  # @!attribute [rw] display_name
@@ -50,7 +50,7 @@ module Google
50
50
  # @!attribute [rw] node_count
51
51
  # @return [Integer]
52
52
  # Required. The number of nodes allocated to this instance. This may be zero
53
- # in API responses for instances that are not yet in state +READY+.
53
+ # in API responses for instances that are not yet in state `READY`.
54
54
  #
55
55
  # See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count)
56
56
  # for more information about nodes.
@@ -58,9 +58,9 @@ module Google
58
58
  # @return [Google::Spanner::Admin::Instance::V1::Instance::State]
59
59
  # Output only. The current instance state. For
60
60
  # {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance}, the state must be
61
- # either omitted or set to +CREATING+. For
61
+ # either omitted or set to `CREATING`. For
62
62
  # {Google::Spanner::Admin::Instance::V1::InstanceAdmin::UpdateInstance UpdateInstance}, the state must be
63
- # either omitted or set to +READY+.
63
+ # either omitted or set to `READY`.
64
64
  # @!attribute [rw] labels
65
65
  # @return [Hash{String => String}]
66
66
  # Cloud Labels are a flexible and lightweight mechanism for organizing cloud
@@ -71,9 +71,9 @@ module Google
71
71
  # firewall, load balancing, etc.).
72
72
  #
73
73
  # * Label keys must be between 1 and 63 characters long and must conform to
74
- # the following regular expression: +[a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?+.
74
+ # the following regular expression: `[a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?`.
75
75
  # * Label values must be between 0 and 63 characters long and must conform
76
- # to the regular expression +([a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?)?+.
76
+ # to the regular expression `([a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?)?`.
77
77
  # * No more than 64 labels can be associated with a given resource.
78
78
  #
79
79
  # See https://goo.gl/xmQnxf for more information on and examples of labels.
@@ -106,14 +106,14 @@ module Google
106
106
  # @return [String]
107
107
  # Required. The name of the project for which a list of supported instance
108
108
  # configurations is requested. Values are of the form
109
- # +projects/<project>+.
109
+ # `projects/<project>`.
110
110
  # @!attribute [rw] page_size
111
111
  # @return [Integer]
112
112
  # Number of instance configurations to be returned in the response. If 0 or
113
113
  # less, defaults to the server's maximum allowed page size.
114
114
  # @!attribute [rw] page_token
115
115
  # @return [String]
116
- # If non-empty, +page_token+ should contain a
116
+ # If non-empty, `page_token` should contain a
117
117
  # {Google::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse#next_page_token next_page_token}
118
118
  # from a previous {Google::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse ListInstanceConfigsResponse}.
119
119
  class ListInstanceConfigsRequest; end
@@ -124,7 +124,7 @@ module Google
124
124
  # The list of requested instance configurations.
125
125
  # @!attribute [rw] next_page_token
126
126
  # @return [String]
127
- # +next_page_token+ can be sent in a subsequent
127
+ # `next_page_token` can be sent in a subsequent
128
128
  # {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs} call to
129
129
  # fetch more of the matching instance configurations.
130
130
  class ListInstanceConfigsResponse; end
@@ -134,44 +134,44 @@ module Google
134
134
  # @!attribute [rw] name
135
135
  # @return [String]
136
136
  # Required. The name of the requested instance configuration. Values are of
137
- # the form +projects/<project>/instanceConfigs/<config>+.
137
+ # the form `projects/<project>/instanceConfigs/<config>`.
138
138
  class GetInstanceConfigRequest; end
139
139
 
140
140
  # The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::GetInstance GetInstance}.
141
141
  # @!attribute [rw] name
142
142
  # @return [String]
143
143
  # Required. The name of the requested instance. Values are of the form
144
- # +projects/<project>/instances/<instance>+.
144
+ # `projects/<project>/instances/<instance>`.
145
145
  class GetInstanceRequest; end
146
146
 
147
147
  # The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance}.
148
148
  # @!attribute [rw] parent
149
149
  # @return [String]
150
150
  # Required. The name of the project in which to create the instance. Values
151
- # are of the form +projects/<project>+.
151
+ # are of the form `projects/<project>`.
152
152
  # @!attribute [rw] instance_id
153
153
  # @return [String]
154
154
  # Required. The ID of the instance to create. Valid identifiers are of the
155
- # form +[a-z][-a-z0-9]*[a-z0-9]+ and must be between 6 and 30 characters in
155
+ # form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 6 and 30 characters in
156
156
  # length.
157
157
  # @!attribute [rw] instance
158
158
  # @return [Google::Spanner::Admin::Instance::V1::Instance]
159
159
  # Required. The instance to create. The name may be omitted, but if
160
- # specified must be +<parent>/instances/<instance_id>+.
160
+ # specified must be `<parent>/instances/<instance_id>`.
161
161
  class CreateInstanceRequest; end
162
162
 
163
163
  # The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstances ListInstances}.
164
164
  # @!attribute [rw] parent
165
165
  # @return [String]
166
166
  # Required. The name of the project for which a list of instances is
167
- # requested. Values are of the form +projects/<project>+.
167
+ # requested. Values are of the form `projects/<project>`.
168
168
  # @!attribute [rw] page_size
169
169
  # @return [Integer]
170
170
  # Number of instances to be returned in the response. If 0 or less, defaults
171
171
  # to the server's maximum allowed page size.
172
172
  # @!attribute [rw] page_token
173
173
  # @return [String]
174
- # If non-empty, +page_token+ should contain a
174
+ # If non-empty, `page_token` should contain a
175
175
  # {Google::Spanner::Admin::Instance::V1::ListInstancesResponse#next_page_token next_page_token} from a
176
176
  # previous {Google::Spanner::Admin::Instance::V1::ListInstancesResponse ListInstancesResponse}.
177
177
  # @!attribute [rw] filter
@@ -179,20 +179,20 @@ module Google
179
179
  # An expression for filtering the results of the request. Filter rules are
180
180
  # case insensitive. The fields eligible for filtering are:
181
181
  #
182
- # * +name+
183
- # * +display_name+
184
- # * +labels.key+ where key is the name of a label
182
+ # * `name`
183
+ # * `display_name`
184
+ # * `labels.key` where key is the name of a label
185
185
  #
186
186
  # Some examples of using filters are:
187
187
  #
188
- # * +name:*+ --> The instance has a name.
189
- # * +name:Howl+ --> The instance's name contains the string "howl".
190
- # * +name:HOWL+ --> Equivalent to above.
191
- # * +NAME:howl+ --> Equivalent to above.
192
- # * +labels.env:*+ --> The instance has the label "env".
193
- # * +labels.env:dev+ --> The instance has the label "env" and the value of
188
+ # * `name:*` --> The instance has a name.
189
+ # * `name:Howl` --> The instance's name contains the string "howl".
190
+ # * `name:HOWL` --> Equivalent to above.
191
+ # * `NAME:howl` --> Equivalent to above.
192
+ # * `labels.env:*` --> The instance has the label "env".
193
+ # * `labels.env:dev` --> The instance has the label "env" and the value of
194
194
  # the label contains the string "dev".
195
- # * +name:howl labels.env:dev+ --> The instance's name contains "howl" and
195
+ # * `name:howl labels.env:dev` --> The instance's name contains "howl" and
196
196
  # it has the label "env" with its value
197
197
  # containing "dev".
198
198
  class ListInstancesRequest; end
@@ -203,7 +203,7 @@ module Google
203
203
  # The list of requested instances.
204
204
  # @!attribute [rw] next_page_token
205
205
  # @return [String]
206
- # +next_page_token+ can be sent in a subsequent
206
+ # `next_page_token` can be sent in a subsequent
207
207
  # {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstances ListInstances} call to fetch more
208
208
  # of the matching instances.
209
209
  class ListInstancesResponse; end
@@ -225,7 +225,7 @@ module Google
225
225
  # @!attribute [rw] name
226
226
  # @return [String]
227
227
  # Required. The name of the instance to be deleted. Values are of the form
228
- # +projects/<project>/instances/<instance>+
228
+ # `projects/<project>/instances/<instance>`
229
229
  class DeleteInstanceRequest; end
230
230
 
231
231
  # Metadata type for the operation returned by
@@ -321,7 +321,7 @@ module Google
321
321
  # @param parent [String]
322
322
  # Required. The name of the project for which a list of supported instance
323
323
  # configurations is requested. Values are of the form
324
- # +projects/<project>+.
324
+ # `projects/<project>`.
325
325
  # @param page_size [Integer]
326
326
  # The maximum number of resources contained in the underlying API
327
327
  # response. If page streaming is performed per-resource, this
@@ -376,7 +376,7 @@ module Google
376
376
  #
377
377
  # @param name [String]
378
378
  # Required. The name of the requested instance configuration. Values are of
379
- # the form +projects/<project>/instanceConfigs/<config>+.
379
+ # the form `projects/<project>/instanceConfigs/<config>`.
380
380
  # @param options [Google::Gax::CallOptions]
381
381
  # Overrides the default settings for this call, e.g, timeout,
382
382
  # retries, etc.
@@ -407,7 +407,7 @@ module Google
407
407
  #
408
408
  # @param parent [String]
409
409
  # Required. The name of the project for which a list of instances is
410
- # requested. Values are of the form +projects/<project>+.
410
+ # requested. Values are of the form `projects/<project>`.
411
411
  # @param page_size [Integer]
412
412
  # The maximum number of resources contained in the underlying API
413
413
  # response. If page streaming is performed per-resource, this
@@ -418,20 +418,20 @@ module Google
418
418
  # An expression for filtering the results of the request. Filter rules are
419
419
  # case insensitive. The fields eligible for filtering are:
420
420
  #
421
- # * +name+
422
- # * +display_name+
423
- # * +labels.key+ where key is the name of a label
421
+ # * `name`
422
+ # * `display_name`
423
+ # * `labels.key` where key is the name of a label
424
424
  #
425
425
  # Some examples of using filters are:
426
426
  #
427
- # * +name:*+ --> The instance has a name.
428
- # * +name:Howl+ --> The instance's name contains the string "howl".
429
- # * +name:HOWL+ --> Equivalent to above.
430
- # * +NAME:howl+ --> Equivalent to above.
431
- # * +labels.env:*+ --> The instance has the label "env".
432
- # * +labels.env:dev+ --> The instance has the label "env" and the value of
427
+ # * `name:*` --> The instance has a name.
428
+ # * `name:Howl` --> The instance's name contains the string "howl".
429
+ # * `name:HOWL` --> Equivalent to above.
430
+ # * `NAME:howl` --> Equivalent to above.
431
+ # * `labels.env:*` --> The instance has the label "env".
432
+ # * `labels.env:dev` --> The instance has the label "env" and the value of
433
433
  # the label contains the string "dev".
434
- # * +name:howl labels.env:dev+ --> The instance's name contains "howl" and
434
+ # * `name:howl labels.env:dev` --> The instance's name contains "howl" and
435
435
  # it has the label "env" with its value
436
436
  # containing "dev".
437
437
  # @param options [Google::Gax::CallOptions]
@@ -484,7 +484,7 @@ module Google
484
484
  #
485
485
  # @param name [String]
486
486
  # Required. The name of the requested instance. Values are of the form
487
- # +projects/<project>/instances/<instance>+.
487
+ # `projects/<project>/instances/<instance>`.
488
488
  # @param options [Google::Gax::CallOptions]
489
489
  # Overrides the default settings for this call, e.g, timeout,
490
490
  # retries, etc.
@@ -515,13 +515,13 @@ module Google
515
515
  # returned {Google::Longrunning::Operation long-running operation}
516
516
  # can be used to track the progress of preparing the new
517
517
  # instance. The instance name is assigned by the caller. If the
518
- # named instance already exists, +CreateInstance+ returns
519
- # +ALREADY_EXISTS+.
518
+ # named instance already exists, `CreateInstance` returns
519
+ # `ALREADY_EXISTS`.
520
520
  #
521
521
  # Immediately upon completion of this request:
522
522
  #
523
523
  # * The instance is readable via the API, with all requested attributes
524
- # but no allocated resources. Its state is +CREATING+.
524
+ # but no allocated resources. Its state is `CREATING`.
525
525
  #
526
526
  # Until completion of the returned operation:
527
527
  #
@@ -536,10 +536,10 @@ module Google
536
536
  # may have lower than the requested levels).
537
537
  # * Databases can be created in the instance.
538
538
  # * The instance's allocated resource levels are readable via the API.
539
- # * The instance's state becomes +READY+.
539
+ # * The instance's state becomes `READY`.
540
540
  #
541
541
  # The returned {Google::Longrunning::Operation long-running operation} will
542
- # have a name of the format +<instance_name>/operations/<operation_id>+ and
542
+ # have a name of the format `<instance_name>/operations/<operation_id>` and
543
543
  # can be used to track creation of the instance. The
544
544
  # {Google::Longrunning::Operation#metadata metadata} field type is
545
545
  # {Google::Spanner::Admin::Instance::V1::CreateInstanceMetadata CreateInstanceMetadata}.
@@ -548,14 +548,14 @@ module Google
548
548
  #
549
549
  # @param parent [String]
550
550
  # Required. The name of the project in which to create the instance. Values
551
- # are of the form +projects/<project>+.
551
+ # are of the form `projects/<project>`.
552
552
  # @param instance_id [String]
553
553
  # Required. The ID of the instance to create. Valid identifiers are of the
554
- # form +[a-z][-a-z0-9]*[a-z0-9]+ and must be between 6 and 30 characters in
554
+ # form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 6 and 30 characters in
555
555
  # length.
556
556
  # @param instance [Google::Spanner::Admin::Instance::V1::Instance | Hash]
557
557
  # Required. The instance to create. The name may be omitted, but if
558
- # specified must be +<parent>/instances/<instance_id>+.
558
+ # specified must be `<parent>/instances/<instance_id>`.
559
559
  # A hash of the same form as `Google::Spanner::Admin::Instance::V1::Instance`
560
560
  # can also be provided.
561
561
  # @param options [Google::Gax::CallOptions]
@@ -569,10 +569,10 @@ module Google
569
569
  # instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
570
570
  # formatted_parent = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.project_path("[PROJECT]")
571
571
  #
572
- # # TODO: Initialize +instance_id+:
572
+ # # TODO: Initialize `instance_id`:
573
573
  # instance_id = ''
574
574
  #
575
- # # TODO: Initialize +instance+:
575
+ # # TODO: Initialize `instance`:
576
576
  # instance = {}
577
577
  #
578
578
  # # Register a callback during the method call.
@@ -628,7 +628,7 @@ module Google
628
628
  # as requested. The returned [long-running
629
629
  # operation][google.longrunning.Operation] can be used to track the
630
630
  # progress of updating the instance. If the named instance does not
631
- # exist, returns +NOT_FOUND+.
631
+ # exist, returns `NOT_FOUND`.
632
632
  #
633
633
  # Immediately upon completion of this request:
634
634
  #
@@ -641,7 +641,7 @@ module Google
641
641
  # {Google::Spanner::Admin::Instance::V1::UpdateInstanceMetadata#cancel_time cancel_time}, and begins
642
642
  # restoring resources to their pre-request values. The operation
643
643
  # is guaranteed to succeed at undoing all resource changes,
644
- # after which point it terminates with a +CANCELLED+ status.
644
+ # after which point it terminates with a `CANCELLED` status.
645
645
  # * All other attempts to modify the instance are rejected.
646
646
  # * Reading the instance via the API continues to give the pre-request
647
647
  # resource levels.
@@ -655,14 +655,14 @@ module Google
655
655
  # * The instance's new resource levels are readable via the API.
656
656
  #
657
657
  # The returned {Google::Longrunning::Operation long-running operation} will
658
- # have a name of the format +<instance_name>/operations/<operation_id>+ and
658
+ # have a name of the format `<instance_name>/operations/<operation_id>` and
659
659
  # can be used to track the instance modification. The
660
660
  # {Google::Longrunning::Operation#metadata metadata} field type is
661
661
  # {Google::Spanner::Admin::Instance::V1::UpdateInstanceMetadata UpdateInstanceMetadata}.
662
662
  # The {Google::Longrunning::Operation#response response} field type is
663
663
  # {Google::Spanner::Admin::Instance::V1::Instance Instance}, if successful.
664
664
  #
665
- # Authorization requires +spanner.instances.update+ permission on
665
+ # Authorization requires `spanner.instances.update` permission on
666
666
  # resource {Google::Spanner::Admin::Instance::V1::Instance#name name}.
667
667
  #
668
668
  # @param instance [Google::Spanner::Admin::Instance::V1::Instance | Hash]
@@ -687,10 +687,10 @@ module Google
687
687
  #
688
688
  # instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
689
689
  #
690
- # # TODO: Initialize +instance+:
690
+ # # TODO: Initialize `instance`:
691
691
  # instance = {}
692
692
  #
693
- # # TODO: Initialize +field_mask+:
693
+ # # TODO: Initialize `field_mask`:
694
694
  # field_mask = {}
695
695
  #
696
696
  # # Register a callback during the method call.
@@ -754,7 +754,7 @@ module Google
754
754
  #
755
755
  # @param name [String]
756
756
  # Required. The name of the instance to be deleted. Values are of the form
757
- # +projects/<project>/instances/<instance>+
757
+ # `projects/<project>/instances/<instance>`
758
758
  # @param options [Google::Gax::CallOptions]
759
759
  # Overrides the default settings for this call, e.g, timeout,
760
760
  # retries, etc.
@@ -784,15 +784,15 @@ module Google
784
784
  # Sets the access control policy on an instance resource. Replaces any
785
785
  # existing policy.
786
786
  #
787
- # Authorization requires +spanner.instances.setIamPolicy+ on
787
+ # Authorization requires `spanner.instances.setIamPolicy` on
788
788
  # {Google::Iam::V1::SetIamPolicyRequest#resource resource}.
789
789
  #
790
790
  # @param resource [String]
791
791
  # REQUIRED: The resource for which the policy is being specified.
792
- # +resource+ is usually specified as a path. For example, a Project
793
- # resource is specified as +projects/\\{project}+.
792
+ # `resource` is usually specified as a path. For example, a Project
793
+ # resource is specified as `projects/{project}`.
794
794
  # @param policy [Google::Iam::V1::Policy | Hash]
795
- # REQUIRED: The complete policy to be applied to the +resource+. The size of
795
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
796
796
  # the policy is limited to a few 10s of KB. An empty policy is a
797
797
  # valid policy but certain Cloud Platform services (such as Projects)
798
798
  # might reject them.
@@ -812,7 +812,7 @@ module Google
812
812
  # instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
813
813
  # formatted_resource = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
814
814
  #
815
- # # TODO: Initialize +policy+:
815
+ # # TODO: Initialize `policy`:
816
816
  # policy = {}
817
817
  # response = instance_admin_client.set_iam_policy(formatted_resource, policy)
818
818
 
@@ -832,13 +832,13 @@ module Google
832
832
  # Gets the access control policy for an instance resource. Returns an empty
833
833
  # policy if an instance exists but does not have a policy set.
834
834
  #
835
- # Authorization requires +spanner.instances.getIamPolicy+ on
835
+ # Authorization requires `spanner.instances.getIamPolicy` on
836
836
  # {Google::Iam::V1::GetIamPolicyRequest#resource resource}.
837
837
  #
838
838
  # @param resource [String]
839
839
  # REQUIRED: The resource for which the policy is being requested.
840
- # +resource+ is usually specified as a path. For example, a Project
841
- # resource is specified as +projects/\\{project}+.
840
+ # `resource` is usually specified as a path. For example, a Project
841
+ # resource is specified as `projects/{project}`.
842
842
  # @param options [Google::Gax::CallOptions]
843
843
  # Overrides the default settings for this call, e.g, timeout,
844
844
  # retries, etc.
@@ -868,16 +868,16 @@ module Google
868
868
  # Returns permissions that the caller has on the specified instance resource.
869
869
  #
870
870
  # Attempting this RPC on a non-existent Cloud Spanner instance resource will
871
- # result in a NOT_FOUND error if the user has +spanner.instances.list+
871
+ # result in a NOT_FOUND error if the user has `spanner.instances.list`
872
872
  # permission on the containing Google Cloud Project. Otherwise returns an
873
873
  # empty set of permissions.
874
874
  #
875
875
  # @param resource [String]
876
876
  # REQUIRED: The resource for which the policy detail is being requested.
877
- # +resource+ is usually specified as a path. For example, a Project
878
- # resource is specified as +projects/\\{project}+.
877
+ # `resource` is usually specified as a path. For example, a Project
878
+ # resource is specified as `projects/{project}`.
879
879
  # @param permissions [Array<String>]
880
- # The set of permissions to check for the +resource+. Permissions with
880
+ # The set of permissions to check for the `resource`. Permissions with
881
881
  # wildcards (such as '*' or 'storage.*') are not allowed. For more
882
882
  # information see
883
883
  # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
@@ -895,7 +895,7 @@ module Google
895
895
  # instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
896
896
  # formatted_resource = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
897
897
  #
898
- # # TODO: Initialize +permissions+:
898
+ # # TODO: Initialize `permissions`:
899
899
  # permissions = []
900
900
  # response = instance_admin_client.test_iam_permissions(formatted_resource, permissions)
901
901
 
@@ -24,7 +24,7 @@ module Google
24
24
  # rubocop:disable LineLength
25
25
 
26
26
  ##
27
- # # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
27
+ # # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
28
28
  #
29
29
  # [Cloud Spanner Instance Admin API][Product Documentation]:
30
30
  #
@@ -37,7 +37,7 @@ module Google
37
37
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
38
38
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
39
39
  # 3. [Enable the Cloud Spanner Instance Admin API.](https://console.cloud.google.com/apis/library/spanner.googleapis.com)
40
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
41
41
  #
42
42
  # ### Installation
43
43
  # ```
@@ -47,7 +47,7 @@ module Google
47
47
  # ### Next Steps
48
48
  # - Read the [Cloud Spanner Instance Admin API Product documentation][Product Documentation]
49
49
  # to learn more about the product and see How-to Guides.
50
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
50
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
51
51
  # to see the full list of Cloud APIs that we cover.
52
52
  #
53
53
  # [Product Documentation]: https://cloud.google.com/spanner
@@ -56,7 +56,7 @@ module Google
56
56
  #
57
57
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
58
58
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
59
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
60
60
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
61
61
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
62
62
  #
@@ -23,7 +23,7 @@ module Google
23
23
  # rubocop:disable LineLength
24
24
 
25
25
  ##
26
- # # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
26
+ # # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
27
27
  #
28
28
  # [Cloud Spanner Instance Admin API][Product Documentation]:
29
29
  #
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Cloud Spanner Instance Admin API.](https://console.cloud.google.com/apis/library/spanner.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -46,7 +46,7 @@ module Google
46
46
  # ### Next Steps
47
47
  # - Read the [Cloud Spanner Instance Admin API Product documentation][Product Documentation]
48
48
  # to learn more about the product and see How-to Guides.
49
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
49
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
50
50
  # to see the full list of Cloud APIs that we cover.
51
51
  #
52
52
  # [Product Documentation]: https://cloud.google.com/spanner
@@ -55,7 +55,7 @@ module Google
55
55
  #
56
56
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
57
57
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
58
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
59
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
60
60
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
61
61
  #
@@ -82,9 +82,9 @@ module Google
82
82
  # @return [Integer]
83
83
  # Signed fractions of a second at nanosecond resolution of the span
84
84
  # of time. Durations less than one second are represented with a 0
85
- # +seconds+ field and a positive or negative +nanos+ field. For durations
86
- # of one second or more, a non-zero value for the +nanos+ field must be
87
- # of the same sign as the +seconds+ field. Must be from -999,999,999
85
+ # `seconds` field and a positive or negative `nanos` field. For durations
86
+ # of one second or more, a non-zero value for the `nanos` field must be
87
+ # of the same sign as the `seconds` field. Must be from -999,999,999
88
88
  # to +999,999,999 inclusive.
89
89
  class Duration; end
90
90
  end
@@ -23,7 +23,7 @@ module Google
23
23
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
24
24
  # }
25
25
  #
26
- # The JSON representation for +Empty+ is empty JSON object +{}+.
26
+ # The JSON representation for `Empty` is empty JSON object `{}`.
27
27
  class Empty; end
28
28
  end
29
29
  end
@@ -15,25 +15,25 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +Struct+ represents a structured data value, consisting of fields
19
- # which map to dynamically typed values. In some languages, +Struct+
18
+ # `Struct` represents a structured data value, consisting of fields
19
+ # which map to dynamically typed values. In some languages, `Struct`
20
20
  # might be supported by a native representation. For example, in
21
21
  # scripting languages like JS a struct is represented as an
22
22
  # object. The details of that representation are described together
23
23
  # with the proto support for the language.
24
24
  #
25
- # The JSON representation for +Struct+ is JSON object.
25
+ # The JSON representation for `Struct` is JSON object.
26
26
  # @!attribute [rw] fields
27
27
  # @return [Hash{String => Google::Protobuf::Value}]
28
28
  # Unordered map of dynamically typed values.
29
29
  class Struct; end
30
30
 
31
- # +Value+ represents a dynamically typed value which can be either
31
+ # `Value` represents a dynamically typed value which can be either
32
32
  # null, a number, a string, a boolean, a recursive struct value, or a
33
33
  # list of values. A producer of value is expected to set one of that
34
34
  # variants, absence of any variant indicates an error.
35
35
  #
36
- # The JSON representation for +Value+ is JSON value.
36
+ # The JSON representation for `Value` is JSON value.
37
37
  # @!attribute [rw] null_value
38
38
  # @return [Google::Protobuf::NullValue]
39
39
  # Represents a null value.
@@ -51,21 +51,21 @@ module Google
51
51
  # Represents a structured value.
52
52
  # @!attribute [rw] list_value
53
53
  # @return [Google::Protobuf::ListValue]
54
- # Represents a repeated +Value+.
54
+ # Represents a repeated `Value`.
55
55
  class Value; end
56
56
 
57
- # +ListValue+ is a wrapper around a repeated field of values.
57
+ # `ListValue` is a wrapper around a repeated field of values.
58
58
  #
59
- # The JSON representation for +ListValue+ is JSON array.
59
+ # The JSON representation for `ListValue` is JSON array.
60
60
  # @!attribute [rw] values
61
61
  # @return [Array<Google::Protobuf::Value>]
62
62
  # Repeated field of dynamically typed values.
63
63
  class ListValue; end
64
64
 
65
- # +NullValue+ is a singleton enumeration to represent the null value for the
66
- # +Value+ type union.
65
+ # `NullValue` is a singleton enumeration to represent the null value for the
66
+ # `Value` type union.
67
67
  #
68
- # The JSON representation for +NullValue+ is JSON +null+.
68
+ # The JSON representation for `NullValue` is JSON `null`.
69
69
  module NullValue
70
70
  # Null value.
71
71
  NULL_VALUE = 0