google-cloud-bigtable-admin-v2 0.1.1 → 0.4.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/LICENSE.md +188 -190
- data/README.md +64 -0
- data/lib/google/bigtable/admin/v2/bigtable_instance_admin_services_pb.rb +20 -21
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_pb.rb +27 -27
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb +30 -30
- data/lib/google/bigtable/admin/v2/instance_pb.rb +5 -0
- data/lib/google/bigtable/admin/v2/table_pb.rb +16 -0
- data/lib/google/cloud/bigtable/admin/v2.rb +3 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb +13 -5
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb +90 -5
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb +21 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb +67 -47
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb +90 -5
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/paths.rb +23 -0
- data/lib/google/cloud/bigtable/admin/v2/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/bigtable/admin/v2/bigtable_instance_admin.rb +1 -1
- data/proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb +114 -123
- data/proto_docs/google/bigtable/admin/v2/instance.rb +21 -1
- data/proto_docs/google/bigtable/admin/v2/table.rb +58 -4
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +7 -4
@@ -65,6 +65,29 @@ module Google
|
|
65
65
|
"projects/#{project}/instances/#{instance}/clusters/#{cluster}"
|
66
66
|
end
|
67
67
|
|
68
|
+
##
|
69
|
+
# Create a fully-qualified CryptoKeyVersion resource string.
|
70
|
+
#
|
71
|
+
# The resource will be in the following format:
|
72
|
+
#
|
73
|
+
# `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`
|
74
|
+
#
|
75
|
+
# @param project [String]
|
76
|
+
# @param location [String]
|
77
|
+
# @param key_ring [String]
|
78
|
+
# @param crypto_key [String]
|
79
|
+
# @param crypto_key_version [String]
|
80
|
+
#
|
81
|
+
# @return [::String]
|
82
|
+
def crypto_key_version_path project:, location:, key_ring:, crypto_key:, crypto_key_version:
|
83
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
84
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
85
|
+
raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
86
|
+
raise ::ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"
|
87
|
+
|
88
|
+
"projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
|
89
|
+
end
|
90
|
+
|
68
91
|
##
|
69
92
|
# Create a fully-qualified Instance resource string.
|
70
93
|
#
|
@@ -54,6 +54,12 @@ module Google
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
55
55
|
# resource, but may not be changed thereafter.
|
56
56
|
IMMUTABLE = 5
|
57
|
+
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
59
|
+
# This indicates that the service may provide the elements of the list
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
62
|
+
UNORDERED_LIST = 6
|
57
63
|
end
|
58
64
|
end
|
59
65
|
end
|
@@ -43,12 +43,12 @@ module Google
|
|
43
43
|
#
|
44
44
|
# The ResourceDescriptor Yaml config will look like:
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
52
|
#
|
53
53
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
54
|
# live under multiple parents.
|
@@ -183,15 +183,24 @@ module Google
|
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
185
|
# @return [::String]
|
186
|
-
# The plural name used in the resource name, such as
|
187
|
-
# the name of 'projects/\\{project}'
|
188
|
-
#
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
189
190
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
190
194
|
# @!attribute [rw] singular
|
191
195
|
# @return [::String]
|
192
196
|
# The same concept of the `singular` field in k8s CRD spec
|
193
197
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
198
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
195
204
|
class ResourceDescriptor
|
196
205
|
include ::Google::Protobuf::MessageExts
|
197
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,6 +220,22 @@ module Google
|
|
211
220
|
# that from being necessary once there are multiple patterns.)
|
212
221
|
FUTURE_MULTI_PATTERN = 2
|
213
222
|
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
214
239
|
end
|
215
240
|
|
216
241
|
# Defines a proto annotation that describes a string field that refers to
|
@@ -226,6 +251,17 @@ module Google
|
|
226
251
|
# type: "pubsub.googleapis.com/Topic"
|
227
252
|
# }];
|
228
253
|
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
229
265
|
# @!attribute [rw] child_type
|
230
266
|
# @return [::String]
|
231
267
|
# The resource type of a child collection that the annotated field
|
@@ -234,11 +270,11 @@ module Google
|
|
234
270
|
#
|
235
271
|
# Example:
|
236
272
|
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
242
278
|
class ResourceReference
|
243
279
|
include ::Google::Protobuf::MessageExts
|
244
280
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -360,7 +360,7 @@ module Google
|
|
360
360
|
# `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
|
361
361
|
# @!attribute [rw] ignore_warnings
|
362
362
|
# @return [::Boolean]
|
363
|
-
# If true, ignore safety checks when deleting the app profile.
|
363
|
+
# Required. If true, ignore safety checks when deleting the app profile.
|
364
364
|
class DeleteAppProfileRequest
|
365
365
|
include ::Google::Protobuf::MessageExts
|
366
366
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -22,6 +22,73 @@ module Google
|
|
22
22
|
module Bigtable
|
23
23
|
module Admin
|
24
24
|
module V2
|
25
|
+
# The request for
|
26
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
27
|
+
# @!attribute [rw] parent
|
28
|
+
# @return [::String]
|
29
|
+
# Required. The name of the instance in which to create the restored
|
30
|
+
# table. This instance must be the parent of the source backup. Values are
|
31
|
+
# of the form `projects/<project>/instances/<instance>`.
|
32
|
+
# @!attribute [rw] table_id
|
33
|
+
# @return [::String]
|
34
|
+
# Required. The id of the table to create and restore to. This
|
35
|
+
# table must not already exist. The `table_id` appended to
|
36
|
+
# `parent` forms the full table name of the form
|
37
|
+
# `projects/<project>/instances/<instance>/tables/<table_id>`.
|
38
|
+
# @!attribute [rw] backup
|
39
|
+
# @return [::String]
|
40
|
+
# Name of the backup from which to restore. Values are of the form
|
41
|
+
# `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
|
42
|
+
class RestoreTableRequest
|
43
|
+
include ::Google::Protobuf::MessageExts
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
end
|
46
|
+
|
47
|
+
# Metadata type for the long-running operation returned by
|
48
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
49
|
+
# @!attribute [rw] name
|
50
|
+
# @return [::String]
|
51
|
+
# Name of the table being created and restored to.
|
52
|
+
# @!attribute [rw] source_type
|
53
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::RestoreSourceType]
|
54
|
+
# The type of the restore source.
|
55
|
+
# @!attribute [rw] backup_info
|
56
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::BackupInfo]
|
57
|
+
# @!attribute [rw] optimize_table_operation_name
|
58
|
+
# @return [::String]
|
59
|
+
# If exists, the name of the long-running operation that will be used to
|
60
|
+
# track the post-restore optimization process to optimize the performance of
|
61
|
+
# the restored table. The metadata type of the long-running operation is
|
62
|
+
# [OptimizeRestoreTableMetadata][]. The response type is
|
63
|
+
# {::Google::Protobuf::Empty Empty}. This long-running operation may be
|
64
|
+
# automatically created by the system if applicable after the
|
65
|
+
# RestoreTable long-running operation completes successfully. This operation
|
66
|
+
# may not be created if the table is already optimized or the restore was
|
67
|
+
# not successful.
|
68
|
+
# @!attribute [rw] progress
|
69
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
70
|
+
# The progress of the {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}
|
71
|
+
# operation.
|
72
|
+
class RestoreTableMetadata
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# Metadata type for the long-running operation used to track the progress
|
78
|
+
# of optimizations performed on a newly restored table. This long-running
|
79
|
+
# operation is automatically created by the system after the successful
|
80
|
+
# completion of a table restore, and cannot be cancelled.
|
81
|
+
# @!attribute [rw] name
|
82
|
+
# @return [::String]
|
83
|
+
# Name of the restored table being optimized.
|
84
|
+
# @!attribute [rw] progress
|
85
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
86
|
+
# The progress of the post-restore optimizations.
|
87
|
+
class OptimizeRestoredTableMetadata
|
88
|
+
include ::Google::Protobuf::MessageExts
|
89
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
|
+
end
|
91
|
+
|
25
92
|
# Request message for
|
26
93
|
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_table google.bigtable.admin.v2.BigtableTableAdmin.CreateTable}
|
27
94
|
# @!attribute [rw] parent
|
@@ -30,8 +97,8 @@ module Google
|
|
30
97
|
# Values are of the form `projects/{project}/instances/{instance}`.
|
31
98
|
# @!attribute [rw] table_id
|
32
99
|
# @return [::String]
|
33
|
-
# Required. The name by which the new table should be referred to within the
|
34
|
-
#
|
100
|
+
# Required. The name by which the new table should be referred to within the parent
|
101
|
+
# instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
|
35
102
|
# Maximum 50 characters.
|
36
103
|
# @!attribute [rw] table
|
37
104
|
# @return [::Google::Cloud::Bigtable::Admin::V2::Table]
|
@@ -81,13 +148,13 @@ module Google
|
|
81
148
|
# Values are of the form `projects/{project}/instances/{instance}`.
|
82
149
|
# @!attribute [rw] table_id
|
83
150
|
# @return [::String]
|
84
|
-
# Required. The name by which the new table should be referred to within the
|
85
|
-
#
|
151
|
+
# Required. The name by which the new table should be referred to within the parent
|
152
|
+
# instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
|
86
153
|
# @!attribute [rw] source_snapshot
|
87
154
|
# @return [::String]
|
88
|
-
# Required. The unique name of the snapshot from which to restore the table.
|
89
|
-
#
|
90
|
-
# form
|
155
|
+
# Required. The unique name of the snapshot from which to restore the table. The
|
156
|
+
# snapshot and the table must be in the same instance.
|
157
|
+
# Values are of the form
|
91
158
|
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
|
92
159
|
class CreateTableFromSnapshotRequest
|
93
160
|
include ::Google::Protobuf::MessageExts
|
@@ -117,8 +184,8 @@ module Google
|
|
117
184
|
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_tables google.bigtable.admin.v2.BigtableTableAdmin.ListTables}
|
118
185
|
# @!attribute [rw] parent
|
119
186
|
# @return [::String]
|
120
|
-
# Required. The unique name of the instance for which tables should be
|
121
|
-
#
|
187
|
+
# Required. The unique name of the instance for which tables should be listed.
|
188
|
+
# Values are of the form `projects/{project}/instances/{instance}`.
|
122
189
|
# @!attribute [rw] view
|
123
190
|
# @return [::Google::Cloud::Bigtable::Admin::V2::Table::View]
|
124
191
|
# The view to be applied to the returned tables' fields.
|
@@ -194,10 +261,10 @@ module Google
|
|
194
261
|
# `projects/{project}/instances/{instance}/tables/{table}`.
|
195
262
|
# @!attribute [rw] modifications
|
196
263
|
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
|
197
|
-
# Required. Modifications to be atomically applied to the specified table's
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
264
|
+
# Required. Modifications to be atomically applied to the specified table's families.
|
265
|
+
# Entries are applied in order, meaning that earlier modifications can be
|
266
|
+
# masked by later ones (in the case of repeated updates to the same family,
|
267
|
+
# for example).
|
201
268
|
class ModifyColumnFamiliesRequest
|
202
269
|
include ::Google::Protobuf::MessageExts
|
203
270
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -228,8 +295,8 @@ module Google
|
|
228
295
|
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#generate_consistency_token google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken}
|
229
296
|
# @!attribute [rw] name
|
230
297
|
# @return [::String]
|
231
|
-
# Required. The unique name of the Table for which to create a consistency
|
232
|
-
#
|
298
|
+
# Required. The unique name of the Table for which to create a consistency token.
|
299
|
+
# Values are of the form
|
233
300
|
# `projects/{project}/instances/{instance}/tables/{table}`.
|
234
301
|
class GenerateConsistencyTokenRequest
|
235
302
|
include ::Google::Protobuf::MessageExts
|
@@ -250,8 +317,8 @@ module Google
|
|
250
317
|
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#check_consistency google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency}
|
251
318
|
# @!attribute [rw] name
|
252
319
|
# @return [::String]
|
253
|
-
# Required. The unique name of the Table for which to check replication
|
254
|
-
#
|
320
|
+
# Required. The unique name of the Table for which to check replication consistency.
|
321
|
+
# Values are of the form
|
255
322
|
# `projects/{project}/instances/{instance}/tables/{table}`.
|
256
323
|
# @!attribute [rw] consistency_token
|
257
324
|
# @return [::String]
|
@@ -291,9 +358,9 @@ module Google
|
|
291
358
|
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
292
359
|
# @!attribute [rw] snapshot_id
|
293
360
|
# @return [::String]
|
294
|
-
# Required. The ID by which the new snapshot should be referred to within the
|
295
|
-
#
|
296
|
-
#
|
361
|
+
# Required. The ID by which the new snapshot should be referred to within the parent
|
362
|
+
# cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
|
363
|
+
# rather than
|
297
364
|
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
|
298
365
|
# @!attribute [rw] ttl
|
299
366
|
# @return [::Google::Protobuf::Duration]
|
@@ -335,8 +402,8 @@ module Google
|
|
335
402
|
# for production use. It is not subject to any SLA or deprecation policy.
|
336
403
|
# @!attribute [rw] parent
|
337
404
|
# @return [::String]
|
338
|
-
# Required. The unique name of the cluster for which snapshots should be
|
339
|
-
#
|
405
|
+
# Required. The unique name of the cluster for which snapshots should be listed.
|
406
|
+
# Values are of the form
|
340
407
|
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
341
408
|
# Use `{cluster} = '-'` to list snapshots for all clusters in an instance,
|
342
409
|
# e.g., `projects/{project}/instances/{instance}/clusters/-`.
|
@@ -430,8 +497,7 @@ module Google
|
|
430
497
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
431
498
|
end
|
432
499
|
|
433
|
-
# The request for
|
434
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_backup CreateBackup}.
|
500
|
+
# The request for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_backup CreateBackup}.
|
435
501
|
# @!attribute [rw] parent
|
436
502
|
# @return [::String]
|
437
503
|
# Required. This must be one of the clusters in the instance in which this
|
@@ -472,20 +538,7 @@ module Google
|
|
472
538
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
473
539
|
end
|
474
540
|
|
475
|
-
# The request for
|
476
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#get_backup GetBackup}.
|
477
|
-
# @!attribute [rw] name
|
478
|
-
# @return [::String]
|
479
|
-
# Required. Name of the backup.
|
480
|
-
# Values are of the form
|
481
|
-
# `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
|
482
|
-
class GetBackupRequest
|
483
|
-
include ::Google::Protobuf::MessageExts
|
484
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
485
|
-
end
|
486
|
-
|
487
|
-
# The request for
|
488
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#update_backup UpdateBackup}.
|
541
|
+
# The request for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#update_backup UpdateBackup}.
|
489
542
|
# @!attribute [rw] backup
|
490
543
|
# @return [::Google::Cloud::Bigtable::Admin::V2::Backup]
|
491
544
|
# Required. The backup to update. `backup.name`, and the fields to be updated
|
@@ -504,8 +557,18 @@ module Google
|
|
504
557
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
505
558
|
end
|
506
559
|
|
507
|
-
# The request for
|
508
|
-
#
|
560
|
+
# The request for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#get_backup GetBackup}.
|
561
|
+
# @!attribute [rw] name
|
562
|
+
# @return [::String]
|
563
|
+
# Required. Name of the backup.
|
564
|
+
# Values are of the form
|
565
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
|
566
|
+
class GetBackupRequest
|
567
|
+
include ::Google::Protobuf::MessageExts
|
568
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
569
|
+
end
|
570
|
+
|
571
|
+
# The request for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#delete_backup DeleteBackup}.
|
509
572
|
# @!attribute [rw] name
|
510
573
|
# @return [::String]
|
511
574
|
# Required. Name of the backup to delete.
|
@@ -516,11 +579,10 @@ module Google
|
|
516
579
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
517
580
|
end
|
518
581
|
|
519
|
-
# The request for
|
520
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
582
|
+
# The request for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
521
583
|
# @!attribute [rw] parent
|
522
584
|
# @return [::String]
|
523
|
-
# Required. The cluster to list backups from.
|
585
|
+
# Required. The cluster to list backups from. Values are of the
|
524
586
|
# form `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
525
587
|
# Use `{cluster} = '-'` to list backups for all clusters in an instance,
|
526
588
|
# e.g., `projects/{project}/instances/{instance}/clusters/-`.
|
@@ -530,7 +592,7 @@ module Google
|
|
530
592
|
# The expression must specify the field name, a comparison operator,
|
531
593
|
# and the value that you want to use for filtering. The value must be a
|
532
594
|
# string, a number, or a boolean. The comparison operator must be
|
533
|
-
# <, >, <=, >=, !=, =, or :. Colon
|
595
|
+
# <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is
|
534
596
|
# roughly synonymous with equality. Filter rules are case insensitive.
|
535
597
|
#
|
536
598
|
# The fields eligible for filtering are:
|
@@ -561,9 +623,8 @@ module Google
|
|
561
623
|
# @!attribute [rw] order_by
|
562
624
|
# @return [::String]
|
563
625
|
# An expression for specifying the sort order of the results of the request.
|
564
|
-
# The string value should specify one or more fields in
|
565
|
-
#
|
566
|
-
# https://aip.dev/132#ordering.
|
626
|
+
# The string value should specify one or more fields in {::Google::Cloud::Bigtable::Admin::V2::Backup Backup}. The full
|
627
|
+
# syntax is described at https://aip.dev/132#ordering.
|
567
628
|
#
|
568
629
|
# Fields supported are:
|
569
630
|
# * name
|
@@ -588,97 +649,27 @@ module Google
|
|
588
649
|
# @!attribute [rw] page_token
|
589
650
|
# @return [::String]
|
590
651
|
# If non-empty, `page_token` should contain a
|
591
|
-
# {::Google::Cloud::Bigtable::Admin::V2::ListBackupsResponse#next_page_token next_page_token}
|
592
|
-
#
|
593
|
-
#
|
594
|
-
# same `parent` and with the same `filter`.
|
652
|
+
# {::Google::Cloud::Bigtable::Admin::V2::ListBackupsResponse#next_page_token next_page_token} from a
|
653
|
+
# previous {::Google::Cloud::Bigtable::Admin::V2::ListBackupsResponse ListBackupsResponse} to the same `parent` and with the same
|
654
|
+
# `filter`.
|
595
655
|
class ListBackupsRequest
|
596
656
|
include ::Google::Protobuf::MessageExts
|
597
657
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
598
658
|
end
|
599
659
|
|
600
|
-
# The response for
|
601
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
660
|
+
# The response for {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
602
661
|
# @!attribute [rw] backups
|
603
662
|
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Backup>]
|
604
663
|
# The list of matching backups.
|
605
664
|
# @!attribute [rw] next_page_token
|
606
665
|
# @return [::String]
|
607
666
|
# `next_page_token` can be sent in a subsequent
|
608
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups} call
|
609
|
-
#
|
667
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups} call to fetch more
|
668
|
+
# of the matching backups.
|
610
669
|
class ListBackupsResponse
|
611
670
|
include ::Google::Protobuf::MessageExts
|
612
671
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
613
672
|
end
|
614
|
-
|
615
|
-
# The request for
|
616
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
617
|
-
# @!attribute [rw] parent
|
618
|
-
# @return [::String]
|
619
|
-
# Required. The name of the instance in which to create the restored
|
620
|
-
# table. This instance must be the parent of the source backup. Values are
|
621
|
-
# of the form `projects/<project>/instances/<instance>`.
|
622
|
-
# @!attribute [rw] table_id
|
623
|
-
# @return [::String]
|
624
|
-
# Required. The id of the table to create and restore to. This
|
625
|
-
# table must not already exist. The `table_id` appended to
|
626
|
-
# `parent` forms the full table name of the form
|
627
|
-
# `projects/<project>/instances/<instance>/tables/<table_id>`.
|
628
|
-
# @!attribute [rw] backup
|
629
|
-
# @return [::String]
|
630
|
-
# Name of the backup from which to restore. Values are of the form
|
631
|
-
# `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
|
632
|
-
class RestoreTableRequest
|
633
|
-
include ::Google::Protobuf::MessageExts
|
634
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
635
|
-
end
|
636
|
-
|
637
|
-
# Metadata type for the long-running operation returned by
|
638
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
639
|
-
# @!attribute [rw] name
|
640
|
-
# @return [::String]
|
641
|
-
# Name of the table being created and restored to.
|
642
|
-
# @!attribute [rw] source_type
|
643
|
-
# @return [::Google::Cloud::Bigtable::Admin::V2::RestoreSourceType]
|
644
|
-
# The type of the restore source.
|
645
|
-
# @!attribute [rw] backup_info
|
646
|
-
# @return [::Google::Cloud::Bigtable::Admin::V2::BackupInfo]
|
647
|
-
# @!attribute [rw] optimize_table_operation_name
|
648
|
-
# @return [::String]
|
649
|
-
# If exists, the name of the long-running operation that will be used to
|
650
|
-
# track the post-restore optimization process to optimize the performance of
|
651
|
-
# the restored table. The metadata type of the long-running operation is
|
652
|
-
# [OptimizeRestoreTableMetadata][]. The response type is
|
653
|
-
# {::Google::Protobuf::Empty Empty}. This long-running operation may be
|
654
|
-
# automatically created by the system if applicable after the
|
655
|
-
# RestoreTable long-running operation completes successfully. This operation
|
656
|
-
# may not be created if the table is already optimized or the restore was
|
657
|
-
# not successful.
|
658
|
-
# @!attribute [rw] progress
|
659
|
-
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
660
|
-
# The progress of the
|
661
|
-
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}
|
662
|
-
# operation.
|
663
|
-
class RestoreTableMetadata
|
664
|
-
include ::Google::Protobuf::MessageExts
|
665
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
666
|
-
end
|
667
|
-
|
668
|
-
# Metadata type for the long-running operation used to track the progress
|
669
|
-
# of optimizations performed on a newly restored table. This long-running
|
670
|
-
# operation is automatically created by the system after the successful
|
671
|
-
# completion of a table restore, and cannot be cancelled.
|
672
|
-
# @!attribute [rw] name
|
673
|
-
# @return [::String]
|
674
|
-
# Name of the restored table being optimized.
|
675
|
-
# @!attribute [rw] progress
|
676
|
-
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
677
|
-
# The progress of the post-restore optimizations.
|
678
|
-
class OptimizeRestoredTableMetadata
|
679
|
-
include ::Google::Protobuf::MessageExts
|
680
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
681
|
-
end
|
682
673
|
end
|
683
674
|
end
|
684
675
|
end
|