diff --git a/Spanner/metadata/Admin/Database/V1/Backup.php b/Spanner/metadata/Admin/Database/V1/Backup.php index 925eac7804bb..b610f628c771 100644 Binary files a/Spanner/metadata/Admin/Database/V1/Backup.php and b/Spanner/metadata/Admin/Database/V1/Backup.php differ diff --git a/Spanner/metadata/Admin/Database/V1/Common.php b/Spanner/metadata/Admin/Database/V1/Common.php index b7f5b1b667b9..121b65ff92ab 100644 Binary files a/Spanner/metadata/Admin/Database/V1/Common.php and b/Spanner/metadata/Admin/Database/V1/Common.php differ diff --git a/Spanner/metadata/Admin/Database/V1/SpannerDatabaseAdmin.php b/Spanner/metadata/Admin/Database/V1/SpannerDatabaseAdmin.php index 6f7e316121a7..b1a561e387ec 100644 Binary files a/Spanner/metadata/Admin/Database/V1/SpannerDatabaseAdmin.php and b/Spanner/metadata/Admin/Database/V1/SpannerDatabaseAdmin.php differ diff --git a/Spanner/src/Admin/Database/V1/Backup.php b/Spanner/src/Admin/Database/V1/Backup.php index e204aa6759d0..d1826bc0e8a5 100644 --- a/Spanner/src/Admin/Database/V1/Backup.php +++ b/Spanner/src/Admin/Database/V1/Backup.php @@ -16,10 +16,10 @@ class Backup extends \Google\Protobuf\Internal\Message { /** - * 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//instances//databases/`. * * Generated from protobuf field string database = 2 [(.google.api.resource_reference) = { @@ -35,7 +35,8 @@ class Backup extends \Google\Protobuf\Internal\Message */ private $version_time = null; /** - * 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` @@ -46,8 +47,11 @@ class Backup extends \Google\Protobuf\Internal\Message */ private $expire_time = null; /** - * 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 * `projects//instances//backups/[a-z][a-z0-9_\-]*[a-z0-9]` @@ -62,7 +66,8 @@ class Backup extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * 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`. * @@ -99,6 +104,17 @@ class Backup extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $encryption_info = null; + /** + * Output only. The encryption information for the backup, whether it is + * protected by one or more KMS keys. The information includes all Cloud + * KMS key versions used to encrypt the backup. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. At least one of the key + * versions must be available for the backup to be restored. If a key version + * is revoked in the middle of a restore, the restore behavior is undefined. + * + * Generated from protobuf field repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $encryption_information; /** * Output only. The database dialect information for the backup. * @@ -135,10 +151,10 @@ class Backup extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $database - * 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//instances//databases/`. * @type \Google\Protobuf\Timestamp $version_time * The backup will contain an externally consistent copy of the database at @@ -146,15 +162,19 @@ class Backup extends \Google\Protobuf\Internal\Message * specified, the system will set `version_time` to the `create_time` of the * backup. * @type \Google\Protobuf\Timestamp $expire_time - * 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` * has passed, the backup is eligible to be automatically deleted by Cloud * Spanner to free the resources used by the backup. * @type string $name - * 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 * `projects//instances//backups/[a-z][a-z0-9_\-]*[a-z0-9]` @@ -165,7 +185,8 @@ class Backup extends \Google\Protobuf\Internal\Message * by the prefix of the backup name of the form * `projects//instances/`. * @type \Google\Protobuf\Timestamp $create_time - * 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`. * @type int|string $size_bytes @@ -182,6 +203,13 @@ class Backup extends \Google\Protobuf\Internal\Message * to the backup is removed. * @type \Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo $encryption_info * Output only. The encryption information for the backup. + * @type array<\Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo>|\Google\Protobuf\Internal\RepeatedField $encryption_information + * Output only. The encryption information for the backup, whether it is + * protected by one or more KMS keys. The information includes all Cloud + * KMS key versions used to encrypt the backup. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. At least one of the key + * versions must be available for the backup to be restored. If a key version + * is revoked in the middle of a restore, the restore behavior is undefined. * @type int $database_dialect * Output only. The database dialect information for the backup. * @type array|\Google\Protobuf\Internal\RepeatedField $referencing_backups @@ -206,10 +234,10 @@ public function __construct($data = NULL) { } /** - * 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//instances//databases/`. * * Generated from protobuf field string database = 2 [(.google.api.resource_reference) = { @@ -221,10 +249,10 @@ public function getDatabase() } /** - * 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//instances//databases/`. * * Generated from protobuf field string database = 2 [(.google.api.resource_reference) = { @@ -282,7 +310,8 @@ public function setVersionTime($var) } /** - * 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` @@ -308,7 +337,8 @@ public function clearExpireTime() } /** - * 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` @@ -328,8 +358,11 @@ public function setExpireTime($var) } /** - * 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 * `projects//instances//backups/[a-z][a-z0-9_\-]*[a-z0-9]` @@ -349,8 +382,11 @@ public function getName() } /** - * 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 * `projects//instances//backups/[a-z][a-z0-9_\-]*[a-z0-9]` @@ -374,7 +410,8 @@ public function setName($var) } /** - * 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`. * @@ -397,7 +434,8 @@ public function clearCreateTime() } /** - * 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`. * @@ -539,6 +577,42 @@ public function setEncryptionInfo($var) return $this; } + /** + * Output only. The encryption information for the backup, whether it is + * protected by one or more KMS keys. The information includes all Cloud + * KMS key versions used to encrypt the backup. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. At least one of the key + * versions must be available for the backup to be restored. If a key version + * is revoked in the middle of a restore, the restore behavior is undefined. + * + * Generated from protobuf field repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEncryptionInformation() + { + return $this->encryption_information; + } + + /** + * Output only. The encryption information for the backup, whether it is + * protected by one or more KMS keys. The information includes all Cloud + * KMS key versions used to encrypt the backup. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. At least one of the key + * versions must be available for the backup to be restored. If a key version + * is revoked in the middle of a restore, the restore behavior is undefined. + * + * Generated from protobuf field repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEncryptionInformation($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo::class); + $this->encryption_information = $arr; + + return $this; + } + /** * Output only. The database dialect information for the backup. * diff --git a/Spanner/src/Admin/Database/V1/BackupInfo.php b/Spanner/src/Admin/Database/V1/BackupInfo.php index 23d659f3e921..daaf059905a8 100644 --- a/Spanner/src/Admin/Database/V1/BackupInfo.php +++ b/Spanner/src/Admin/Database/V1/BackupInfo.php @@ -24,16 +24,17 @@ class BackupInfo extends \Google\Protobuf\Internal\Message /** * 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`. * * Generated from protobuf field .google.protobuf.Timestamp version_time = 4; */ private $version_time = null; /** - * 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. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 2; */ @@ -56,12 +57,13 @@ class BackupInfo extends \Google\Protobuf\Internal\Message * @type \Google\Protobuf\Timestamp $version_time * 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`. * @type \Google\Protobuf\Timestamp $create_time - * 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. * @type string $source_database * Name of the database the backup was created from. * } @@ -100,9 +102,9 @@ public function setBackup($var) /** * 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`. * * Generated from protobuf field .google.protobuf.Timestamp version_time = 4; * @return \Google\Protobuf\Timestamp|null @@ -125,9 +127,9 @@ public function clearVersionTime() /** * 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`. * * Generated from protobuf field .google.protobuf.Timestamp version_time = 4; * @param \Google\Protobuf\Timestamp $var @@ -142,8 +144,9 @@ public function setVersionTime($var) } /** - * 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. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 2; * @return \Google\Protobuf\Timestamp|null @@ -164,8 +167,9 @@ public function clearCreateTime() } /** - * 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. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 2; * @param \Google\Protobuf\Timestamp $var diff --git a/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php b/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php index 46665d9fa572..157c2df243ab 100644 --- a/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php +++ b/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php @@ -77,7 +77,7 @@ * The Cloud Spanner Database Admin API can be used to: * * create, drop, and list databases * * update the schema of pre-existing databases - * * create, delete and list backups for a database + * * create, delete, copy and list backups for a database * * restore a database from an existing backup * * This class provides the ability to make remote calls to the backing service through method @@ -403,9 +403,10 @@ public function __call($method, $args) * The [metadata][google.longrunning.Operation.metadata] field type is * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. * 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 - * copying and delete the backup. - * Concurrent CopyBackup requests can run on the same source backup. + * [Backup][google.spanner.admin.database.v1.Backup], if successful. + * Cancelling the returned operation will stop the copying and delete the + * destination backup. Concurrent CopyBackup requests can run on the same + * source backup. * * The async variant is {@see DatabaseAdminClient::copyBackupAsync()} . * @@ -437,12 +438,12 @@ public function copyBackup(CopyBackupRequest $request, array $callOptions = []): * `projects//instances//backups//operations/` * 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. * * The async variant is {@see DatabaseAdminClient::createBackupAsync()} . * @@ -473,8 +474,8 @@ public function createBackup(CreateBackupRequest $request, array $callOptions = * have a name of the format `/operations/` 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. * * The async variant is {@see DatabaseAdminClient::createDatabaseAsync()} . @@ -501,7 +502,8 @@ public function createDatabase(CreateDatabaseRequest $request, array $callOption } /** - * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. + * Deletes a pending or completed + * [Backup][google.spanner.admin.database.v1.Backup]. * * The async variant is {@see DatabaseAdminClient::deleteBackupAsync()} . * @@ -553,7 +555,8 @@ public function dropDatabase(DropDatabaseRequest $request, array $callOptions = } /** - * 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]. * * The async variant is {@see DatabaseAdminClient::getBackupAsync()} . * @@ -923,7 +926,8 @@ public function testIamPermissions(TestIamPermissionsRequest $request, array $ca } /** - * Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. + * Updates a pending or completed + * [Backup][google.spanner.admin.database.v1.Backup]. * * The async variant is {@see DatabaseAdminClient::updateBackupAsync()} . * @@ -1016,7 +1020,8 @@ public function updateDatabase(UpdateDatabaseRequest $request, array $callOption * the format `/operations/` 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. + * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. + * The operation has no response. * * The async variant is {@see DatabaseAdminClient::updateDatabaseDdlAsync()} . * diff --git a/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig.php b/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig.php index 431872668f4e..d9ef7547bba8 100644 --- a/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig.php +++ b/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig.php @@ -24,13 +24,33 @@ class CopyBackupEncryptionConfig extends \Google\Protobuf\Internal\Message /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $kms_key_name = ''; + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * Kms keys specified can be in any order. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $kms_key_names; /** * Constructor. @@ -43,9 +63,25 @@ class CopyBackupEncryptionConfig extends \Google\Protobuf\Internal\Message * @type string $kms_key_name * 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 + * [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * @type array|\Google\Protobuf\Internal\RepeatedField $kms_key_names + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. + * Kms keys specified can be in any order. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. * } */ public function __construct($data = NULL) { @@ -82,8 +118,8 @@ public function setEncryptionType($var) /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -97,8 +133,8 @@ public function getKmsKeyName() /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -113,5 +149,59 @@ public function setKmsKeyName($var) return $this; } + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * Kms keys specified can be in any order. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getKmsKeyNames() + { + return $this->kms_key_names; + } + + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * Kms keys specified can be in any order. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setKmsKeyNames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->kms_key_names = $arr; + + return $this; + } + } diff --git a/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig/EncryptionType.php b/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig/EncryptionType.php index 51a6d9a07393..56fa3e3beb2b 100644 --- a/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig/EncryptionType.php +++ b/Spanner/src/Admin/Database/V1/CopyBackupEncryptionConfig/EncryptionType.php @@ -20,10 +20,13 @@ class EncryptionType */ const 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. + * 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. * * Generated from protobuf enum USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1; */ @@ -35,8 +38,8 @@ class EncryptionType */ const GOOGLE_DEFAULT_ENCRYPTION = 2; /** - * Use customer managed encryption. If specified, `kms_key_name` - * must contain a valid Cloud KMS key. + * Use customer managed encryption. If specified, either `kms_key_name` or + * `kms_key_names` must contain valid Cloud KMS key(s). * * Generated from protobuf enum CUSTOMER_MANAGED_ENCRYPTION = 3; */ diff --git a/Spanner/src/Admin/Database/V1/CopyBackupMetadata.php b/Spanner/src/Admin/Database/V1/CopyBackupMetadata.php index 3fcfac667492..b9b4ffaad91e 100644 --- a/Spanner/src/Admin/Database/V1/CopyBackupMetadata.php +++ b/Spanner/src/Admin/Database/V1/CopyBackupMetadata.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Metadata type for the google.longrunning.Operation returned by + * Metadata type for the operation returned by * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.CopyBackupMetadata @@ -34,7 +34,8 @@ class CopyBackupMetadata extends \Google\Protobuf\Internal\Message private $source_backup = ''; /** * The progress of the - * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] operation. + * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; */ @@ -73,7 +74,8 @@ class CopyBackupMetadata extends \Google\Protobuf\Internal\Message * `projects//instances//backups/`. * @type \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress $progress * The progress of the - * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] operation. + * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] + * operation. * @type \Google\Protobuf\Timestamp $cancel_time * The time at which cancellation of CopyBackup operation was received. * [Operations.CancelOperation][google.longrunning.Operations.CancelOperation] @@ -156,7 +158,8 @@ public function setSourceBackup($var) /** * The progress of the - * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] operation. + * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; * @return \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress|null @@ -178,7 +181,8 @@ public function clearProgress() /** * The progress of the - * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] operation. + * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; * @param \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress $var diff --git a/Spanner/src/Admin/Database/V1/CopyBackupRequest.php b/Spanner/src/Admin/Database/V1/CopyBackupRequest.php index afbab462f19a..5f378df44f18 100644 --- a/Spanner/src/Admin/Database/V1/CopyBackupRequest.php +++ b/Spanner/src/Admin/Database/V1/CopyBackupRequest.php @@ -9,15 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup]. + * The request for + * [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.CopyBackupRequest */ class CopyBackupRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. + * Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -52,19 +53,19 @@ class CopyBackupRequest extends \Google\Protobuf\Internal\Message */ private $expire_time = null; /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $encryption_config = null; /** - * @param string $parent Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. Please see + * @param string $parent Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. Please see * {@see DatabaseAdminClient::instanceName()} for help formatting this field. * @param string $backupId Required. The id of the backup copy. * The `backup_id` appended to `parent` forms the full backup_uri of the form @@ -102,8 +103,8 @@ public static function build(string $parent, string $backupId, string $sourceBac * Optional. Data for populating the Message object. * * @type string $parent - * Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. + * Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. * @type string $backup_id * Required. The id of the backup copy. * The `backup_id` appended to `parent` forms the full backup_uri of the form @@ -122,11 +123,11 @@ public static function build(string $parent, string $backupId, string $sourceBac * passed, the backup is eligible to be automatically deleted by Cloud Spanner * to free the resources used by the backup. * @type \Google\Cloud\Spanner\Admin\Database\V1\CopyBackupEncryptionConfig $encryption_config - * 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`. + * 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`. * } */ public function __construct($data = NULL) { @@ -135,8 +136,8 @@ public function __construct($data = NULL) { } /** - * Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. + * Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -147,8 +148,8 @@ public function getParent() } /** - * Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. + * Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -273,11 +274,11 @@ public function setExpireTime($var) } /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Spanner\Admin\Database\V1\CopyBackupEncryptionConfig|null @@ -298,11 +299,11 @@ public function clearEncryptionConfig() } /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Spanner\Admin\Database\V1\CopyBackupEncryptionConfig $var diff --git a/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig.php b/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig.php index 0d13ca063e94..856296def13e 100644 --- a/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig.php +++ b/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig.php @@ -24,13 +24,32 @@ class CreateBackupEncryptionConfig extends \Google\Protobuf\Internal\Message /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $kms_key_name = ''; + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $kms_key_names; /** * Constructor. @@ -43,9 +62,24 @@ class CreateBackupEncryptionConfig extends \Google\Protobuf\Internal\Message * @type string $kms_key_name * 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 + * [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * @type array|\Google\Protobuf\Internal\RepeatedField $kms_key_names + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. * } */ public function __construct($data = NULL) { @@ -82,8 +116,8 @@ public function setEncryptionType($var) /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -97,8 +131,8 @@ public function getKmsKeyName() /** * 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 + * [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] + * is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -113,5 +147,57 @@ public function setKmsKeyName($var) return $this; } + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getKmsKeyNames() + { + return $this->kms_key_names; + } + + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * protect the backup. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the backup's instance configuration. Some examples: + * * For single region instance configs, specify a single regional + * location KMS key. + * * For multi-regional instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For an instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setKmsKeyNames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->kms_key_names = $arr; + + return $this; + } + } diff --git a/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig/EncryptionType.php b/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig/EncryptionType.php index 028d9da2fb85..be6e5fb5ea47 100644 --- a/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig/EncryptionType.php +++ b/Spanner/src/Admin/Database/V1/CreateBackupEncryptionConfig/EncryptionType.php @@ -22,9 +22,10 @@ class EncryptionType /** * 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. + * [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. * * Generated from protobuf enum USE_DATABASE_ENCRYPTION = 1; */ diff --git a/Spanner/src/Admin/Database/V1/CreateBackupMetadata.php b/Spanner/src/Admin/Database/V1/CreateBackupMetadata.php index eac5b5c71117..7239db16db11 100644 --- a/Spanner/src/Admin/Database/V1/CreateBackupMetadata.php +++ b/Spanner/src/Admin/Database/V1/CreateBackupMetadata.php @@ -30,7 +30,8 @@ class CreateBackupMetadata extends \Google\Protobuf\Internal\Message private $database = ''; /** * The progress of the - * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. + * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; */ @@ -65,7 +66,8 @@ class CreateBackupMetadata extends \Google\Protobuf\Internal\Message * The name of the database the backup is created from. * @type \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress $progress * The progress of the - * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. + * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] + * operation. * @type \Google\Protobuf\Timestamp $cancel_time * The time at which cancellation of this operation was received. * [Operations.CancelOperation][google.longrunning.Operations.CancelOperation] @@ -140,7 +142,8 @@ public function setDatabase($var) /** * The progress of the - * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. + * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; * @return \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress|null @@ -162,7 +165,8 @@ public function clearProgress() /** * The progress of the - * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. + * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] + * operation. * * Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3; * @param \Google\Cloud\Spanner\Admin\Database\V1\OperationProgress $var diff --git a/Spanner/src/Admin/Database/V1/CreateBackupRequest.php b/Spanner/src/Admin/Database/V1/CreateBackupRequest.php index fdeba10b5902..552eaff66df3 100644 --- a/Spanner/src/Admin/Database/V1/CreateBackupRequest.php +++ b/Spanner/src/Admin/Database/V1/CreateBackupRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]. + * The request for + * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.CreateBackupRequest */ @@ -41,11 +42,11 @@ class CreateBackupRequest extends \Google\Protobuf\Internal\Message */ private $backup = null; /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -96,11 +97,11 @@ public static function build(string $parent, \Google\Cloud\Spanner\Admin\Databas * @type \Google\Cloud\Spanner\Admin\Database\V1\Backup $backup * Required. The backup to create. * @type \Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig $encryption_config - * 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`. + * 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`. * } */ public function __construct($data = NULL) { @@ -211,11 +212,11 @@ public function setBackup($var) } /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig|null @@ -236,11 +237,11 @@ public function clearEncryptionConfig() } /** - * 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`. + * 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`. * * Generated from protobuf field .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig $var diff --git a/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php b/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php index 2d89bee7142b..3dbfcc5511cc 100644 --- a/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php +++ b/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase]. + * The request for + * [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase]. * * Generated from protobuf message google.spanner.admin.database.v1.CreateDatabaseRequest */ @@ -42,8 +43,8 @@ class CreateDatabaseRequest extends \Google\Protobuf\Internal\Message */ private $extra_statements; /** - * Optional. The encryption configuration for the database. If this field is not - * specified, Cloud Spanner will encrypt/decrypt all data at rest using + * 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. * * Generated from protobuf field .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -118,8 +119,8 @@ public static function build(string $parent, string $createStatement): self * statements execute atomically with the creation of the database: * if there is an error in any statement, the database is not created. * @type \Google\Cloud\Spanner\Admin\Database\V1\EncryptionConfig $encryption_config - * Optional. The encryption configuration for the database. If this field is not - * specified, Cloud Spanner will encrypt/decrypt all data at rest using + * 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. * @type int $database_dialect * Optional. The dialect of the Cloud Spanner Database. @@ -241,8 +242,8 @@ public function setExtraStatements($var) } /** - * Optional. The encryption configuration for the database. If this field is not - * specified, Cloud Spanner will encrypt/decrypt all data at rest using + * 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. * * Generated from protobuf field .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -264,8 +265,8 @@ public function clearEncryptionConfig() } /** - * Optional. The encryption configuration for the database. If this field is not - * specified, Cloud Spanner will encrypt/decrypt all data at rest using + * 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. * * Generated from protobuf field .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Spanner/src/Admin/Database/V1/Database.php b/Spanner/src/Admin/Database/V1/Database.php index 60338534d345..a9b8a57a434e 100644 --- a/Spanner/src/Admin/Database/V1/Database.php +++ b/Spanner/src/Admin/Database/V1/Database.php @@ -56,7 +56,8 @@ class Database extends \Google\Protobuf\Internal\Message /** * 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. + * all Cloud KMS key versions that are in use. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. * 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 @@ -69,8 +70,8 @@ class Database extends \Google\Protobuf\Internal\Message * 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. + * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. + * Defaults to 1 hour, if not set. * * Generated from protobuf field string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -103,7 +104,9 @@ class Database extends \Google\Protobuf\Internal\Message private $database_dialect = 0; /** * Whether drop protection is enabled for this database. Defaults to false, - * if not set. + * if not set. For more details, please see how to [prevent accidental + * database + * deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). * * Generated from protobuf field bool enable_drop_protection = 11; */ @@ -143,7 +146,8 @@ class Database extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo>|\Google\Protobuf\Internal\RepeatedField $encryption_info * 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. + * all Cloud KMS key versions that are in use. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. * 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 @@ -152,8 +156,8 @@ class Database extends \Google\Protobuf\Internal\Message * 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. + * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. + * Defaults to 1 hour, if not set. * @type \Google\Protobuf\Timestamp $earliest_version_time * Output only. Earliest timestamp at which older versions of the data can be * read. This value is continuously updated by Cloud Spanner and becomes stale @@ -170,7 +174,9 @@ class Database extends \Google\Protobuf\Internal\Message * Output only. The dialect of the Cloud Spanner Database. * @type bool $enable_drop_protection * Whether drop protection is enabled for this database. Defaults to false, - * if not set. + * if not set. For more details, please see how to [prevent accidental + * database + * deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). * @type bool $reconciling * Output only. If true, the database is being updated. If false, there are no * ongoing update operations for the database. @@ -360,7 +366,8 @@ public function setEncryptionConfig($var) /** * 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. + * all Cloud KMS key versions that are in use. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. * 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 @@ -377,7 +384,8 @@ public function getEncryptionInfo() /** * 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. + * all Cloud KMS key versions that are in use. The `encryption_status' field + * inside of each `EncryptionInfo` is not populated. * 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 @@ -399,8 +407,8 @@ public function setEncryptionInfo($var) * 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. + * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. + * Defaults to 1 hour, if not set. * * Generated from protobuf field string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -414,8 +422,8 @@ public function getVersionRetentionPeriod() * 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. + * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. + * Defaults to 1 hour, if not set. * * Generated from protobuf field string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -535,7 +543,9 @@ public function setDatabaseDialect($var) /** * Whether drop protection is enabled for this database. Defaults to false, - * if not set. + * if not set. For more details, please see how to [prevent accidental + * database + * deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). * * Generated from protobuf field bool enable_drop_protection = 11; * @return bool @@ -547,7 +557,9 @@ public function getEnableDropProtection() /** * Whether drop protection is enabled for this database. Defaults to false, - * if not set. + * if not set. For more details, please see how to [prevent accidental + * database + * deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). * * Generated from protobuf field bool enable_drop_protection = 11; * @param bool $var diff --git a/Spanner/src/Admin/Database/V1/DatabaseDialect.php b/Spanner/src/Admin/Database/V1/DatabaseDialect.php index 244d47d5a2bd..ed173031894b 100644 --- a/Spanner/src/Admin/Database/V1/DatabaseDialect.php +++ b/Spanner/src/Admin/Database/V1/DatabaseDialect.php @@ -21,7 +21,7 @@ class DatabaseDialect */ const DATABASE_DIALECT_UNSPECIFIED = 0; /** - * Google standard SQL. + * GoogleSQL supported SQL. * * Generated from protobuf enum GOOGLE_STANDARD_SQL = 1; */ diff --git a/Spanner/src/Admin/Database/V1/DatabaseRole.php b/Spanner/src/Admin/Database/V1/DatabaseRole.php index d36675860ff6..f7e32c23f83a 100644 --- a/Spanner/src/Admin/Database/V1/DatabaseRole.php +++ b/Spanner/src/Admin/Database/V1/DatabaseRole.php @@ -17,10 +17,8 @@ class DatabaseRole extends \Google\Protobuf\Internal\Message { /** * Required. The name of the database role. Values are of the form - * `projects//instances//databases//databaseRoles/ - * {role}`, where `` is as specified in the `CREATE ROLE` - * DDL statement. This name can be passed to Get/Set IAMPolicy methods to - * identify the database role. + * `projects//instances//databases//databaseRoles/` + * where `` is as specified in the `CREATE ROLE` DDL statement. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -34,10 +32,8 @@ class DatabaseRole extends \Google\Protobuf\Internal\Message * * @type string $name * Required. The name of the database role. Values are of the form - * `projects//instances//databases//databaseRoles/ - * {role}`, where `` is as specified in the `CREATE ROLE` - * DDL statement. This name can be passed to Get/Set IAMPolicy methods to - * identify the database role. + * `projects//instances//databases//databaseRoles/` + * where `` is as specified in the `CREATE ROLE` DDL statement. * } */ public function __construct($data = NULL) { @@ -47,10 +43,8 @@ public function __construct($data = NULL) { /** * Required. The name of the database role. Values are of the form - * `projects//instances//databases//databaseRoles/ - * {role}`, where `` is as specified in the `CREATE ROLE` - * DDL statement. This name can be passed to Get/Set IAMPolicy methods to - * identify the database role. + * `projects//instances//databases//databaseRoles/` + * where `` is as specified in the `CREATE ROLE` DDL statement. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -62,10 +56,8 @@ public function getName() /** * Required. The name of the database role. Values are of the form - * `projects//instances//databases//databaseRoles/ - * {role}`, where `` is as specified in the `CREATE ROLE` - * DDL statement. This name can be passed to Get/Set IAMPolicy methods to - * identify the database role. + * `projects//instances//databases//databaseRoles/` + * where `` is as specified in the `CREATE ROLE` DDL statement. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/DeleteBackupRequest.php b/Spanner/src/Admin/Database/V1/DeleteBackupRequest.php index 781ef97957dc..f8ae101ba9d9 100644 --- a/Spanner/src/Admin/Database/V1/DeleteBackupRequest.php +++ b/Spanner/src/Admin/Database/V1/DeleteBackupRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup]. + * The request for + * [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.DeleteBackupRequest */ diff --git a/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php b/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php index 4ae113b8a14f..993cbe1e73ee 100644 --- a/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php +++ b/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase]. + * The request for + * [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase]. * * Generated from protobuf message google.spanner.admin.database.v1.DropDatabaseRequest */ diff --git a/Spanner/src/Admin/Database/V1/EncryptionConfig.php b/Spanner/src/Admin/Database/V1/EncryptionConfig.php index 04e1610307ba..62529b83264e 100644 --- a/Spanner/src/Admin/Database/V1/EncryptionConfig.php +++ b/Spanner/src/Admin/Database/V1/EncryptionConfig.php @@ -23,6 +23,25 @@ class EncryptionConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field string kms_key_name = 2 [(.google.api.resource_reference) = { */ private $kms_key_name = ''; + /** + * Specifies the KMS configuration for the one or more keys used to encrypt + * the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.resource_reference) = { + */ + private $kms_key_names; /** * Constructor. @@ -34,6 +53,21 @@ class EncryptionConfig extends \Google\Protobuf\Internal\Message * The Cloud KMS key to be used for encrypting and decrypting * the database. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. + * @type array|\Google\Protobuf\Internal\RepeatedField $kms_key_names + * Specifies the KMS configuration for the one or more keys used to encrypt + * the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. * } */ public function __construct($data = NULL) { @@ -71,5 +105,57 @@ public function setKmsKeyName($var) return $this; } + /** + * Specifies the KMS configuration for the one or more keys used to encrypt + * the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getKmsKeyNames() + { + return $this->kms_key_names; + } + + /** + * Specifies the KMS configuration for the one or more keys used to encrypt + * the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setKmsKeyNames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->kms_key_names = $arr; + + return $this; + } + } diff --git a/Spanner/src/Admin/Database/V1/EncryptionInfo.php b/Spanner/src/Admin/Database/V1/EncryptionInfo.php index 2580842d5957..38ae91890389 100644 --- a/Spanner/src/Admin/Database/V1/EncryptionInfo.php +++ b/Spanner/src/Admin/Database/V1/EncryptionInfo.php @@ -22,16 +22,16 @@ class EncryptionInfo extends \Google\Protobuf\Internal\Message */ private $encryption_type = 0; /** - * 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. + * 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. * * Generated from protobuf field .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $encryption_status = null; /** - * Output only. A Cloud KMS key version that is being used to protect the database or - * backup. + * Output only. A Cloud KMS key version that is being used to protect the + * database or backup. * * Generated from protobuf field string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ @@ -46,12 +46,12 @@ class EncryptionInfo extends \Google\Protobuf\Internal\Message * @type int $encryption_type * Output only. The type of encryption. * @type \Google\Rpc\Status $encryption_status - * 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. + * 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. * @type string $kms_key_version - * Output only. A Cloud KMS key version that is being used to protect the database or - * backup. + * Output only. A Cloud KMS key version that is being used to protect the + * database or backup. * } */ public function __construct($data = NULL) { @@ -86,9 +86,9 @@ public function setEncryptionType($var) } /** - * 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. + * 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. * * Generated from protobuf field .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Rpc\Status|null @@ -109,9 +109,9 @@ public function clearEncryptionStatus() } /** - * 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. + * 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. * * Generated from protobuf field .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Rpc\Status $var @@ -126,8 +126,8 @@ public function setEncryptionStatus($var) } /** - * Output only. A Cloud KMS key version that is being used to protect the database or - * backup. + * Output only. A Cloud KMS key version that is being used to protect the + * database or backup. * * Generated from protobuf field string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @return string @@ -138,8 +138,8 @@ public function getKmsKeyVersion() } /** - * Output only. A Cloud KMS key version that is being used to protect the database or - * backup. + * Output only. A Cloud KMS key version that is being used to protect the + * database or backup. * * Generated from protobuf field string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @param string $var diff --git a/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php b/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php index 416d4bfaf0bf..228f9323bbbc 100644 --- a/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php +++ b/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php @@ -87,7 +87,7 @@ * The Cloud Spanner Database Admin API can be used to: * * create, drop, and list databases * * update the schema of pre-existing databases - * * create, delete and list backups for a database + * * create, delete, copy and list backups for a database * * restore a database from an existing backup * * This class provides the ability to make remote calls to the backing service through method @@ -539,9 +539,10 @@ public function __construct(array $options = []) * The [metadata][google.longrunning.Operation.metadata] field type is * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. * 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 - * copying and delete the backup. - * Concurrent CopyBackup requests can run on the same source backup. + * [Backup][google.spanner.admin.database.v1.Backup], if successful. + * Cancelling the returned operation will stop the copying and delete the + * destination backup. Concurrent CopyBackup requests can run on the same + * source backup. * * Sample code: * ``` @@ -582,8 +583,8 @@ public function __construct(array $options = []) * } * ``` * - * @param string $parent Required. The name of the destination instance that will contain the backup copy. - * Values are of the form: `projects//instances/`. + * @param string $parent Required. The name of the destination instance that will contain the backup + * copy. Values are of the form: `projects//instances/`. * @param string $backupId Required. The id of the backup copy. * The `backup_id` appended to `parent` forms the full backup_uri of the form * `projects//instances//backups/`. @@ -602,11 +603,11 @@ public function __construct(array $options = []) * Optional. * * @type CopyBackupEncryptionConfig $encryptionConfig - * 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`. + * 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`. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -656,12 +657,12 @@ public function copyBackup( * `projects//instances//backups//operations/` * 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. * * Sample code: * ``` @@ -715,11 +716,11 @@ public function copyBackup( * Optional. * * @type CreateBackupEncryptionConfig $encryptionConfig - * 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`. + * 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`. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -766,8 +767,8 @@ public function createBackup( * have a name of the format `/operations/` 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. * * Sample code: @@ -823,8 +824,8 @@ public function createBackup( * statements execute atomically with the creation of the database: * if there is an error in any statement, the database is not created. * @type EncryptionConfig $encryptionConfig - * Optional. The encryption configuration for the database. If this field is not - * specified, Cloud Spanner will encrypt/decrypt all data at rest using + * 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. * @type int $databaseDialect * Optional. The dialect of the Cloud Spanner Database. @@ -896,7 +897,8 @@ public function createDatabase( } /** - * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. + * Deletes a pending or completed + * [Backup][google.spanner.admin.database.v1.Backup]. * * Sample code: * ``` @@ -994,7 +996,8 @@ public function dropDatabase($database, array $optionalArgs = []) } /** - * 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]. * * Sample code: * ``` @@ -1262,7 +1265,9 @@ public function getIamPolicy($resource, array $optionalArgs = []) * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first if filtering on metadata @@ -1280,14 +1285,15 @@ public function getIamPolicy($resource, array $optionalArgs = []) * * `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". + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. + * * The source database name of backup contains 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 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. @@ -1295,9 +1301,9 @@ public function getIamPolicy($resource, array $optionalArgs = []) * `(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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. + * * The source 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` \ @@ -1307,12 +1313,13 @@ public function getIamPolicy($resource, array $optionalArgs = []) * `(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 + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] + * AND the source database name of the backup contains the 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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] + * AND the source backup name contains the string "test_bkp" * * The operation resulted in an error. * @type int $pageSize * The maximum number of resources contained in the underlying API @@ -1407,7 +1414,9 @@ public function listBackupOperations($parent, array $optionalArgs = []) * 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` @@ -1538,7 +1547,9 @@ public function listBackups($parent, array $optionalArgs = []) * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first, if filtering on metadata @@ -1560,7 +1571,8 @@ public function listBackups($parent, array $optionalArgs = []) * `(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". @@ -1645,7 +1657,7 @@ public function listDatabaseOperations($parent, array $optionalArgs = []) * * @param string $parent Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. + * `projects//instances//databases/`. * @param array $optionalArgs { * Optional. * @@ -1846,12 +1858,12 @@ public function listDatabases($parent, array $optionalArgs = []) * Name of the backup from which to restore. Values are of the form * `projects//instances//backups/`. * @type RestoreDatabaseEncryptionConfig $encryptionConfig - * 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_BACKUP_ENCRYPTION`. + * 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_BACKUP_ENCRYPTION`. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -2033,7 +2045,8 @@ public function testIamPermissions( } /** - * Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. + * Updates a pending or completed + * [Backup][google.spanner.admin.database.v1.Backup]. * * Sample code: * ``` @@ -2214,7 +2227,8 @@ public function updateDatabase( * the format `/operations/` 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. + * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. + * The operation has no response. * * Sample code: * ``` @@ -2264,18 +2278,20 @@ public function updateDatabase( * * 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]: `/operations/`. + * [longrunning.Operation][google.longrunning.Operation]: + * `/operations/`. * * `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`. * @type string $protoDescriptors * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. * Contains a protobuf-serialized diff --git a/Spanner/src/Admin/Database/V1/GetBackupRequest.php b/Spanner/src/Admin/Database/V1/GetBackupRequest.php index 8d777673ba6e..8023dc513a4d 100644 --- a/Spanner/src/Admin/Database/V1/GetBackupRequest.php +++ b/Spanner/src/Admin/Database/V1/GetBackupRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup]. + * The request for + * [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.GetBackupRequest */ diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php b/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php index 9a1e4fc2a4d2..746e1e6d300f 100644 --- a/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php +++ b/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl]. + * The request for + * [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl]. * * Generated from protobuf message google.spanner.admin.database.v1.GetDatabaseDdlRequest */ diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php b/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php index 6e51152a8b3d..fc346e69229d 100644 --- a/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php +++ b/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl]. + * The response for + * [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl]. * * Generated from protobuf message google.spanner.admin.database.v1.GetDatabaseDdlResponse */ diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php b/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php index b7054b36a37b..dd3f68a8fa17 100644 --- a/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php +++ b/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase]. + * The request for + * [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase]. * * Generated from protobuf message google.spanner.admin.database.v1.GetDatabaseRequest */ diff --git a/Spanner/src/Admin/Database/V1/ListBackupOperationsRequest.php b/Spanner/src/Admin/Database/V1/ListBackupOperationsRequest.php index d0e40c4bb0ed..5c50db837408 100644 --- a/Spanner/src/Admin/Database/V1/ListBackupOperationsRequest.php +++ b/Spanner/src/Admin/Database/V1/ListBackupOperationsRequest.php @@ -35,7 +35,9 @@ class ListBackupOperationsRequest extends \Google\Protobuf\Internal\Message * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first if filtering on metadata @@ -50,14 +52,15 @@ class ListBackupOperationsRequest extends \Google\Protobuf\Internal\Message * * `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". + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. + * * The source database name of backup contains 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 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. @@ -65,9 +68,9 @@ class ListBackupOperationsRequest extends \Google\Protobuf\Internal\Message * `(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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. + * * The source 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` \ @@ -77,12 +80,13 @@ class ListBackupOperationsRequest extends \Google\Protobuf\Internal\Message * `(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 + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] + * AND the source database name of the backup contains the 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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] + * AND the source backup name contains the string "test_bkp" * * The operation resulted in an error. * * Generated from protobuf field string filter = 2; @@ -98,8 +102,9 @@ class ListBackupOperationsRequest extends \Google\Protobuf\Internal\Message /** * 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`. * * Generated from protobuf field string page_token = 4; */ @@ -141,7 +146,9 @@ public static function build(string $parent): self * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first if filtering on metadata @@ -156,14 +163,15 @@ public static function build(string $parent): self * * `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". + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. + * * The source database name of backup contains 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 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. @@ -171,9 +179,9 @@ public static function build(string $parent): self * `(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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. + * * The source 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` \ @@ -183,12 +191,13 @@ public static function build(string $parent): self * `(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 + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] + * AND the source database name of the backup contains the 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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] + * AND the source backup name contains the string "test_bkp" * * The operation resulted in an error. * @type int $page_size * Number of operations to be returned in the response. If 0 or @@ -196,8 +205,9 @@ public static function build(string $parent): self * @type string $page_token * 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`. * } */ public function __construct($data = NULL) { @@ -245,7 +255,9 @@ public function setParent($var) * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first if filtering on metadata @@ -260,14 +272,15 @@ public function setParent($var) * * `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". + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. + * * The source database name of backup contains 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 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. @@ -275,9 +288,9 @@ public function setParent($var) * `(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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. + * * The source 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` \ @@ -287,12 +300,13 @@ public function setParent($var) * `(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 + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] + * AND the source database name of the backup contains the 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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] + * AND the source backup name contains the string "test_bkp" * * The operation resulted in an error. * * Generated from protobuf field string filter = 2; @@ -315,7 +329,9 @@ public function getFilter() * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first if filtering on metadata @@ -330,14 +346,15 @@ public function getFilter() * * `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". + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. + * * The source database name of backup contains 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 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. @@ -345,9 +362,9 @@ public function getFilter() * `(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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. + * * The source 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` \ @@ -357,12 +374,13 @@ public function getFilter() * `(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 + * * The operation's metadata type is + * [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] + * AND the source database name of the backup contains the 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's metadata type is + * [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] + * AND the source backup name contains the string "test_bkp" * * The operation resulted in an error. * * Generated from protobuf field string filter = 2; @@ -408,8 +426,9 @@ public function setPageSize($var) /** * 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`. * * Generated from protobuf field string page_token = 4; * @return string @@ -422,8 +441,9 @@ public function getPageToken() /** * 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`. * * Generated from protobuf field string page_token = 4; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListBackupsRequest.php b/Spanner/src/Admin/Database/V1/ListBackupsRequest.php index bb093fded002..b4238eb7f032 100644 --- a/Spanner/src/Admin/Database/V1/ListBackupsRequest.php +++ b/Spanner/src/Admin/Database/V1/ListBackupsRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups]. + * The request for + * [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups]. * * Generated from protobuf message google.spanner.admin.database.v1.ListBackupsRequest */ @@ -29,7 +30,9 @@ class ListBackupsRequest extends \Google\Protobuf\Internal\Message * 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: + * The following fields in the + * [Backup][google.spanner.admin.database.v1.Backup] are eligible for + * filtering: * * `name` * * `database` * * `state` @@ -65,9 +68,10 @@ class ListBackupsRequest extends \Google\Protobuf\Internal\Message private $page_size = 0; /** * 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`. * * Generated from protobuf field string page_token = 4; */ @@ -104,7 +108,9 @@ public static function build(string $parent): self * 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: + * The following fields in the + * [Backup][google.spanner.admin.database.v1.Backup] are eligible for + * filtering: * * `name` * * `database` * * `state` @@ -132,9 +138,10 @@ public static function build(string $parent): self * less, defaults to the server's maximum allowed page size. * @type string $page_token * 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`. * } */ public function __construct($data = NULL) { @@ -177,7 +184,9 @@ public function setParent($var) * 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: + * The following fields in the + * [Backup][google.spanner.admin.database.v1.Backup] are eligible for + * filtering: * * `name` * * `database` * * `state` @@ -216,7 +225,9 @@ public function getFilter() * 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: + * The following fields in the + * [Backup][google.spanner.admin.database.v1.Backup] are eligible for + * filtering: * * `name` * * `database` * * `state` @@ -282,9 +293,10 @@ public function setPageSize($var) /** * 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`. * * Generated from protobuf field string page_token = 4; * @return string @@ -296,9 +308,10 @@ public function getPageToken() /** * 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`. * * Generated from protobuf field string page_token = 4; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListBackupsResponse.php b/Spanner/src/Admin/Database/V1/ListBackupsResponse.php index e307154d409e..2e99679b56a5 100644 --- a/Spanner/src/Admin/Database/V1/ListBackupsResponse.php +++ b/Spanner/src/Admin/Database/V1/ListBackupsResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups]. + * The response for + * [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups]. * * Generated from protobuf message google.spanner.admin.database.v1.ListBackupsResponse */ @@ -24,8 +25,8 @@ class ListBackupsResponse extends \Google\Protobuf\Internal\Message private $backups; /** * `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. * * Generated from protobuf field string next_page_token = 2; */ @@ -42,8 +43,8 @@ class ListBackupsResponse extends \Google\Protobuf\Internal\Message * in descending order, starting from the most recent `create_time`. * @type string $next_page_token * `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. * } */ public function __construct($data = NULL) { @@ -81,8 +82,8 @@ public function setBackups($var) /** * `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. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -94,8 +95,8 @@ public function getNextPageToken() /** * `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. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListDatabaseOperationsRequest.php b/Spanner/src/Admin/Database/V1/ListDatabaseOperationsRequest.php index 41a82625cfe5..5061df0e46b2 100644 --- a/Spanner/src/Admin/Database/V1/ListDatabaseOperationsRequest.php +++ b/Spanner/src/Admin/Database/V1/ListDatabaseOperationsRequest.php @@ -35,7 +35,9 @@ class ListDatabaseOperationsRequest extends \Google\Protobuf\Internal\Message * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first, if filtering on metadata @@ -54,7 +56,8 @@ class ListDatabaseOperationsRequest extends \Google\Protobuf\Internal\Message * `(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". @@ -74,8 +77,9 @@ class ListDatabaseOperationsRequest extends \Google\Protobuf\Internal\Message /** * 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`. * * Generated from protobuf field string page_token = 4; */ @@ -117,7 +121,9 @@ public static function build(string $parent): self * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first, if filtering on metadata @@ -136,7 +142,8 @@ public static function build(string $parent): self * `(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". @@ -148,8 +155,9 @@ public static function build(string $parent): self * @type string $page_token * 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`. * } */ public function __construct($data = NULL) { @@ -197,7 +205,9 @@ public function setParent($var) * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first, if filtering on metadata @@ -216,7 +226,8 @@ public function setParent($var) * `(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". @@ -243,7 +254,9 @@ public function getFilter() * * `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.` - any field in metadata.value. * `metadata.@type` must be specified first, if filtering on metadata @@ -262,7 +275,8 @@ public function getFilter() * `(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". @@ -312,8 +326,9 @@ public function setPageSize($var) /** * 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`. * * Generated from protobuf field string page_token = 4; * @return string @@ -326,8 +341,9 @@ public function getPageToken() /** * 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`. * * Generated from protobuf field string page_token = 4; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListDatabaseRolesRequest.php b/Spanner/src/Admin/Database/V1/ListDatabaseRolesRequest.php index d638734389c3..d83ec6bf40c0 100644 --- a/Spanner/src/Admin/Database/V1/ListDatabaseRolesRequest.php +++ b/Spanner/src/Admin/Database/V1/ListDatabaseRolesRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles]. + * The request for + * [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles]. * * Generated from protobuf message google.spanner.admin.database.v1.ListDatabaseRolesRequest */ @@ -18,7 +19,7 @@ class ListDatabaseRolesRequest extends \Google\Protobuf\Internal\Message /** * Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. + * `projects//instances//databases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -32,8 +33,9 @@ class ListDatabaseRolesRequest extends \Google\Protobuf\Internal\Message private $page_size = 0; /** * If non-empty, `page_token` should contain a - * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] from a - * previous [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. + * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] + * from a previous + * [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. * * Generated from protobuf field string page_token = 3; */ @@ -42,7 +44,7 @@ class ListDatabaseRolesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. Please see + * `projects//instances//databases/`. Please see * {@see DatabaseAdminClient::databaseName()} for help formatting this field. * * @return \Google\Cloud\Spanner\Admin\Database\V1\ListDatabaseRolesRequest @@ -64,14 +66,15 @@ public static function build(string $parent): self * @type string $parent * Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. + * `projects//instances//databases/`. * @type int $page_size * Number of database roles to be returned in the response. If 0 or less, * defaults to the server's maximum allowed page size. * @type string $page_token * If non-empty, `page_token` should contain a - * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] from a - * previous [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. + * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] + * from a previous + * [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. * } */ public function __construct($data = NULL) { @@ -82,7 +85,7 @@ public function __construct($data = NULL) { /** * Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. + * `projects//instances//databases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,7 +98,7 @@ public function getParent() /** * Required. The database whose roles should be listed. * Values are of the form - * `projects//instances//databases//databaseRoles`. + * `projects//instances//databases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -139,8 +142,9 @@ public function setPageSize($var) /** * If non-empty, `page_token` should contain a - * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] from a - * previous [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. + * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] + * from a previous + * [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. * * Generated from protobuf field string page_token = 3; * @return string @@ -152,8 +156,9 @@ public function getPageToken() /** * If non-empty, `page_token` should contain a - * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] from a - * previous [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. + * [next_page_token][google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token] + * from a previous + * [ListDatabaseRolesResponse][google.spanner.admin.database.v1.ListDatabaseRolesResponse]. * * Generated from protobuf field string page_token = 3; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListDatabaseRolesResponse.php b/Spanner/src/Admin/Database/V1/ListDatabaseRolesResponse.php index 15927aee8752..fc36896517be 100644 --- a/Spanner/src/Admin/Database/V1/ListDatabaseRolesResponse.php +++ b/Spanner/src/Admin/Database/V1/ListDatabaseRolesResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response for [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles]. + * The response for + * [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles]. * * Generated from protobuf message google.spanner.admin.database.v1.ListDatabaseRolesResponse */ diff --git a/Spanner/src/Admin/Database/V1/ListDatabasesRequest.php b/Spanner/src/Admin/Database/V1/ListDatabasesRequest.php index 7b3f77bb02e1..919d73db0cbd 100644 --- a/Spanner/src/Admin/Database/V1/ListDatabasesRequest.php +++ b/Spanner/src/Admin/Database/V1/ListDatabasesRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases]. + * The request for + * [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases]. * * Generated from protobuf message google.spanner.admin.database.v1.ListDatabasesRequest */ @@ -31,8 +32,9 @@ class ListDatabasesRequest extends \Google\Protobuf\Internal\Message private $page_size = 0; /** * 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]. * * Generated from protobuf field string page_token = 4; */ @@ -67,8 +69,9 @@ public static function build(string $parent): self * defaults to the server's maximum allowed page size. * @type string $page_token * 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]. * } */ public function __construct($data = NULL) { @@ -134,8 +137,9 @@ public function setPageSize($var) /** * 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]. * * Generated from protobuf field string page_token = 4; * @return string @@ -147,8 +151,9 @@ public function getPageToken() /** * 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]. * * Generated from protobuf field string page_token = 4; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/ListDatabasesResponse.php b/Spanner/src/Admin/Database/V1/ListDatabasesResponse.php index d4074a818114..c167bf56afd0 100644 --- a/Spanner/src/Admin/Database/V1/ListDatabasesResponse.php +++ b/Spanner/src/Admin/Database/V1/ListDatabasesResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases]. + * The response for + * [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases]. * * Generated from protobuf message google.spanner.admin.database.v1.ListDatabasesResponse */ @@ -23,8 +24,8 @@ class ListDatabasesResponse extends \Google\Protobuf\Internal\Message private $databases; /** * `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. * * Generated from protobuf field string next_page_token = 2; */ @@ -40,8 +41,8 @@ class ListDatabasesResponse extends \Google\Protobuf\Internal\Message * Databases that matched the request. * @type string $next_page_token * `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. * } */ public function __construct($data = NULL) { @@ -77,8 +78,8 @@ public function setDatabases($var) /** * `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. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -90,8 +91,8 @@ public function getNextPageToken() /** * `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. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig.php b/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig.php index f2e875409c96..54f3e913a322 100644 --- a/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig.php +++ b/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig.php @@ -22,15 +22,34 @@ class RestoreDatabaseEncryptionConfig extends \Google\Protobuf\Internal\Message */ private $encryption_type = 0; /** - * 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 + * 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//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $kms_key_name = ''; + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * encrypt the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $kms_key_names; /** * Constructor. @@ -41,11 +60,26 @@ class RestoreDatabaseEncryptionConfig extends \Google\Protobuf\Internal\Message * @type int $encryption_type * Required. The encryption type of the restored database. * @type string $kms_key_name - * 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 + * 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//locations//keyRings//cryptoKeys/`. + * @type array|\Google\Protobuf\Internal\RepeatedField $kms_key_names + * Optional. Specifies the KMS configuration for the one or more keys used to + * encrypt the database. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. * } */ public function __construct($data = NULL) { @@ -80,10 +114,10 @@ public function setEncryptionType($var) } /** - * 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 + * 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//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -95,10 +129,10 @@ public function getKmsKeyName() } /** - * 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 + * 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//locations//keyRings//cryptoKeys/`. * * Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { @@ -113,5 +147,57 @@ public function setKmsKeyName($var) return $this; } + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * encrypt the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getKmsKeyNames() + { + return $this->kms_key_names; + } + + /** + * Optional. Specifies the KMS configuration for the one or more keys used to + * encrypt the database. Values are of the form + * `projects//locations//keyRings//cryptoKeys/`. + * The keys referenced by kms_key_names must fully cover all + * regions of the database instance configuration. Some examples: + * * For single region database instance configs, specify a single regional + * location KMS key. + * * For multi-regional database instance configs of type GOOGLE_MANAGED, + * either specify a multi-regional location KMS key or multiple regional + * location KMS keys that cover all regions in the instance config. + * * For a database instance config of type USER_MANAGED, please specify only + * regional location KMS keys to cover each region in the instance config. + * Multi-regional location KMS keys are not supported for USER_MANAGED + * instance configs. + * + * Generated from protobuf field repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setKmsKeyNames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->kms_key_names = $arr; + + return $this; + } + } diff --git a/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig/EncryptionType.php b/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig/EncryptionType.php index 042b60fb0a34..6650757c3714 100644 --- a/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig/EncryptionType.php +++ b/Spanner/src/Admin/Database/V1/RestoreDatabaseEncryptionConfig/EncryptionType.php @@ -21,7 +21,8 @@ class EncryptionType const ENCRYPTION_TYPE_UNSPECIFIED = 0; /** * This is the default option when - * [encryption_config][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig] is not specified. + * [encryption_config][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig] + * is not specified. * * Generated from protobuf enum USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1; */ diff --git a/Spanner/src/Admin/Database/V1/RestoreDatabaseMetadata.php b/Spanner/src/Admin/Database/V1/RestoreDatabaseMetadata.php index 6d2aadbbc6df..8dc01de6749f 100644 --- a/Spanner/src/Admin/Database/V1/RestoreDatabaseMetadata.php +++ b/Spanner/src/Admin/Database/V1/RestoreDatabaseMetadata.php @@ -47,7 +47,8 @@ class RestoreDatabaseMetadata extends \Google\Protobuf\Internal\Message * 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`. * * Generated from protobuf field .google.protobuf.Timestamp cancel_time = 5; */ @@ -60,10 +61,10 @@ class RestoreDatabaseMetadata extends \Google\Protobuf\Internal\Message * `projects//instances//databases//operations/` * where the 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. * * Generated from protobuf field string optimize_database_operation_name = 6; */ @@ -97,7 +98,8 @@ class RestoreDatabaseMetadata extends \Google\Protobuf\Internal\Message * 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`. * @type string $optimize_database_operation_name * If exists, the name of the long-running operation that will be used to * track the post-restore optimization process to optimize the performance of @@ -106,10 +108,10 @@ class RestoreDatabaseMetadata extends \Google\Protobuf\Internal\Message * `projects//instances//databases//operations/` * where the 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. * } */ public function __construct($data = NULL) { @@ -251,7 +253,8 @@ public function setProgress($var) * 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`. * * Generated from protobuf field .google.protobuf.Timestamp cancel_time = 5; * @return \Google\Protobuf\Timestamp|null @@ -282,7 +285,8 @@ public function clearCancelTime() * 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`. * * Generated from protobuf field .google.protobuf.Timestamp cancel_time = 5; * @param \Google\Protobuf\Timestamp $var @@ -304,10 +308,10 @@ public function setCancelTime($var) * `projects//instances//databases//operations/` * where the 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. * * Generated from protobuf field string optimize_database_operation_name = 6; * @return string @@ -325,10 +329,10 @@ public function getOptimizeDatabaseOperationName() * `projects//instances//databases//operations/` * where the 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. * * Generated from protobuf field string optimize_database_operation_name = 6; * @param string $var diff --git a/Spanner/src/Admin/Database/V1/RestoreDatabaseRequest.php b/Spanner/src/Admin/Database/V1/RestoreDatabaseRequest.php index 34a9d1e30c2d..e9f2ef8b7d8c 100644 --- a/Spanner/src/Admin/Database/V1/RestoreDatabaseRequest.php +++ b/Spanner/src/Admin/Database/V1/RestoreDatabaseRequest.php @@ -36,12 +36,12 @@ class RestoreDatabaseRequest extends \Google\Protobuf\Internal\Message */ private $database_id = ''; /** - * 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_BACKUP_ENCRYPTION`. + * 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_BACKUP_ENCRYPTION`. * * Generated from protobuf field .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -95,12 +95,12 @@ public static function build(string $parent, string $databaseId, string $backup) * Name of the backup from which to restore. Values are of the form * `projects//instances//backups/`. * @type \Google\Cloud\Spanner\Admin\Database\V1\RestoreDatabaseEncryptionConfig $encryption_config - * 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_BACKUP_ENCRYPTION`. + * 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_BACKUP_ENCRYPTION`. * } */ public function __construct($data = NULL) { @@ -208,12 +208,12 @@ public function setBackup($var) } /** - * 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_BACKUP_ENCRYPTION`. + * 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_BACKUP_ENCRYPTION`. * * Generated from protobuf field .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Spanner\Admin\Database\V1\RestoreDatabaseEncryptionConfig|null @@ -234,12 +234,12 @@ public function clearEncryptionConfig() } /** - * 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_BACKUP_ENCRYPTION`. + * 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_BACKUP_ENCRYPTION`. * * Generated from protobuf field .google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Spanner\Admin\Database\V1\RestoreDatabaseEncryptionConfig $var diff --git a/Spanner/src/Admin/Database/V1/UpdateBackupRequest.php b/Spanner/src/Admin/Database/V1/UpdateBackupRequest.php index 0fa6d302efab..94db96b17083 100644 --- a/Spanner/src/Admin/Database/V1/UpdateBackupRequest.php +++ b/Spanner/src/Admin/Database/V1/UpdateBackupRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup]. + * The request for + * [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup]. * * Generated from protobuf message google.spanner.admin.database.v1.UpdateBackupRequest */ diff --git a/Spanner/src/Admin/Database/V1/UpdateDatabaseDdlRequest.php b/Spanner/src/Admin/Database/V1/UpdateDatabaseDdlRequest.php index fefb1928a3d6..9e9e7ff08124 100644 --- a/Spanner/src/Admin/Database/V1/UpdateDatabaseDdlRequest.php +++ b/Spanner/src/Admin/Database/V1/UpdateDatabaseDdlRequest.php @@ -22,8 +22,8 @@ * 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. * * Generated from protobuf message google.spanner.admin.database.v1.UpdateDatabaseDdlRequest */ @@ -48,17 +48,19 @@ class UpdateDatabaseDdlRequest extends \Google\Protobuf\Internal\Message * [Operation][google.longrunning.Operation]. * 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]: `/operations/`. + * [longrunning.Operation][google.longrunning.Operation]: + * `/operations/`. * `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`. * * Generated from protobuf field string operation_id = 3; */ @@ -116,17 +118,19 @@ public static function build(string $database, array $statements): self * [Operation][google.longrunning.Operation]. * 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]: `/operations/`. + * [longrunning.Operation][google.longrunning.Operation]: + * `/operations/`. * `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`. * @type string $proto_descriptors * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. * Contains a protobuf-serialized @@ -208,17 +212,19 @@ public function setStatements($var) * [Operation][google.longrunning.Operation]. * 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]: `/operations/`. + * [longrunning.Operation][google.longrunning.Operation]: + * `/operations/`. * `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`. * * Generated from protobuf field string operation_id = 3; * @return string @@ -235,17 +241,19 @@ public function getOperationId() * [Operation][google.longrunning.Operation]. * 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]: `/operations/`. + * [longrunning.Operation][google.longrunning.Operation]: + * `/operations/`. * `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`. * * Generated from protobuf field string operation_id = 3; * @param string $var