Chiebot-Mirror
/
googleapis
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat(spanner): add CMEK fields to backup and database

Browse Source 
PiperOrigin-RevId: 358725120
pull/644/head
Google APIs 4 years ago committed by Copybara-Service
parent af8f71dae9
commit f829b1334c
4 changed files with 366 additions and 129 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      google/spanner/admin/database/v1/BUILD.bazel
  2. 197
      google/spanner/admin/database/v1/backup.proto
  3. 60
      google/spanner/admin/database/v1/common.proto
  4. 236
      google/spanner/admin/database/v1/spanner_database_admin.proto

2
google/spanner/admin/database/v1/BUILD.bazel
Unescape View File

@ -24,6 +24,7 @@ proto_library(
"//google/iam/v1:iam_policy_proto",
"//google/iam/v1:policy_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
"@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
@ -115,6 +116,7 @@ go_proto_library(
"//google/api:annotations_go_proto",
"//google/iam/v1:iam_go_proto",
"//google/longrunning:longrunning_go_proto",
"//google/rpc:status_go_proto",
],
)

197
google/spanner/admin/database/v1/backup.proto
Unescape View File

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -22,7 +22,6 @@ import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/spanner/admin/database/v1/common.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.Spanner.Admin.Database.V1";
option go_package = "google.golang.org/genproto/googleapis/spanner/admin/database/v1;database";
@ -52,14 +51,14 @@ message Backup {
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
// 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"
}];
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
@ -67,7 +66,8 @@ message Backup {
// backup.
google.protobuf.Timestamp version_time = 9;
// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// 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`
@ -75,8 +75,11 @@ message Backup {
// 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.
// 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
@ -90,10 +93,12 @@ message Backup {
// `projects/<project>/instances/<instance>`.
string name = 1;
// Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// 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];
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];
@ -108,10 +113,20 @@ message Backup {
// 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];
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];
}
// The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
// 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
@ -133,23 +148,32 @@ message CreateBackupRequest {
// 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"
}];
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"
}];
type: "spanner.googleapis.com/Database"
}];
// The progress of the
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// operation.
OperationProgress progress = 3;
// The time at which cancellation of this operation was received.
@ -161,12 +185,14 @@ message CreateBackupMetadata {
// 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][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// 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].
// 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.
@ -179,36 +205,36 @@ message UpdateBackupRequest {
// 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];
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
// 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"
}
(google.api.resource_reference) = { type: "spanner.googleapis.com/Backup" }
];
}
// The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
// 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"
}
(google.api.resource_reference) = { type: "spanner.googleapis.com/Backup" }
];
}
// The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
// 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>`.
@ -227,13 +253,16 @@ message ListBackupsRequest {
// 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:
// 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)
// * `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
@ -260,21 +289,23 @@ message ListBackupsRequest {
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`.
// [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].
// 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.
// [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups]
// call to fetch more of the matching backups.
string next_page_token = 2;
}
@ -304,7 +335,9 @@ message ListBackupOperationsRequest {
// * `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
// 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.
// * `error` - Error associated with the long-running operation.
@ -324,7 +357,8 @@ message ListBackupOperationsRequest {
// `(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 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.
@ -336,8 +370,9 @@ message ListBackupOperationsRequest {
// 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`.
// from a previous
// [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse]
// to the same `parent` and with the same `filter`.
string page_token = 4;
}
@ -348,11 +383,11 @@ message ListBackupOperationsResponse {
// operations][google.longrunning.Operation]. Each operation's name will be
// prefixed by the backup's name and the operation's
// [metadata][google.longrunning.Operation.metadata] will be of type
// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. 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.
// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
// 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
@ -364,23 +399,63 @@ message ListBackupOperationsResponse {
// Information about a backup.
message BackupInfo {
// Name of the backup.
string backup = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/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`.
// [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.
// 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"
}];
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"
}
];
}

60
google/spanner/admin/database/v1/common.proto
Unescape View File

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -17,8 +17,9 @@ syntax = "proto3";
package google.spanner.admin.database.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.Spanner.Admin.Database.V1";
option go_package = "google.golang.org/genproto/googleapis/spanner/admin/database/v1;database";
@ -27,6 +28,14 @@ option java_outer_classname = "CommonProto";
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";
option (google.api.resource_definition) = {
type: "cloudkms.googleapis.com/CryptoKey"
pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}"
};
option (google.api.resource_definition) = {
type: "cloudkms.googleapis.com/CryptoKeyVersion"
pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
};
// Encapsulates progress related information for a Cloud Spanner long
// running operation.
@ -42,3 +51,50 @@ message OperationProgress {
// successfully.
google.protobuf.Timestamp end_time = 3;
}
// Encryption configuration for a Cloud Spanner database.
message EncryptionConfig {
// The Cloud KMS key to be used for encrypting and decrypting
// the database. Values are of the form
// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
string kms_key_name = 2 [(google.api.resource_reference) = {
type: "cloudkms.googleapis.com/CryptoKey"
}];
}
// Encryption information for a Cloud Spanner database or backup.
message EncryptionInfo {
// Possible encryption types.
enum Type {
// Encryption type was not specified, though data at rest remains encrypted.
TYPE_UNSPECIFIED = 0;
// The data is encrypted at rest with a key that is
// fully managed by Google. No key version or status will be populated.
// This is the default state.
GOOGLE_DEFAULT_ENCRYPTION = 1;
// The data is encrypted at rest with a key that is
// managed by the customer. The active version of the key. `kms_key_version`
// will be populated, and `encryption_status` may be populated.
CUSTOMER_MANAGED_ENCRYPTION = 2;
}
// Output only. The type of encryption.
Type encryption_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. If present, the status of a recent encrypt/decrypt call on
// underlying data for this database or backup. Regardless of status, data is
// always encrypted at rest.
google.rpc.Status encryption_status = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A Cloud KMS key version that is being used to protect the
// database or backup.
string kms_key_version = 2 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "cloudkms.googleapis.com/CryptoKeyVersion"
}
];
}

236
google/spanner/admin/database/v1/spanner_database_admin.proto
Unescape View File

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -65,10 +65,11 @@ service DatabaseAdmin {
// have a name of the format `<database_name>/operations/<operation_id>` and
// can be used to track preparation of the database. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
// [response][google.longrunning.Operation.response] field type is
// [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata].
// The [response][google.longrunning.Operation.response] field type is
// [Database][google.spanner.admin.database.v1.Database], if successful.
rpc CreateDatabase(CreateDatabaseRequest) returns (google.longrunning.Operation) {
rpc CreateDatabase(CreateDatabaseRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/instances/*}/databases"
body: "*"
@ -94,8 +95,10 @@ service DatabaseAdmin {
// the format `<database_name>/operations/<operation_id>` and can be used to
// track execution of the schema change(s). The
// [metadata][google.longrunning.Operation.metadata] field type is
// [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.
rpc UpdateDatabaseDdl(UpdateDatabaseDdlRequest) returns (google.longrunning.Operation) {
// [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].
// The operation has no response.
rpc UpdateDatabaseDdl(UpdateDatabaseDdlRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{database=projects/*/instances/*/databases/*}/ddl"
body: "*"
@ -134,7 +137,8 @@ service DatabaseAdmin {
// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
// For backups, authorization requires `spanner.backups.setIamPolicy`
// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/instances/*/databases/*}:setIamPolicy"
body: "*"
@ -154,7 +158,8 @@ service DatabaseAdmin {
// [resource][google.iam.v1.GetIamPolicyRequest.resource].
// For backups, authorization requires `spanner.backups.getIamPolicy`
// permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/instances/*/databases/*}:getIamPolicy"
body: "*"
@ -176,7 +181,8 @@ service DatabaseAdmin {
// Calling this method on a backup that does not exist will
// result in a NOT_FOUND error if the user has
// `spanner.backups.list` permission on the containing instance.
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/instances/*/databases/*}:testIamPermissions"
body: "*"
@ -194,12 +200,12 @@ service DatabaseAdmin {
// `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
// and can be used to track creation of the backup. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
// [response][google.longrunning.Operation.response] field type is
// [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
// creation and delete the backup.
// There can be only one pending backup creation per database. Backup creation
// of different databases can run concurrently.
// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
// The [response][google.longrunning.Operation.response] field type is
// [Backup][google.spanner.admin.database.v1.Backup], if successful.
// Cancelling the returned operation will stop the creation and delete the
// backup. There can be only one pending backup creation per database. Backup
// creation of different databases can run concurrently.
rpc CreateBackup(CreateBackupRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/instances/*}/backups"
@ -212,7 +218,8 @@ service DatabaseAdmin {
};
}
// Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
// Gets metadata on a pending or completed
// [Backup][google.spanner.admin.database.v1.Backup].
rpc GetBackup(GetBackupRequest) returns (Backup) {
option (google.api.http) = {
get: "/v1/{name=projects/*/instances/*/backups/*}"
@ -220,7 +227,8 @@ service DatabaseAdmin {
option (google.api.method_signature) = "name";
}
// Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
// Updates a pending or completed
// [Backup][google.spanner.admin.database.v1.Backup].
rpc UpdateBackup(UpdateBackupRequest) returns (Backup) {
option (google.api.http) = {
patch: "/v1/{backup.name=projects/*/instances/*/backups/*}"
@ -229,7 +237,8 @@ service DatabaseAdmin {
option (google.api.method_signature) = "backup,update_mask";
}
// Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
// Deletes a pending or completed
// [Backup][google.spanner.admin.database.v1.Backup].
rpc DeleteBackup(DeleteBackupRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/instances/*/backups/*}"
@ -264,7 +273,8 @@ service DatabaseAdmin {
// Once the restore operation completes, a new restore operation can be
// initiated, without waiting for the optimize operation associated with the
// first restore to complete.
rpc RestoreDatabase(RestoreDatabaseRequest) returns (google.longrunning.Operation) {
rpc RestoreDatabase(RestoreDatabaseRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/instances/*}/databases:restore"
body: "*"
@ -284,7 +294,8 @@ service DatabaseAdmin {
// `metadata.type_url` describes the type of the metadata. Operations returned
// include those that have completed/failed/canceled within the last 7 days,
// and pending operations.
rpc ListDatabaseOperations(ListDatabaseOperationsRequest) returns (ListDatabaseOperationsResponse) {
rpc ListDatabaseOperations(ListDatabaseOperationsRequest)
returns (ListDatabaseOperationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/instances/*}/databaseOperations"
};
@ -301,7 +312,8 @@ service DatabaseAdmin {
// and pending operations. Operations returned are ordered by
// `operation.metadata.value.progress.start_time` in descending order starting
// from the most recently started operation.
rpc ListBackupOperations(ListBackupOperationsRequest) returns (ListBackupOperationsResponse) {
rpc ListBackupOperations(ListBackupOperationsRequest)
returns (ListBackupOperationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/instances/*}/backupOperations"
};
@ -363,25 +375,51 @@ message Database {
State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. If exists, the time at which the database creation started.
google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Applicable only for restored databases. Contains information
// about the restore source.
RestoreInfo restore_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. For databases that are using customer managed encryption, this
// field contains the encryption configuration for the database.
// For databases that are using Google default or other types of encryption,
// this field is empty.
EncryptionConfig encryption_config = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. For databases that are using customer managed encryption, this
// field contains the encryption information for the database, such as
// encryption state and the Cloud KMS key versions that are in use.
//
// For databases that are using Google default or other types of encryption,
// this field is empty.
//
// This field is propagated lazily from the backend. There might be a delay
// from when a key version is being used and when it appears in this field.
repeated EncryptionInfo encryption_info = 8
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The period in which Cloud Spanner retains all versions of data
// for the database. This is the same as the value of version_retention_period
// database option set using
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
// if not set.
string version_retention_period = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
// Defaults to 1 hour, if not set.
string version_retention_period = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Earliest timestamp at which older versions of the data can be
// read.
google.protobuf.Timestamp earliest_version_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// read. This value is continuously updated by Cloud Spanner and becomes stale
// the moment it is queried. If you are using this value to recover data, make
// sure to account for the time from the moment when the value is queried to
// the moment when you initiate the recovery.
google.protobuf.Timestamp earliest_version_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
// The request for
// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
message ListDatabasesRequest {
// Required. The instance whose databases should be listed.
// Values are of the form `projects/<project>/instances/<instance>`.
@ -397,23 +435,26 @@ message ListDatabasesRequest {
int32 page_size = 3;
// If non-empty, `page_token` should contain a
// [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a
// previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].
// [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token]
// from a previous
// [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].
string page_token = 4;
}
// The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
// The response for
// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
message ListDatabasesResponse {
// Databases that matched the request.
repeated Database databases = 1;
// `next_page_token` can be sent in a subsequent
// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more
// of the matching databases.
// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases]
// call to fetch more of the matching databases.
string next_page_token = 2;
}
// The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
// The request for
// [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
message CreateDatabaseRequest {
// Required. The name of the instance that will serve the new database.
// Values are of the form `projects/<project>/instances/<instance>`.
@ -436,6 +477,12 @@ message CreateDatabaseRequest {
// statements execute atomically with the creation of the database:
// if there is an error in any statement, the database is not created.
repeated string extra_statements = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The encryption configuration for the database. If this field is
// not specified, Cloud Spanner will encrypt/decrypt all data at rest using
// Google default encryption.
EncryptionConfig encryption_config = 4
[(google.api.field_behavior) = OPTIONAL];
}
// Metadata type for the operation returned by
@ -443,11 +490,12 @@ message CreateDatabaseRequest {
message CreateDatabaseMetadata {
// The database being created.
string database = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
type: "spanner.googleapis.com/Database"
}];
}
// The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
// The request for
// [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
message GetDatabaseRequest {
// Required. The name of the requested database. Values are of the form
// `projects/<project>/instances/<instance>/databases/<database>`.
@ -473,8 +521,8 @@ message GetDatabaseRequest {
// Each batch of statements is assigned a name which can be used with
// the [Operations][google.longrunning.Operations] API to monitor
// progress. See the
// [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more
// details.
// [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id]
// field for more details.
message UpdateDatabaseDdlRequest {
// Required. The database to update.
string database = 1 [
@ -494,18 +542,20 @@ message UpdateDatabaseDdlRequest {
//
// Specifying an explicit operation ID simplifies determining
// whether the statements were executed in the event that the
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] call is replayed,
// or the return value is otherwise lost: the [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database] and
// `operation_id` fields can be combined to form the
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
// call is replayed, or the return value is otherwise lost: the
// [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database]
// and `operation_id` fields can be combined to form the
// [name][google.longrunning.Operation.name] of the resulting
// [longrunning.Operation][google.longrunning.Operation]: `<database>/operations/<operation_id>`.
// [longrunning.Operation][google.longrunning.Operation]:
// `<database>/operations/<operation_id>`.
//
// `operation_id` should be unique within the database, and must be
// a valid identifier: `[a-z][a-z0-9_]*`. Note that
// automatically-generated operation IDs always begin with an
// underscore. If the named operation already exists,
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] returns
// `ALREADY_EXISTS`.
// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
// returns `ALREADY_EXISTS`.
string operation_id = 3;
}
@ -514,8 +564,8 @@ message UpdateDatabaseDdlRequest {
message UpdateDatabaseDdlMetadata {
// The database being modified.
string database = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
type: "spanner.googleapis.com/Database"
}];
// For an update this list contains all the statements. For an
// individual statement, this list contains only that statement.
@ -532,7 +582,8 @@ message UpdateDatabaseDdlMetadata {
bool throttled = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
// The request for
// [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
message DropDatabaseRequest {
// Required. The database to be dropped.
string database = 1 [
@ -543,7 +594,8 @@ message DropDatabaseRequest {
];
}
// The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
// The request for
// [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
message GetDatabaseDdlRequest {
// Required. The database whose schema we wish to get.
// Values are of the form
@ -556,7 +608,8 @@ message GetDatabaseDdlRequest {
];
}
// The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
// The response for
// [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
message GetDatabaseDdlResponse {
// A list of formatted DDL statements defining the schema of the database
// specified in the request.
@ -589,7 +642,9 @@ message ListDatabaseOperationsRequest {
// * `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 [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is
// for
// [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]
// is
// `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
// * `metadata.<field_name>` - any field in metadata.value.
// * `error` - Error associated with the long-running operation.
@ -609,7 +664,8 @@ message ListDatabaseOperationsRequest {
// `(metadata.name:restored_howl) AND` \
// `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
// `(error:*)` - Return operations where:
// * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
// * The operation's metadata type is
// [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
// * The database is restored from a backup.
// * The backup name contains "backup_howl".
// * The restored database's name contains "restored_howl".
@ -623,8 +679,9 @@ message ListDatabaseOperationsRequest {
// If non-empty, `page_token` should contain a
// [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token]
// from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the
// same `parent` and with the same `filter`.
// from a previous
// [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse]
// to the same `parent` and with the same `filter`.
string page_token = 4;
}
@ -670,9 +727,54 @@ message RestoreDatabaseRequest {
// Name of the backup from which to restore. Values are of the form
// `projects/<project>/instances/<instance>/backups/<backup>`.
string backup = 3 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Backup"
}];
type: "spanner.googleapis.com/Backup"
}];
}
// Optional. An encryption configuration describing the encryption type and
// key resources in Cloud KMS used to encrypt/decrypt the database to restore
// to. If this field is not specified, the restored database will use the same
// encryption configuration as the backup by default, namely
// [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type]
// = `USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION`.
RestoreDatabaseEncryptionConfig encryption_config = 4
[(google.api.field_behavior) = OPTIONAL];
}
// Encryption configuration for the restored database.
message RestoreDatabaseEncryptionConfig {
// Encryption types for the database to be restored.
enum EncryptionType {
// Unspecified. Do not use.
ENCRYPTION_TYPE_UNSPECIFIED = 0;
// This is the default option when
// [encryption_config][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig]
// is not specified.
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
// must contain a valid Cloud KMS key.
CUSTOMER_MANAGED_ENCRYPTION = 3;
}
// Required. The encryption type of the restored database.
EncryptionType encryption_type = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. The Cloud KMS key that will be used to encrypt/decrypt the
// restored database. This field should be set only when
// [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.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"
}
];
}
// Metadata type for the long-running operation returned by
@ -680,14 +782,15 @@ message RestoreDatabaseRequest {
message RestoreDatabaseMetadata {
// Name of the database being created and restored to.
string name = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
type: "spanner.googleapis.com/Database"
}];
// The type of the restore source.
RestoreSourceType source_type = 2;
// Information about the source used to restore the database, as specified by
// `source` in [RestoreDatabaseRequest][google.spanner.admin.database.v1.RestoreDatabaseRequest].
// `source` in
// [RestoreDatabaseRequest][google.spanner.admin.database.v1.RestoreDatabaseRequest].
oneof source_info {
// Information about the backup used to restore the database.
BackupInfo backup_info = 3;
@ -708,7 +811,8 @@ message RestoreDatabaseMetadata {
// 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.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`.
google.protobuf.Timestamp cancel_time = 5;
// If exists, the name of the long-running operation that will be used to
@ -718,10 +822,10 @@ message RestoreDatabaseMetadata {
// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
// where the <database> is the name of database being created and restored to.
// The metadata type of the long-running operation is
// [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata]. This long-running operation will be
// automatically created by the system after the RestoreDatabase long-running
// operation completes successfully. This operation will not be created if the
// restore was not successful.
// [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata].
// This long-running operation will be automatically created by the system
// after the RestoreDatabase long-running operation completes successfully.
// This operation will not be created if the restore was not successful.
string optimize_database_operation_name = 6;
}
@ -732,8 +836,8 @@ message RestoreDatabaseMetadata {
message OptimizeRestoredDatabaseMetadata {
// Name of the restored database being optimized.
string name = 1 [(google.api.resource_reference) = {
type: "spanner.googleapis.com/Database"
}];
type: "spanner.googleapis.com/Database"
}];
// The progress of the post-restore optimizations.
OperationProgress progress = 2;

Write Preview
Loading…
Cancel
Save