You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.</p>
<pre>Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
119
+
120
+
Args:
121
+
parent: string, Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
122
+
body: object, The request body.
123
+
The object takes the form of:
124
+
125
+
{ # The request for CopyBackup.
126
+
"backupId": "A String", # Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
127
+
"expireTime": "A String", # Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
128
+
"sourceBackup": "A String", # Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. 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//instances//clusters//backups/`.
129
+
}
130
+
131
+
x__xgafv: string, V1 error format.
132
+
Allowed values
133
+
1 - v1 error format
134
+
2 - v2 error format
135
+
136
+
Returns:
137
+
An object of the form:
138
+
139
+
{ # This resource represents a long-running operation that is the result of a network API call.
140
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
141
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
142
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
143
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
144
+
{
145
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
146
+
},
147
+
],
148
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
149
+
},
150
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
151
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
152
+
},
153
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
154
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
155
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
@@ -137,6 +184,7 @@ <h3>Method Details</h3>
137
184
"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
138
185
"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
139
186
"sizeBytes": "A String", # Output only. Size of the backup in bytes.
187
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
140
188
"sourceTable": "A String", # Required. Immutable. Name of the table 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}/tables/{source_table}`.
141
189
"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
142
190
"state": "A String", # Output only. The current state of the backup.
@@ -222,6 +270,7 @@ <h3>Method Details</h3>
222
270
"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
223
271
"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
224
272
"sizeBytes": "A String", # Output only. Size of the backup in bytes.
273
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
225
274
"sourceTable": "A String", # Required. Immutable. Name of the table 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}/tables/{source_table}`.
226
275
"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
227
276
"state": "A String", # Output only. The current state of the backup.
@@ -322,6 +371,7 @@ <h3>Method Details</h3>
322
371
"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
323
372
"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
324
373
"sizeBytes": "A String", # Output only. Size of the backup in bytes.
374
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
325
375
"sourceTable": "A String", # Required. Immutable. Name of the table 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}/tables/{source_table}`.
326
376
"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
327
377
"state": "A String", # Output only. The current state of the backup.
@@ -372,6 +422,7 @@ <h3>Method Details</h3>
372
422
"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
373
423
"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
374
424
"sizeBytes": "A String", # Output only. Size of the backup in bytes.
425
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
375
426
"sourceTable": "A String", # Required. Immutable. Name of the table 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}/tables/{source_table}`.
376
427
"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
377
428
"state": "A String", # Output only. The current state of the backup.
@@ -404,6 +455,7 @@ <h3>Method Details</h3>
404
455
"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
405
456
"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
406
457
"sizeBytes": "A String", # Output only. Size of the backup in bytes.
458
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
407
459
"sourceTable": "A String", # Required. Immutable. Name of the table 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}/tables/{source_table}`.
408
460
"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
409
461
"state": "A String", # Output only. The current state of the backup.
Copy file name to clipboardexpand all lines: docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+5
Original file line number
Diff line number
Diff line change
@@ -211,6 +211,7 @@ <h3>Method Details</h3>
211
211
"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
212
212
"backup": "A String", # Output only. Name of the backup.
213
213
"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
214
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
214
215
"sourceTable": "A String", # Output only. Name of the table the backup was created from.
215
216
"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
216
217
},
@@ -273,6 +274,7 @@ <h3>Method Details</h3>
273
274
"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
274
275
"backup": "A String", # Output only. Name of the backup.
275
276
"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
277
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
276
278
"sourceTable": "A String", # Output only. Name of the table the backup was created from.
277
279
"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
278
280
},
@@ -417,6 +419,7 @@ <h3>Method Details</h3>
417
419
"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
418
420
"backup": "A String", # Output only. Name of the backup.
419
421
"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
422
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
420
423
"sourceTable": "A String", # Output only. Name of the table the backup was created from.
421
424
"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
422
425
},
@@ -553,6 +556,7 @@ <h3>Method Details</h3>
553
556
"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
554
557
"backup": "A String", # Output only. Name of the backup.
555
558
"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
559
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
556
560
"sourceTable": "A String", # Output only. Name of the table the backup was created from.
557
561
"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
558
562
},
@@ -680,6 +684,7 @@ <h3>Method Details</h3>
680
684
"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
681
685
"backup": "A String", # Output only. Name of the backup.
682
686
"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
687
+
"sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
683
688
"sourceTable": "A String", # Output only. Name of the table the backup was created from.
684
689
"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
0 commit comments