google-cloud-spanner-admin-instance-v1 0.7.0 → 0.8.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 +4 -4
- data/AUTHENTICATION.md +1 -1
- data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb +608 -13
- data/lib/google/cloud/spanner/admin/instance/v1/version.rb +1 -1
- data/lib/google/spanner/admin/instance/v1/common_pb.rb +30 -0
- data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb +63 -0
- data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +111 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/spanner/admin/instance/v1/common.rb +48 -0
- data/proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb +336 -29
- metadata +4 -2
@@ -84,17 +84,107 @@ module Google
|
|
84
84
|
# @!attribute [rw] display_name
|
85
85
|
# @return [::String]
|
86
86
|
# The name of this instance configuration as it appears in UIs.
|
87
|
+
# @!attribute [r] config_type
|
88
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig::Type]
|
89
|
+
# Output only. Whether this instance config is a Google or User Managed
|
90
|
+
# Configuration.
|
87
91
|
# @!attribute [rw] replicas
|
88
92
|
# @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>]
|
89
93
|
# The geographic placement of nodes in this instance configuration and their
|
90
94
|
# replication properties.
|
95
|
+
# @!attribute [r] optional_replicas
|
96
|
+
# @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>]
|
97
|
+
# Output only. The available optional replicas to choose from for user
|
98
|
+
# managed configurations. Populated for Google managed configurations.
|
99
|
+
# @!attribute [rw] base_config
|
100
|
+
# @return [::String]
|
101
|
+
# Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
|
102
|
+
# based on which this configuration is created. Only set for user managed
|
103
|
+
# configurations. `base_config` must refer to a configuration of type
|
104
|
+
# GOOGLE_MANAGED in the same project as this configuration.
|
105
|
+
# @!attribute [rw] labels
|
106
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
107
|
+
# Cloud Labels are a flexible and lightweight mechanism for organizing cloud
|
108
|
+
# resources into groups that reflect a customer's organizational needs and
|
109
|
+
# deployment strategies. Cloud Labels can be used to filter collections of
|
110
|
+
# resources. They can be used to control how resource metrics are aggregated.
|
111
|
+
# And they can be used as arguments to policy management rules (e.g. route,
|
112
|
+
# firewall, load balancing, etc.).
|
113
|
+
#
|
114
|
+
# * Label keys must be between 1 and 63 characters long and must conform to
|
115
|
+
# the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
|
116
|
+
# * Label values must be between 0 and 63 characters long and must conform
|
117
|
+
# to the regular expression `[a-z0-9_-]{0,63}`.
|
118
|
+
# * No more than 64 labels can be associated with a given resource.
|
119
|
+
#
|
120
|
+
# See https://goo.gl/xmQnxf for more information on and examples of labels.
|
121
|
+
#
|
122
|
+
# If you plan to use labels in your own code, please note that additional
|
123
|
+
# characters may be allowed in the future. Therefore, you are advised to use
|
124
|
+
# an internal label representation, such as JSON, which doesn't rely upon
|
125
|
+
# specific characters being disallowed. For example, representing labels
|
126
|
+
# as the string: name + "_" + value would prove problematic if we were to
|
127
|
+
# allow "_" in a future release.
|
128
|
+
# @!attribute [rw] etag
|
129
|
+
# @return [::String]
|
130
|
+
# etag is used for optimistic concurrency control as a way
|
131
|
+
# to help prevent simultaneous updates of a instance config from overwriting
|
132
|
+
# each other. It is strongly suggested that systems make use of the etag in
|
133
|
+
# the read-modify-write cycle to perform instance config updates in order to
|
134
|
+
# avoid race conditions: An etag is returned in the response which contains
|
135
|
+
# instance configs, and systems are expected to put that etag in the request
|
136
|
+
# to update instance config to ensure that their change will be applied to
|
137
|
+
# the same version of the instance config.
|
138
|
+
# If no etag is provided in the call to update instance config, then the
|
139
|
+
# existing instance config is overwritten blindly.
|
91
140
|
# @!attribute [rw] leader_options
|
92
141
|
# @return [::Array<::String>]
|
93
142
|
# Allowed values of the "default_leader" schema option for databases in
|
94
143
|
# instances that use this instance configuration.
|
144
|
+
# @!attribute [r] reconciling
|
145
|
+
# @return [::Boolean]
|
146
|
+
# Output only. If true, the instance config is being created or updated. If
|
147
|
+
# false, there are no ongoing operations for the instance config.
|
148
|
+
# @!attribute [r] state
|
149
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig::State]
|
150
|
+
# Output only. The current instance config state.
|
95
151
|
class InstanceConfig
|
96
152
|
include ::Google::Protobuf::MessageExts
|
97
153
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
|
155
|
+
# @!attribute [rw] key
|
156
|
+
# @return [::String]
|
157
|
+
# @!attribute [rw] value
|
158
|
+
# @return [::String]
|
159
|
+
class LabelsEntry
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
end
|
163
|
+
|
164
|
+
# The type of this configuration.
|
165
|
+
module Type
|
166
|
+
# Unspecified.
|
167
|
+
TYPE_UNSPECIFIED = 0
|
168
|
+
|
169
|
+
# Google managed configuration.
|
170
|
+
GOOGLE_MANAGED = 1
|
171
|
+
|
172
|
+
# User managed configuration.
|
173
|
+
USER_MANAGED = 2
|
174
|
+
end
|
175
|
+
|
176
|
+
# Indicates the current state of the instance config.
|
177
|
+
module State
|
178
|
+
# Not specified.
|
179
|
+
STATE_UNSPECIFIED = 0
|
180
|
+
|
181
|
+
# The instance config is still being created.
|
182
|
+
CREATING = 1
|
183
|
+
|
184
|
+
# The instance config is fully created and ready to be used to create
|
185
|
+
# instances.
|
186
|
+
READY = 2
|
187
|
+
end
|
98
188
|
end
|
99
189
|
|
100
190
|
# An isolated set of Cloud Spanner resources on which databases can be hosted.
|
@@ -136,10 +226,10 @@ module Google
|
|
136
226
|
# @!attribute [r] state
|
137
227
|
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State]
|
138
228
|
# Output only. The current instance state. For
|
139
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance},
|
140
|
-
# either omitted or set to `CREATING`. For
|
141
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance},
|
142
|
-
# either omitted or set to `READY`.
|
229
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance},
|
230
|
+
# the state must be either omitted or set to `CREATING`. For
|
231
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance},
|
232
|
+
# the state must be either omitted or set to `READY`.
|
143
233
|
# @!attribute [rw] labels
|
144
234
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
145
235
|
# Cloud Labels are a flexible and lightweight mechanism for organizing cloud
|
@@ -201,7 +291,8 @@ module Google
|
|
201
291
|
end
|
202
292
|
end
|
203
293
|
|
204
|
-
# The request for
|
294
|
+
# The request for
|
295
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}.
|
205
296
|
# @!attribute [rw] parent
|
206
297
|
# @return [::String]
|
207
298
|
# Required. The name of the project for which a list of supported instance
|
@@ -215,21 +306,23 @@ module Google
|
|
215
306
|
# @return [::String]
|
216
307
|
# If non-empty, `page_token` should contain a
|
217
308
|
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse#next_page_token next_page_token}
|
218
|
-
# from a previous
|
309
|
+
# from a previous
|
310
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse ListInstanceConfigsResponse}.
|
219
311
|
class ListInstanceConfigsRequest
|
220
312
|
include ::Google::Protobuf::MessageExts
|
221
313
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
222
314
|
end
|
223
315
|
|
224
|
-
# The response for
|
316
|
+
# The response for
|
317
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}.
|
225
318
|
# @!attribute [rw] instance_configs
|
226
319
|
# @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig>]
|
227
320
|
# The list of requested instance configurations.
|
228
321
|
# @!attribute [rw] next_page_token
|
229
322
|
# @return [::String]
|
230
323
|
# `next_page_token` can be sent in a subsequent
|
231
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}
|
232
|
-
# fetch more of the matching instance configurations.
|
324
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}
|
325
|
+
# call to fetch more of the matching instance configurations.
|
233
326
|
class ListInstanceConfigsResponse
|
234
327
|
include ::Google::Protobuf::MessageExts
|
235
328
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -246,22 +339,191 @@ module Google
|
|
246
339
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
247
340
|
end
|
248
341
|
|
249
|
-
# The request for
|
342
|
+
# The request for
|
343
|
+
# [CreateInstanceConfigRequest][InstanceAdmin.CreateInstanceConfigRequest].
|
344
|
+
# @!attribute [rw] parent
|
345
|
+
# @return [::String]
|
346
|
+
# Required. The name of the project in which to create the instance config.
|
347
|
+
# Values are of the form `projects/<project>`.
|
348
|
+
# @!attribute [rw] instance_config_id
|
349
|
+
# @return [::String]
|
350
|
+
# Required. The ID of the instance config to create. Valid identifiers are
|
351
|
+
# of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
|
352
|
+
# characters in length. The `custom-` prefix is required to avoid name
|
353
|
+
# conflicts with Google managed configurations.
|
354
|
+
# @!attribute [rw] instance_config
|
355
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig]
|
356
|
+
# Required. The InstanceConfig proto of the configuration to create.
|
357
|
+
# instance_config.name must be
|
358
|
+
# `<parent>/instanceConfigs/<instance_config_id>`.
|
359
|
+
# instance_config.base_config must be a Google managed configuration name,
|
360
|
+
# e.g. <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
|
361
|
+
# @!attribute [rw] validate_only
|
362
|
+
# @return [::Boolean]
|
363
|
+
# An option to validate, but not actually execute, a request,
|
364
|
+
# and provide the same response.
|
365
|
+
class CreateInstanceConfigRequest
|
366
|
+
include ::Google::Protobuf::MessageExts
|
367
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
368
|
+
end
|
369
|
+
|
370
|
+
# The request for
|
371
|
+
# [UpdateInstanceConfigRequest][InstanceAdmin.UpdateInstanceConfigRequest].
|
372
|
+
# @!attribute [rw] instance_config
|
373
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig]
|
374
|
+
# Required. The user instance config to update, which must always include the
|
375
|
+
# instance config name. Otherwise, only fields mentioned in
|
376
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceConfigRequest#update_mask update_mask}
|
377
|
+
# need be included. To prevent conflicts of concurrent updates,
|
378
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling etag} can
|
379
|
+
# be used.
|
380
|
+
# @!attribute [rw] update_mask
|
381
|
+
# @return [::Google::Protobuf::FieldMask]
|
382
|
+
# Required. A mask specifying which fields in
|
383
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig InstanceConfig} should be
|
384
|
+
# updated. The field mask must always be specified; this prevents any future
|
385
|
+
# fields in {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig InstanceConfig}
|
386
|
+
# from being erased accidentally by clients that do not know about them. Only
|
387
|
+
# display_name and labels can be updated.
|
388
|
+
# @!attribute [rw] validate_only
|
389
|
+
# @return [::Boolean]
|
390
|
+
# An option to validate, but not actually execute, a request,
|
391
|
+
# and provide the same response.
|
392
|
+
class UpdateInstanceConfigRequest
|
393
|
+
include ::Google::Protobuf::MessageExts
|
394
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
395
|
+
end
|
396
|
+
|
397
|
+
# The request for
|
398
|
+
# [DeleteInstanceConfigRequest][InstanceAdmin.DeleteInstanceConfigRequest].
|
399
|
+
# @!attribute [rw] name
|
400
|
+
# @return [::String]
|
401
|
+
# Required. The name of the instance configuration to be deleted.
|
402
|
+
# Values are of the form
|
403
|
+
# `projects/<project>/instanceConfigs/<instance_config>`
|
404
|
+
# @!attribute [rw] etag
|
405
|
+
# @return [::String]
|
406
|
+
# Used for optimistic concurrency control as a way to help prevent
|
407
|
+
# simultaneous deletes of an instance config from overwriting each
|
408
|
+
# other. If not empty, the API
|
409
|
+
# only deletes the instance config when the etag provided matches the current
|
410
|
+
# status of the requested instance config. Otherwise, deletes the instance
|
411
|
+
# config without checking the current status of the requested instance
|
412
|
+
# config.
|
413
|
+
# @!attribute [rw] validate_only
|
414
|
+
# @return [::Boolean]
|
415
|
+
# An option to validate, but not actually execute, a request,
|
416
|
+
# and provide the same response.
|
417
|
+
class DeleteInstanceConfigRequest
|
418
|
+
include ::Google::Protobuf::MessageExts
|
419
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
420
|
+
end
|
421
|
+
|
422
|
+
# The request for
|
423
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_config_operations ListInstanceConfigOperations}.
|
424
|
+
# @!attribute [rw] parent
|
425
|
+
# @return [::String]
|
426
|
+
# Required. The project of the instance config operations.
|
427
|
+
# Values are of the form `projects/<project>`.
|
428
|
+
# @!attribute [rw] filter
|
429
|
+
# @return [::String]
|
430
|
+
# An expression that filters the list of returned operations.
|
431
|
+
#
|
432
|
+
# A filter expression consists of a field name, a
|
433
|
+
# comparison operator, and a value for filtering.
|
434
|
+
# The value must be a string, a number, or a boolean. The comparison operator
|
435
|
+
# must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
|
436
|
+
# Colon `:` is the contains operator. Filter rules are not case sensitive.
|
437
|
+
#
|
438
|
+
# The following fields in the {::Google::Longrunning::Operation Operation}
|
439
|
+
# are eligible for filtering:
|
440
|
+
#
|
441
|
+
# * `name` - The name of the long-running operation
|
442
|
+
# * `done` - False if the operation is in progress, else true.
|
443
|
+
# * `metadata.@type` - the type of metadata. For example, the type string
|
444
|
+
# for
|
445
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceConfigMetadata CreateInstanceConfigMetadata}
|
446
|
+
# is
|
447
|
+
# `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`.
|
448
|
+
# * `metadata.<field_name>` - any field in metadata.value.
|
449
|
+
# `metadata.@type` must be specified first, if filtering on metadata
|
450
|
+
# fields.
|
451
|
+
# * `error` - Error associated with the long-running operation.
|
452
|
+
# * `response.@type` - the type of response.
|
453
|
+
# * `response.<field_name>` - any field in response.value.
|
454
|
+
#
|
455
|
+
# You can combine multiple expressions by enclosing each expression in
|
456
|
+
# parentheses. By default, expressions are combined with AND logic. However,
|
457
|
+
# you can specify AND, OR, and NOT logic explicitly.
|
458
|
+
#
|
459
|
+
# Here are a few examples:
|
460
|
+
#
|
461
|
+
# * `done:true` - The operation is complete.
|
462
|
+
# * `(metadata.@type=` \
|
463
|
+
# `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata)
|
464
|
+
# AND` \
|
465
|
+
# `(metadata.instance_config.name:custom-config) AND` \
|
466
|
+
# `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \
|
467
|
+
# `(error:*)` - Return operations where:
|
468
|
+
# * The operation's metadata type is
|
469
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceConfigMetadata CreateInstanceConfigMetadata}.
|
470
|
+
# * The instance config name contains "custom-config".
|
471
|
+
# * The operation started before 2021-03-28T14:50:00Z.
|
472
|
+
# * The operation resulted in an error.
|
473
|
+
# @!attribute [rw] page_size
|
474
|
+
# @return [::Integer]
|
475
|
+
# Number of operations to be returned in the response. If 0 or
|
476
|
+
# less, defaults to the server's maximum allowed page size.
|
477
|
+
# @!attribute [rw] page_token
|
478
|
+
# @return [::String]
|
479
|
+
# If non-empty, `page_token` should contain a
|
480
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsResponse#next_page_token next_page_token}
|
481
|
+
# from a previous
|
482
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsResponse ListInstanceConfigOperationsResponse}
|
483
|
+
# to the same `parent` and with the same `filter`.
|
484
|
+
class ListInstanceConfigOperationsRequest
|
485
|
+
include ::Google::Protobuf::MessageExts
|
486
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
487
|
+
end
|
488
|
+
|
489
|
+
# The response for
|
490
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_config_operations ListInstanceConfigOperations}.
|
491
|
+
# @!attribute [rw] operations
|
492
|
+
# @return [::Array<::Google::Longrunning::Operation>]
|
493
|
+
# The list of matching instance config [long-running
|
494
|
+
# operations][google.longrunning.Operation]. Each operation's name will be
|
495
|
+
# prefixed by the instance config's name. The operation's
|
496
|
+
# {::Google::Longrunning::Operation#metadata metadata} field type
|
497
|
+
# `metadata.type_url` describes the type of the metadata.
|
498
|
+
# @!attribute [rw] next_page_token
|
499
|
+
# @return [::String]
|
500
|
+
# `next_page_token` can be sent in a subsequent
|
501
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_config_operations ListInstanceConfigOperations}
|
502
|
+
# call to fetch more of the matching metadata.
|
503
|
+
class ListInstanceConfigOperationsResponse
|
504
|
+
include ::Google::Protobuf::MessageExts
|
505
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
506
|
+
end
|
507
|
+
|
508
|
+
# The request for
|
509
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#get_instance GetInstance}.
|
250
510
|
# @!attribute [rw] name
|
251
511
|
# @return [::String]
|
252
512
|
# Required. The name of the requested instance. Values are of the form
|
253
513
|
# `projects/<project>/instances/<instance>`.
|
254
514
|
# @!attribute [rw] field_mask
|
255
515
|
# @return [::Google::Protobuf::FieldMask]
|
256
|
-
# If field_mask is present, specifies the subset of
|
257
|
-
# should be
|
258
|
-
# If absent, all
|
516
|
+
# If field_mask is present, specifies the subset of
|
517
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} fields that should be
|
518
|
+
# returned. If absent, all
|
519
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} fields are returned.
|
259
520
|
class GetInstanceRequest
|
260
521
|
include ::Google::Protobuf::MessageExts
|
261
522
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
262
523
|
end
|
263
524
|
|
264
|
-
# The request for
|
525
|
+
# The request for
|
526
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}.
|
265
527
|
# @!attribute [rw] parent
|
266
528
|
# @return [::String]
|
267
529
|
# Required. The name of the project in which to create the instance. Values
|
@@ -280,7 +542,8 @@ module Google
|
|
280
542
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
543
|
end
|
282
544
|
|
283
|
-
# The request for
|
545
|
+
# The request for
|
546
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}.
|
284
547
|
# @!attribute [rw] parent
|
285
548
|
# @return [::String]
|
286
549
|
# Required. The name of the project for which a list of instances is
|
@@ -292,8 +555,9 @@ module Google
|
|
292
555
|
# @!attribute [rw] page_token
|
293
556
|
# @return [::String]
|
294
557
|
# If non-empty, `page_token` should contain a
|
295
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse#next_page_token next_page_token}
|
296
|
-
#
|
558
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse#next_page_token next_page_token}
|
559
|
+
# from a previous
|
560
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse ListInstancesResponse}.
|
297
561
|
# @!attribute [rw] filter
|
298
562
|
# @return [::String]
|
299
563
|
# An expression for filtering the results of the request. Filter rules are
|
@@ -320,37 +584,43 @@ module Google
|
|
320
584
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
321
585
|
end
|
322
586
|
|
323
|
-
# The response for
|
587
|
+
# The response for
|
588
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}.
|
324
589
|
# @!attribute [rw] instances
|
325
590
|
# @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::Instance>]
|
326
591
|
# The list of requested instances.
|
327
592
|
# @!attribute [rw] next_page_token
|
328
593
|
# @return [::String]
|
329
594
|
# `next_page_token` can be sent in a subsequent
|
330
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}
|
331
|
-
# of the matching instances.
|
595
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}
|
596
|
+
# call to fetch more of the matching instances.
|
332
597
|
class ListInstancesResponse
|
333
598
|
include ::Google::Protobuf::MessageExts
|
334
599
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
335
600
|
end
|
336
601
|
|
337
|
-
# The request for
|
602
|
+
# The request for
|
603
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}.
|
338
604
|
# @!attribute [rw] instance
|
339
605
|
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance]
|
340
606
|
# Required. The instance to update, which must always include the instance
|
341
|
-
# name. Otherwise, only fields mentioned in
|
607
|
+
# name. Otherwise, only fields mentioned in
|
608
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest#field_mask field_mask}
|
609
|
+
# need be included.
|
342
610
|
# @!attribute [rw] field_mask
|
343
611
|
# @return [::Google::Protobuf::FieldMask]
|
344
|
-
# Required. A mask specifying which fields in
|
612
|
+
# Required. A mask specifying which fields in
|
613
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} should be updated.
|
345
614
|
# The field mask must always be specified; this prevents any future fields in
|
346
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} from being erased
|
347
|
-
# about them.
|
615
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} from being erased
|
616
|
+
# accidentally by clients that do not know about them.
|
348
617
|
class UpdateInstanceRequest
|
349
618
|
include ::Google::Protobuf::MessageExts
|
350
619
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
351
620
|
end
|
352
621
|
|
353
|
-
# The request for
|
622
|
+
# The request for
|
623
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#delete_instance DeleteInstance}.
|
354
624
|
# @!attribute [rw] name
|
355
625
|
# @return [::String]
|
356
626
|
# Required. The name of the instance to be deleted. Values are of the form
|
@@ -368,8 +638,8 @@ module Google
|
|
368
638
|
# @!attribute [rw] start_time
|
369
639
|
# @return [::Google::Protobuf::Timestamp]
|
370
640
|
# The time at which the
|
371
|
-
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}
|
372
|
-
# received.
|
641
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}
|
642
|
+
# request was received.
|
373
643
|
# @!attribute [rw] cancel_time
|
374
644
|
# @return [::Google::Protobuf::Timestamp]
|
375
645
|
# The time at which this operation was cancelled. If set, this operation is
|
@@ -390,7 +660,8 @@ module Google
|
|
390
660
|
# The desired end state of the update.
|
391
661
|
# @!attribute [rw] start_time
|
392
662
|
# @return [::Google::Protobuf::Timestamp]
|
393
|
-
# The time at which
|
663
|
+
# The time at which
|
664
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}
|
394
665
|
# request was received.
|
395
666
|
# @!attribute [rw] cancel_time
|
396
667
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -404,6 +675,42 @@ module Google
|
|
404
675
|
include ::Google::Protobuf::MessageExts
|
405
676
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
406
677
|
end
|
678
|
+
|
679
|
+
# Metadata type for the operation returned by
|
680
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance_config CreateInstanceConfig}.
|
681
|
+
# @!attribute [rw] instance_config
|
682
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig]
|
683
|
+
# The target instance config end state.
|
684
|
+
# @!attribute [rw] progress
|
685
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::OperationProgress]
|
686
|
+
# The progress of the
|
687
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance_config CreateInstanceConfig}
|
688
|
+
# operation.
|
689
|
+
# @!attribute [rw] cancel_time
|
690
|
+
# @return [::Google::Protobuf::Timestamp]
|
691
|
+
# The time at which this operation was cancelled.
|
692
|
+
class CreateInstanceConfigMetadata
|
693
|
+
include ::Google::Protobuf::MessageExts
|
694
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
695
|
+
end
|
696
|
+
|
697
|
+
# Metadata type for the operation returned by
|
698
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance_config UpdateInstanceConfig}.
|
699
|
+
# @!attribute [rw] instance_config
|
700
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig]
|
701
|
+
# The desired instance config after updating.
|
702
|
+
# @!attribute [rw] progress
|
703
|
+
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::OperationProgress]
|
704
|
+
# The progress of the
|
705
|
+
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance_config UpdateInstanceConfig}
|
706
|
+
# operation.
|
707
|
+
# @!attribute [rw] cancel_time
|
708
|
+
# @return [::Google::Protobuf::Timestamp]
|
709
|
+
# The time at which this operation was cancelled.
|
710
|
+
class UpdateInstanceConfigMetadata
|
711
|
+
include ::Google::Protobuf::MessageExts
|
712
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
713
|
+
end
|
407
714
|
end
|
408
715
|
end
|
409
716
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-spanner-admin-instance-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.8.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-
|
11
|
+
date: 2022-09-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -191,6 +191,7 @@ files:
|
|
191
191
|
- lib/google/cloud/spanner/admin/instance/v1/instance_admin/operations.rb
|
192
192
|
- lib/google/cloud/spanner/admin/instance/v1/instance_admin/paths.rb
|
193
193
|
- lib/google/cloud/spanner/admin/instance/v1/version.rb
|
194
|
+
- lib/google/spanner/admin/instance/v1/common_pb.rb
|
194
195
|
- lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb
|
195
196
|
- lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb
|
196
197
|
- proto_docs/README.md
|
@@ -206,6 +207,7 @@ files:
|
|
206
207
|
- proto_docs/google/protobuf/field_mask.rb
|
207
208
|
- proto_docs/google/protobuf/timestamp.rb
|
208
209
|
- proto_docs/google/rpc/status.rb
|
210
|
+
- proto_docs/google/spanner/admin/instance/v1/common.rb
|
209
211
|
- proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb
|
210
212
|
- proto_docs/google/type/expr.rb
|
211
213
|
homepage: https://github.com/googleapis/google-cloud-ruby
|