Skip to content

Commit

Permalink
feat(bigtableadmin): update the api
Browse files Browse the repository at this point in the history
#### bigtableadmin:v2

The following keys were added:
- resources.projects.resources.instances.resources.clusters.resources.backups.methods.copy (Total Keys: 12)
- schemas.Backup.properties.sourceBackup (Total Keys: 2)
- schemas.BackupInfo.properties.sourceBackup (Total Keys: 2)
- schemas.CopyBackupMetadata (Total Keys: 5)
- schemas.CopyBackupRequest (Total Keys: 6)
  • Loading branch information
yoshi-automation committed Oct 25, 2022
1 parent e7a8f0e commit 4b424cf
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 1 deletion.
52 changes: 52 additions & 0 deletions docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html
Expand Up @@ -77,6 +77,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#copy">copy(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.</p>
<p class="toc_element">
<code><a href="#create">create(parent, backupId=None, body=None, x__xgafv=None)</a></code></p>
<p class="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>
Expand Down Expand Up @@ -110,6 +113,50 @@ <h3>Method Details</h3>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="copy">copy(parent, body=None, x__xgafv=None)</code>
<pre>Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Args:
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)
body: object, The request body.
The object takes the form of:

{ # The request for CopyBackup.
&quot;backupId&quot;: &quot;A String&quot;, # 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*.
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/`.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>

<div class="method">
<code class="details" id="create">create(parent, backupId=None, body=None, x__xgafv=None)</code>
<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.
Expand Down Expand Up @@ -137,6 +184,7 @@ <h3>Method Details</h3>
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # 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}`.
&quot;startTime&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
Expand Down Expand Up @@ -222,6 +270,7 @@ <h3>Method Details</h3>
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # 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}`.
&quot;startTime&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
Expand Down Expand Up @@ -322,6 +371,7 @@ <h3>Method Details</h3>
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # 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}`.
&quot;startTime&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
Expand Down Expand Up @@ -372,6 +422,7 @@ <h3>Method Details</h3>
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # 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}`.
&quot;startTime&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
Expand Down Expand Up @@ -404,6 +455,7 @@ <h3>Method Details</h3>
&quot;expireTime&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # 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}`.
&quot;startTime&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
Expand Down
5 changes: 5 additions & 0 deletions docs/dyn/bigtableadmin_v2.projects.instances.tables.html
Expand Up @@ -211,6 +211,7 @@ <h3>Method Details</h3>
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
&quot;backup&quot;: &quot;A String&quot;, # Output only. Name of the backup.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # Output only. Name of the table the backup was created from.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
},
Expand Down Expand Up @@ -273,6 +274,7 @@ <h3>Method Details</h3>
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
&quot;backup&quot;: &quot;A String&quot;, # Output only. Name of the backup.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # Output only. Name of the table the backup was created from.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
},
Expand Down Expand Up @@ -417,6 +419,7 @@ <h3>Method Details</h3>
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
&quot;backup&quot;: &quot;A String&quot;, # Output only. Name of the backup.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # Output only. Name of the table the backup was created from.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
},
Expand Down Expand Up @@ -553,6 +556,7 @@ <h3>Method Details</h3>
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
&quot;backup&quot;: &quot;A String&quot;, # Output only. Name of the backup.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # Output only. Name of the table the backup was created from.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
},
Expand Down Expand Up @@ -680,6 +684,7 @@ <h3>Method Details</h3>
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
&quot;backup&quot;: &quot;A String&quot;, # Output only. Name of the backup.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
&quot;sourceBackup&quot;: &quot;A String&quot;, # 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/.
&quot;sourceTable&quot;: &quot;A String&quot;, # Output only. Name of the table the backup was created from.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
},
Expand Down

0 comments on commit 4b424cf

Please sign in to comment.