-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
backup.proto
609 lines (540 loc) · 27.8 KB
/
backup.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.spanner.admin.database.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/spanner/admin/database/v1/common.proto";
option csharp_namespace = "Google.Cloud.Spanner.Admin.Database.V1";
option go_package = "cloud.google.com/go/spanner/admin/database/apiv1/databasepb;databasepb";
option java_multiple_files = true;
option java_outer_classname = "BackupProto";
option java_package = "com.google.spanner.admin.database.v1";
option php_namespace = "Google\\Cloud\\Spanner\\Admin\\Database\\V1";
option ruby_package = "Google::Cloud::Spanner::Admin::Database::V1";
// A backup of a Cloud Spanner database.
message Backup {
option (google.api.resource) = {
type: "spanner.googleapis.com/Backup"
pattern: "projects/{project}/instances/{instance}/backups/{backup}"
};
// Indicates the current state of the backup.
enum State {
// Not specified.
STATE_UNSPECIFIED = 0;
// The pending backup is still being created. Operations on the
// backup may fail with `FAILED_PRECONDITION` in this state.
CREATING = 1;
// The backup is complete and ready for use.
READY = 2;
}
// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
// Name of the database from which this backup was
// created. This needs to be in the same instance as the backup.
// Values are of the form
// `projects/<project>/instances/<instance>/databases/<database>`.
string database = 2 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
// The backup will contain an externally consistent copy of the database at
// the timestamp specified by `version_time`. If `version_time` is not
// specified, the system will set `version_time` to the `create_time` of the
// backup.
google.protobuf.Timestamp version_time = 9;
// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// operation. The expiration time of the backup, with microseconds
// granularity that must be at least 6 hours and at most 366 days
// from the time the CreateBackup request is processed. Once the `expire_time`
// has passed, the backup is eligible to be automatically deleted by Cloud
// Spanner to free the resources used by the backup.
google.protobuf.Timestamp expire_time = 3;
// Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
// Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.
//
// A globally unique identifier for the backup which cannot be
// changed. Values are of the form
// `projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9]`
// The final segment of the name must be between 2 and 60 characters
// in length.
//
// The backup is stored in the location(s) specified in the instance
// configuration of the instance containing the backup, identified
// by the prefix of the backup name of the form
// `projects/<project>/instances/<instance>`.
string name = 1;
// Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// request is received. If the request does not specify `version_time`, the
// `version_time` of the backup will be equivalent to the `create_time`.
google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The current state of the backup.
State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The names of the restored databases that reference the backup.
// The database names are of
// the form `projects/<project>/instances/<instance>/databases/<database>`.
// Referencing databases may exist in different instances. The existence of
// any referencing database prevents the backup from being deleted. When a
// restored database from the backup enters the `READY` state, the reference
// to the backup is removed.
repeated string referencing_databases = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}
];
// Output only. The encryption information for the backup.
EncryptionInfo encryption_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The database dialect information for the backup.
DatabaseDialect database_dialect = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The names of the destination backups being created by copying
// this source backup. The backup names are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
// Referencing backups may exist in different instances. The existence of
// any referencing backup prevents the backup from being deleted. When the
// copy operation is done (either successfully completed or cancelled or the
// destination backup is deleted), the reference to the backup is removed.
repeated string referencing_backups = 11 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}
];
// Output only. The max allowed expiration time of the backup, with
// microseconds granularity. A backup's expiration time can be configured in
// multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
// copying an existing backup, the expiration time specified must be
// less than `Backup.max_expire_time`.
google.protobuf.Timestamp max_expire_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
message CreateBackupRequest {
// Required. The name of the instance in which the backup will be
// created. This must be the same instance that contains the database the
// backup will be created from. The backup will be stored in the
// location(s) specified in the instance configuration of this
// instance. Values are of the form
// `projects/<project>/instances/<instance>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Instance"
}
];
// Required. The id of the backup to be created. The `backup_id` appended to
// `parent` forms the full backup name of the form
// `projects/<project>/instances/<instance>/backups/<backup_id>`.
string backup_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The backup to create.
Backup backup = 3 [(google.api.field_behavior) = REQUIRED];
// Optional. The encryption configuration used to encrypt the backup. If this field is
// not specified, the backup will use the same
// encryption configuration as the database by default, namely
// [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] =
// `USE_DATABASE_ENCRYPTION`.
CreateBackupEncryptionConfig encryption_config = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Metadata type for the operation returned by
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
message CreateBackupMetadata {
// The name of the backup being created.
string name = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}];
// The name of the database the backup is created from.
string database = 2 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
// The progress of the
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
OperationProgress progress = 3;
// The time at which cancellation of this operation was received.
// [Operations.CancelOperation][google.longrunning.Operations.CancelOperation]
// starts asynchronous cancellation on a long-running operation. The server
// makes a best effort to cancel the operation, but success is not guaranteed.
// Clients can use
// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
// other methods to check whether the cancellation succeeded or whether the
// operation completed despite cancellation. On successful cancellation,
// the operation is not deleted; instead, it becomes an operation with
// an [Operation.error][google.longrunning.Operation.error] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
google.protobuf.Timestamp cancel_time = 4;
}
// The request for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
message CopyBackupRequest {
// Required. The name of the destination instance that will contain the backup copy.
// Values are of the form: `projects/<project>/instances/<instance>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Instance"
}
];
// Required. The id of the backup copy.
// The `backup_id` appended to `parent` forms the full backup_uri of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string backup_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The source backup to be copied.
// The source backup needs to be in READY state for it to be copied.
// Once CopyBackup is in progress, the source backup cannot be deleted or
// cleaned up on expiration until CopyBackup is finished.
// Values are of the form:
// `projects/<project>/instances/<instance>/backups/<backup>`.
string source_backup = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}
];
// Required. The expiration time of the backup in microsecond granularity.
// The expiration time must be at least 6 hours and at most 366 days
// from the `create_time` of the source backup. Once the `expire_time` has
// passed, the backup is eligible to be automatically deleted by Cloud Spanner
// to free the resources used by the backup.
google.protobuf.Timestamp expire_time = 4 [(google.api.field_behavior) = REQUIRED];
// Optional. The encryption configuration used to encrypt the backup. If this field is
// not specified, the backup will use the same
// encryption configuration as the source backup by default, namely
// [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
// `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
CopyBackupEncryptionConfig encryption_config = 5 [(google.api.field_behavior) = OPTIONAL];
}
// Metadata type for the google.longrunning.Operation returned by
// [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
message CopyBackupMetadata {
// The name of the backup being created through the copy operation.
// Values are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string name = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}];
// The name of the source backup that is being copied.
// Values are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string source_backup = 2 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}];
// The progress of the
// [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] operation.
OperationProgress progress = 3;
// The time at which cancellation of CopyBackup operation was received.
// [Operations.CancelOperation][google.longrunning.Operations.CancelOperation]
// starts asynchronous cancellation on a long-running operation. The server
// makes a best effort to cancel the operation, but success is not guaranteed.
// Clients can use
// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
// other methods to check whether the cancellation succeeded or whether the
// operation completed despite cancellation. On successful cancellation,
// the operation is not deleted; instead, it becomes an operation with
// an [Operation.error][google.longrunning.Operation.error] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
google.protobuf.Timestamp cancel_time = 4;
}
// The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
message UpdateBackupRequest {
// Required. The backup to update. `backup.name`, and the fields to be updated
// as specified by `update_mask` are required. Other fields are ignored.
// Update is only supported for the following fields:
// * `backup.expire_time`.
Backup backup = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A mask specifying which fields (e.g. `expire_time`) in the
// Backup resource should be updated. This mask is relative to the Backup
// resource, not to the request message. The field mask must always be
// specified; this prevents any future fields from being erased accidentally
// by clients that do not know about them.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}
// The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
message GetBackupRequest {
// Required. Name of the backup.
// Values are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}
];
}
// The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
message DeleteBackupRequest {
// Required. Name of the backup to delete.
// Values are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}
];
}
// The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
message ListBackupsRequest {
// Required. The instance to list backups from. Values are of the
// form `projects/<project>/instances/<instance>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Instance"
}
];
// An expression that filters the list of returned backups.
//
// A filter expression consists of a field name, a comparison operator, and a
// value for filtering.
// The value must be a string, a number, or a boolean. The comparison operator
// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
// Colon `:` is the contains operator. Filter rules are not case sensitive.
//
// The following fields in the [Backup][google.spanner.admin.database.v1.Backup] are eligible for filtering:
//
// * `name`
// * `database`
// * `state`
// * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `size_bytes`
//
// You can combine multiple expressions by enclosing each expression in
// parentheses. By default, expressions are combined with AND logic, but
// you can specify AND, OR, and NOT logic explicitly.
//
// Here are a few examples:
//
// * `name:Howl` - The backup's name contains the string "howl".
// * `database:prod`
// - The database's name contains the string "prod".
// * `state:CREATING` - The backup is pending creation.
// * `state:READY` - The backup is fully created and ready for use.
// * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
// - The backup name contains the string "howl" and `create_time`
// of the backup is before 2018-03-28T14:50:00Z.
// * `expire_time < \"2018-03-28T14:50:00Z\"`
// - The backup `expire_time` is before 2018-03-28T14:50:00Z.
// * `size_bytes > 10000000000` - The backup's size is greater than 10GB
string filter = 2;
// Number of backups to be returned in the response. If 0 or
// less, defaults to the server's maximum allowed page size.
int32 page_size = 3;
// If non-empty, `page_token` should contain a
// [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
// previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
// `filter`.
string page_token = 4;
}
// The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
message ListBackupsResponse {
// The list of matching backups. Backups returned are ordered by `create_time`
// in descending order, starting from the most recent `create_time`.
repeated Backup backups = 1;
// `next_page_token` can be sent in a subsequent
// [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups] call to fetch more
// of the matching backups.
string next_page_token = 2;
}
// The request for
// [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
message ListBackupOperationsRequest {
// Required. The instance of the backup operations. Values are of
// the form `projects/<project>/instances/<instance>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "spanner.googleapis.com/Instance"
}
];
// An expression that filters the list of returned backup operations.
//
// A filter expression consists of a field name, a
// comparison operator, and a value for filtering.
// The value must be a string, a number, or a boolean. The comparison operator
// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
// Colon `:` is the contains operator. Filter rules are not case sensitive.
//
// The following fields in the [operation][google.longrunning.Operation]
// are eligible for filtering:
//
// * `name` - The name of the long-running operation
// * `done` - False if the operation is in progress, else true.
// * `metadata.@type` - the type of metadata. For example, the type string
// for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
// `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
// * `metadata.<field_name>` - any field in metadata.value.
// `metadata.@type` must be specified first if filtering on metadata
// fields.
// * `error` - Error associated with the long-running operation.
// * `response.@type` - the type of response.
// * `response.<field_name>` - any field in response.value.
//
// You can combine multiple expressions by enclosing each expression in
// parentheses. By default, expressions are combined with AND logic, but
// you can specify AND, OR, and NOT logic explicitly.
//
// Here are a few examples:
//
// * `done:true` - The operation is complete.
// * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
// `metadata.database:prod` - Returns operations where:
// * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
// * The database the backup was taken from has a name containing the
// string "prod".
// * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
// `(metadata.name:howl) AND` \
// `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
// `(error:*)` - Returns operations where:
// * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
// * The backup name contains the string "howl".
// * The operation started before 2018-03-28T14:50:00Z.
// * The operation resulted in an error.
// * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
// `(metadata.source_backup:test) AND` \
// `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
// `(error:*)` - Returns operations where:
// * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
// * The source backup of the copied backup name contains the string
// "test".
// * The operation started before 2022-01-18T14:50:00Z.
// * The operation resulted in an error.
// * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
// `(metadata.database:test_db)) OR` \
// `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
// AND` \
// `(metadata.source_backup:test_bkp)) AND` \
// `(error:*)` - Returns operations where:
// * The operation's metadata matches either of criteria:
// * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the
// database the backup was taken from has name containing string
// "test_db"
// * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the
// backup the backup was copied from has name containing string
// "test_bkp"
// * The operation resulted in an error.
string filter = 2;
// Number of operations to be returned in the response. If 0 or
// less, defaults to the server's maximum allowed page size.
int32 page_size = 3;
// If non-empty, `page_token` should contain a
// [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token]
// from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the
// same `parent` and with the same `filter`.
string page_token = 4;
}
// The response for
// [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
message ListBackupOperationsResponse {
// The list of matching backup [long-running
// operations][google.longrunning.Operation]. Each operation's name will be
// prefixed by the backup's name. The operation's
// [metadata][google.longrunning.Operation.metadata] field type
// `metadata.type_url` describes the type of the metadata. Operations returned
// include those that are pending or have completed/failed/canceled within the
// last 7 days. Operations returned are ordered by
// `operation.metadata.value.progress.start_time` in descending order starting
// from the most recently started operation.
repeated google.longrunning.Operation operations = 1;
// `next_page_token` can be sent in a subsequent
// [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations]
// call to fetch more of the matching metadata.
string next_page_token = 2;
}
// Information about a backup.
message BackupInfo {
// Name of the backup.
string backup = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}];
// The backup contains an externally consistent copy of `source_database` at
// the timestamp specified by `version_time`. If the
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
// `version_time`, the `version_time` of the backup is equivalent to the
// `create_time`.
google.protobuf.Timestamp version_time = 4;
// The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
// received.
google.protobuf.Timestamp create_time = 2;
// Name of the database the backup was created from.
string source_database = 3 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
}
// Encryption configuration for the backup to create.
message CreateBackupEncryptionConfig {
// Encryption types for the backup.
enum EncryptionType {
// Unspecified. Do not use.
ENCRYPTION_TYPE_UNSPECIFIED = 0;
// Use the same encryption configuration as the database. This is the
// default option when
// [encryption_config][google.spanner.admin.database.v1.CreateBackupEncryptionConfig] is empty.
// For example, if the database is using `Customer_Managed_Encryption`, the
// backup will be using the same Cloud KMS key as the database.
USE_DATABASE_ENCRYPTION = 1;
// Use Google default encryption.
GOOGLE_DEFAULT_ENCRYPTION = 2;
// Use customer managed encryption. If specified, `kms_key_name`
// must contain a valid Cloud KMS key.
CUSTOMER_MANAGED_ENCRYPTION = 3;
}
// Required. The encryption type of the backup.
EncryptionType encryption_type = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. The Cloud KMS key that will be used to protect the backup.
// This field should be set only when
// [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] is
// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
string kms_key_name = 2 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "cloudkms.googleapis.com/CryptoKey"
}
];
}
// Encryption configuration for the copied backup.
message CopyBackupEncryptionConfig {
// Encryption types for the backup.
enum EncryptionType {
// Unspecified. Do not use.
ENCRYPTION_TYPE_UNSPECIFIED = 0;
// This is the default option for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup]
// when [encryption_config][google.spanner.admin.database.v1.CopyBackupEncryptionConfig] is not specified.
// For example, if the source backup is using `Customer_Managed_Encryption`,
// the backup will be using the same Cloud KMS key as the source backup.
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1;
// Use Google default encryption.
GOOGLE_DEFAULT_ENCRYPTION = 2;
// Use customer managed encryption. If specified, `kms_key_name`
// must contain a valid Cloud KMS key.
CUSTOMER_MANAGED_ENCRYPTION = 3;
}
// Required. The encryption type of the backup.
EncryptionType encryption_type = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. The Cloud KMS key that will be used to protect the backup.
// This field should be set only when
// [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] is
// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
string kms_key_name = 2 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "cloudkms.googleapis.com/CryptoKey"
}
];
}