From c9f8ad03c51d4aac73a9f137db7681f97b61bc73 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 18 Dec 2024 12:20:33 -0800 Subject: [PATCH] feat: Exposing InstanceType in Instance configuration (to define PROVISIONED or FREE spanner instance) (#7937) feat: Exposing FreeInstanceMetadata in Instance configuration (to define the metadata related to FREE instance type) feat: Exposing storage_limit_per_processing_unit in InstanceConfig feat: Exposing QuorumType in InstanceConfig feat: Exposing FreeInstanceAvailability in InstanceConfig docs: A comment for method `ListInstanceConfigs` in service `InstanceAdmin` is changed docs: A comment for method `CreateInstanceConfig` in service `InstanceAdmin` is changed docs: A comment for method `UpdateInstanceConfig` in service `InstanceAdmin` is changed docs: A comment for method `ListInstanceConfigOperations` in service `InstanceAdmin` is changed docs: A comment for method `CreateInstance` in service `InstanceAdmin` is changed docs: A comment for method `UpdateInstance` in service `InstanceAdmin` is changed docs: A comment for method `CreateInstancePartition` in service `InstanceAdmin` is changed docs: A comment for method `UpdateInstancePartition` in service `InstanceAdmin` is changed docs: A comment for method `ListInstancePartitionOperations` in service `InstanceAdmin` is changed docs: A comment for method `MoveInstance` in service `InstanceAdmin` is changed docs: A comment for field `location` in message `.google.spanner.admin.instance.v1.ReplicaInfo` is changed docs: A comment for enum value `GOOGLE_MANAGED` in enum `Type` is changed docs: A comment for enum value `USER_MANAGED` in enum `Type` is changed docs: A comment for field `replicas` in message `.google.spanner.admin.instance.v1.InstanceConfig` is changed docs: A comment for field `optional_replicas` in message `.google.spanner.admin.instance.v1.InstanceConfig` is changed docs: A comment for field `base_config` in message `.google.spanner.admin.instance.v1.InstanceConfig` is changed docs: A comment for field `storage_utilization_percent` in message `.google.spanner.admin.instance.v1.AutoscalingConfig` is changed docs: A comment for enum `DefaultBackupScheduleType` is changed docs: A comment for enum value `NONE` in enum `DefaultBackupScheduleType` is changed docs: A comment for enum value `AUTOMATIC` in enum `DefaultBackupScheduleType` is changed docs: A comment for field `node_count` in message `.google.spanner.admin.instance.v1.Instance` is changed docs: A comment for field `processing_units` in message `.google.spanner.admin.instance.v1.Instance` is changed docs: A comment for field `default_backup_schedule_type` in message `.google.spanner.admin.instance.v1.Instance` is changed docs: A comment for message `CreateInstanceConfigRequest` is changed docs: A comment for field `instance_config` in message `.google.spanner.admin.instance.v1.CreateInstanceConfigRequest` is changed docs: A comment for message `UpdateInstanceConfigRequest` is changed docs: A comment for message `DeleteInstanceConfigRequest` is changed docs: A comment for field `filter` in message `.google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest` is changed docs: A comment for field `operations` in message `.google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse` is changed docs: A comment for field `node_count` in message `.google.spanner.admin.instance.v1.InstancePartition` is changed docs: A comment for field `processing_units` in message `.google.spanner.admin.instance.v1.InstancePartition` is changed docs: A comment for field `referencing_backups` in message `.google.spanner.admin.instance.v1.InstancePartition` is changed docs: A comment for field `parent` in message `.google.spanner.admin.instance.v1.ListInstancePartitionsRequest` is changed docs: A comment for field `unreachable` in message `.google.spanner.admin.instance.v1.ListInstancePartitionsResponse` is changed docs: A comment for field `filter` in message `.google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest` is changed docs: A comment for field `instance_partition_deadline` in message `.google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest` is changed docs: A comment for field `operations` in message `.google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse` is changed PiperOrigin-RevId: 706945550 Source-Link: https://github.com/googleapis/googleapis/commit/3db0452ba6b45012794e61640ea6eadd7153af74 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6c42be3bf546f10f09cad98b3f56f77c271fc8e2 Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiNmM0MmJlM2JmNTQ2ZjEwZjA5Y2FkOThiM2Y1NmY3N2MyNzFmYzhlMiJ9 --- Spanner/metadata/Admin/Instance/V1/Common.php | Bin 1366 -> 1447 bytes .../Instance/V1/SpannerInstanceAdmin.php | Bin 16601 -> 17768 bytes .../AutoscalingConfig/AutoscalingTargets.php | 8 +- .../V1/Client/InstanceAdminClient.php | 72 +++---- .../V1/CreateInstanceConfigRequest.php | 32 ++-- .../V1/DeleteInstanceConfigRequest.php | 2 +- .../Instance/V1/FreeInstanceMetadata.php | 180 ++++++++++++++++++ .../FreeInstanceMetadata/ExpireBehavior.php | 66 +++++++ .../V1/Gapic/InstanceAdminGapicClient.php | 91 ++++----- Spanner/src/Admin/Instance/V1/Instance.php | 158 ++++++++++----- .../V1/Instance/DefaultBackupScheduleType.php | 19 +- .../Instance/V1/Instance/InstanceType.php | 70 +++++++ .../src/Admin/Instance/V1/InstanceConfig.php | 154 +++++++++++++-- .../FreeInstanceAvailability.php | 84 ++++++++ .../Instance/V1/InstanceConfig/QuorumType.php | 78 ++++++++ .../Admin/Instance/V1/InstanceConfig/Type.php | 4 +- .../Admin/Instance/V1/InstancePartition.php | 51 +++-- .../ListInstanceConfigOperationsRequest.php | 12 +- .../ListInstanceConfigOperationsResponse.php | 24 +-- ...ListInstancePartitionOperationsRequest.php | 24 +-- ...istInstancePartitionOperationsResponse.php | 24 +-- .../V1/ListInstancePartitionsRequest.php | 20 +- .../V1/ListInstancePartitionsResponse.php | 24 +-- Spanner/src/Admin/Instance/V1/ReplicaInfo.php | 8 +- .../V1/UpdateInstanceConfigRequest.php | 2 +- .../V1/Client/InstanceAdminClientTest.php | 6 + .../Instance/V1/InstanceAdminClientTest.php | 6 + 27 files changed, 951 insertions(+), 268 deletions(-) create mode 100644 Spanner/src/Admin/Instance/V1/FreeInstanceMetadata.php create mode 100644 Spanner/src/Admin/Instance/V1/FreeInstanceMetadata/ExpireBehavior.php create mode 100644 Spanner/src/Admin/Instance/V1/Instance/InstanceType.php create mode 100644 Spanner/src/Admin/Instance/V1/InstanceConfig/FreeInstanceAvailability.php create mode 100644 Spanner/src/Admin/Instance/V1/InstanceConfig/QuorumType.php diff --git a/Spanner/metadata/Admin/Instance/V1/Common.php b/Spanner/metadata/Admin/Instance/V1/Common.php index 75e8043d35ca28feb87a1098616dd9f7961d5dba..ce280a9688c2e93af7b4ae16afde68b380f0c3af 100644 GIT binary patch delta 62 zcmcb{wVZncI}?v%L1s))YH@yPQF7|!yNr#D$0x@#1xrb$=jW&Ar0ORYWa<||rS%Gm N@=NkJZ)94^1OUip7d8L@ delta 28 kcmZ3^eT{1aJJV!arf`-utX#Siy>%xaWm4YE%)EpN0DYebMgRZ+ diff --git a/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php b/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php index 8b5e9db042db74928e64a578df25e8e81c54bec9..3bca763a961b13aecf62ffb380c5bb00eef2dfc6 100644 GIT binary patch delta 1069 zcmZ`%&rcIU7b z#DjVx<6oeO2Tz(kaUpv2qQ;w^^duoBgoAg7(kex~?Y{TEnfcy(U$(jZr`+ouN87K5 z9NeI;_P|bY!20aKHrrdU`Yv9zjUxlDtQwj|^itJSOUoKj*Hyi!F6l+x-0-_bxL{XA zr1MiDdN|ZR9ZoQ<*pLdRlu`RP!H#m^yk9FDwKZaHR5U-TPtP`|XT$S#QeoVQJ`91X zSvJ&yMvD5HZjy>-kcv@W)~Z##R3NpIZu))f6g$P8Z?^cy9QgnD0u+Mrgp4r}(^*AG z$1oA{f|wMdVp3EVNiLn0a7;{yINp5$xuLVcCUG~1Jm6$}PLeXR!gw2UK}TH73ehC{ zvm*pu^SO*t6bN33VH{_mgI@snyAJAyUM7)qDWWV&_{?np?J}MdGwGA7;yEEn8h{OT zgDaIwDq<6{U*F~qgiX5b3DQxR4um|-Xkz8ks$Qr@x>^Bi0gfEDS5E7;=O@>j26vM_ z2?6RM(05a#^ixlVJKRj~I0ZW6eH6&U<<SG4C?IuHmw4Dxi(H+d=4*<7g_ z>1cjhKYTA>@`DY|eHyw3PVGTOH#B1EYnq><-v>wNrneoY!Bwji40T1L>gdEV^T|!*4%!jox&QZJoDx7}t-EHq^WhU9AWjhJL&ti83Zpd`rlS8Tm{ndcjxU zTFH=BJD7bkPG$0}zX=7)9x^8jtjrRY#SE*a^ZV>URU_ViFzX`^L%#tbkx6v` delta 140 zcmV;70CWH7iUHYy0kDw-1m|}OJ(CRvA(3nxv(p4c0s_7Uvl<660+U7xtOYt?>OozT zJ})Pe1PnH_TMY380-6c4P7&+@lZq3Avt<+`0h8Mmy97<@K}wT;Eh3Y=7Adp(7NZKY u?jpzm0gkh`B$NRGAd^fc903E9YbHwue(FJc3Mi9+EgzHJCR(#zCkh^kwlN0) diff --git a/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AutoscalingTargets.php b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AutoscalingTargets.php index 45f359fee624..cf5df0923f5b 100644 --- a/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AutoscalingTargets.php +++ b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AutoscalingTargets.php @@ -28,7 +28,7 @@ class AutoscalingTargets extends \Google\Protobuf\Internal\Message * Required. The target storage utilization percentage that the autoscaler * should be trying to achieve for the instance. This number is on a scale * from 0 (no utilization) to 100 (full utilization). The valid range is - * [10, 100] inclusive. + * [10, 99] inclusive. * * Generated from protobuf field int32 storage_utilization_percent = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -49,7 +49,7 @@ class AutoscalingTargets extends \Google\Protobuf\Internal\Message * Required. The target storage utilization percentage that the autoscaler * should be trying to achieve for the instance. This number is on a scale * from 0 (no utilization) to 100 (full utilization). The valid range is - * [10, 100] inclusive. + * [10, 99] inclusive. * } */ public function __construct($data = NULL) { @@ -93,7 +93,7 @@ public function setHighPriorityCpuUtilizationPercent($var) * Required. The target storage utilization percentage that the autoscaler * should be trying to achieve for the instance. This number is on a scale * from 0 (no utilization) to 100 (full utilization). The valid range is - * [10, 100] inclusive. + * [10, 99] inclusive. * * Generated from protobuf field int32 storage_utilization_percent = 2 [(.google.api.field_behavior) = REQUIRED]; * @return int @@ -107,7 +107,7 @@ public function getStorageUtilizationPercent() * Required. The target storage utilization percentage that the autoscaler * should be trying to achieve for the instance. This number is on a scale * from 0 (no utilization) to 100 (full utilization). The valid range is - * [10, 100] inclusive. + * [10, 99] inclusive. * * Generated from protobuf field int32 storage_utilization_percent = 2 [(.google.api.field_behavior) = REQUIRED]; * @param int $var diff --git a/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php b/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php index f076d4f7f633..a8c85e0d7c77 100644 --- a/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php +++ b/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php @@ -384,7 +384,7 @@ public function __call($method, $args) /** * Creates an instance and begins preparing it to begin serving. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new * instance. The instance name is assigned by the caller. If the * named instance already exists, `CreateInstance` returns @@ -410,12 +410,12 @@ public function __call($method, $args) * * The instance's allocated resource levels are readable via the API. * * The instance's state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format `/operations/` and * can be used to track creation of the instance. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * * The async variant is {@see InstanceAdminClient::createInstanceAsync()} . @@ -443,7 +443,7 @@ public function createInstance(CreateInstanceRequest $request, array $callOption /** * Creates an instance configuration and begins preparing it to be used. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new * instance configuration. The instance configuration name is assigned by the * caller. If the named instance configuration already exists, @@ -470,13 +470,13 @@ public function createInstance(CreateInstanceRequest $request, array $callOption * [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] * field becomes false. Its state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to track * creation of the instance configuration. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if * successful. * @@ -509,7 +509,7 @@ public function createInstanceConfig(CreateInstanceConfigRequest $request, array /** * Creates an instance partition and begins preparing it to be used. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new instance partition. * The instance partition name is assigned by the caller. If the named * instance partition already exists, `CreateInstancePartition` returns @@ -536,13 +536,13 @@ public function createInstanceConfig(CreateInstanceConfigRequest $request, array * API. * * The instance partition's state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to * track creation of the instance partition. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if * successful. * @@ -775,12 +775,12 @@ public function getInstancePartition(GetInstancePartitionRequest $request, array } /** - * Lists the user-managed instance configuration [long-running - * operations][google.longrunning.Operation] in the given project. An instance + * Lists the user-managed instance configuration long-running + * operations in the given project. An instance * configuration operation has a name of the form * `projects//instanceConfigs//operations/`. * The long-running operation - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. Operations returned * include those that have completed/failed/canceled within the last 7 days, * and pending operations. Operations returned are ordered by @@ -814,6 +814,9 @@ public function listInstanceConfigOperations(ListInstanceConfigOperationsRequest /** * Lists the supported instance configurations for a given project. * + * Returns both Google-managed configurations and user-managed + * configurations. + * * The async variant is {@see InstanceAdminClient::listInstanceConfigsAsync()} . * * @example samples/V1/InstanceAdminClient/list_instance_configs.php @@ -838,12 +841,11 @@ public function listInstanceConfigs(ListInstanceConfigsRequest $request, array $ } /** - * Lists instance partition [long-running - * operations][google.longrunning.Operation] in the given instance. + * Lists instance partition long-running operations in the given instance. * An instance partition operation has a name of the form * `projects//instances//instancePartitions//operations/`. * The long-running operation - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. Operations returned * include those that have completed/failed/canceled within the last 7 days, * and pending operations. Operations returned are ordered by @@ -932,7 +934,7 @@ public function listInstances(ListInstancesRequest $request, array $callOptions /** * Moves an instance to the target instance configuration. You can use the - * returned [long-running operation][google.longrunning.Operation] to track + * returned long-running operation to track * the progress of moving the instance. * * `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of @@ -963,13 +965,13 @@ public function listInstances(ListInstancesRequest $request, array $callOptions * transaction abort rate. However, moving an instance doesn't cause any * downtime. * - * The returned [long-running operation][google.longrunning.Operation] has + * The returned long-running operation has * a name of the format * `/operations/` and can be used to track * the move instance operation. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], * if successful. * Cancelling the operation sets its metadata's @@ -1079,8 +1081,7 @@ public function testIamPermissions(TestIamPermissionsRequest $request, array $ca /** * Updates an instance, and begins allocating or releasing resources - * as requested. The returned [long-running - * operation][google.longrunning.Operation] can be used to track the + * as requested. The returned long-running operation can be used to track the * progress of updating the instance. If the named instance does not * exist, returns `NOT_FOUND`. * @@ -1108,12 +1109,12 @@ public function testIamPermissions(TestIamPermissionsRequest $request, array $ca * tables. * * The instance's new resource levels are readable via the API. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format `/operations/` and * can be used to track the instance modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * * Authorization requires `spanner.instances.update` permission on @@ -1144,7 +1145,7 @@ public function updateInstance(UpdateInstanceRequest $request, array $callOption /** * Updates an instance configuration. The returned - * [long-running operation][google.longrunning.Operation] can be used to track + * long-running operation can be used to track * the progress of updating the instance. If the named instance configuration * does not exist, returns `NOT_FOUND`. * @@ -1175,13 +1176,13 @@ public function updateInstance(UpdateInstanceRequest $request, array $callOption * [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] * field becomes false. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to track * the instance configuration modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if * successful. * @@ -1213,8 +1214,7 @@ public function updateInstanceConfig(UpdateInstanceConfigRequest $request, array /** * Updates an instance partition, and begins allocating or releasing resources - * as requested. The returned [long-running - * operation][google.longrunning.Operation] can be used to track the + * as requested. The returned long-running operation can be used to track the * progress of updating the instance partition. If the named instance * partition does not exist, returns `NOT_FOUND`. * @@ -1243,13 +1243,13 @@ public function updateInstanceConfig(UpdateInstanceConfigRequest $request, array * partition's tables. * * The instance partition's new resource levels are readable via the API. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to * track the instance partition modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if * successful. * diff --git a/Spanner/src/Admin/Instance/V1/CreateInstanceConfigRequest.php b/Spanner/src/Admin/Instance/V1/CreateInstanceConfigRequest.php index 72182a6d1a46..d629275fc079 100644 --- a/Spanner/src/Admin/Instance/V1/CreateInstanceConfigRequest.php +++ b/Spanner/src/Admin/Instance/V1/CreateInstanceConfigRequest.php @@ -10,7 +10,7 @@ /** * The request for - * [CreateInstanceConfigRequest][InstanceAdmin.CreateInstanceConfigRequest]. + * [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig]. * * Generated from protobuf message google.spanner.admin.instance.v1.CreateInstanceConfigRequest */ @@ -33,10 +33,10 @@ class CreateInstanceConfigRequest extends \Google\Protobuf\Internal\Message */ private $instance_config_id = ''; /** - * Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig instance_config = 3 [(.google.api.field_behavior) = REQUIRED]; @@ -54,10 +54,10 @@ class CreateInstanceConfigRequest extends \Google\Protobuf\Internal\Message * @param string $parent Required. The name of the project in which to create the instance * configuration. Values are of the form `projects/`. Please see * {@see InstanceAdminClient::projectName()} for help formatting this field. - * @param \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig $instanceConfig Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * @param \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig $instanceConfig Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * @param string $instanceConfigId Required. The ID of the instance configuration to create. Valid identifiers * are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 @@ -91,10 +91,10 @@ public static function build(string $parent, \Google\Cloud\Spanner\Admin\Instanc * characters in length. The `custom-` prefix is required to avoid name * conflicts with Google-managed configurations. * @type \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig $instance_config - * Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * @type bool $validate_only * An option to validate, but not actually execute, a request, @@ -167,10 +167,10 @@ public function setInstanceConfigId($var) } /** - * Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig instance_config = 3 [(.google.api.field_behavior) = REQUIRED]; @@ -192,10 +192,10 @@ public function clearInstanceConfig() } /** - * Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig instance_config = 3 [(.google.api.field_behavior) = REQUIRED]; diff --git a/Spanner/src/Admin/Instance/V1/DeleteInstanceConfigRequest.php b/Spanner/src/Admin/Instance/V1/DeleteInstanceConfigRequest.php index 6cc41a917dcc..e8c7334f4693 100644 --- a/Spanner/src/Admin/Instance/V1/DeleteInstanceConfigRequest.php +++ b/Spanner/src/Admin/Instance/V1/DeleteInstanceConfigRequest.php @@ -10,7 +10,7 @@ /** * The request for - * [DeleteInstanceConfigRequest][InstanceAdmin.DeleteInstanceConfigRequest]. + * [DeleteInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceConfig]. * * Generated from protobuf message google.spanner.admin.instance.v1.DeleteInstanceConfigRequest */ diff --git a/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata.php b/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata.php new file mode 100644 index 000000000000..26702b73547b --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata.php @@ -0,0 +1,180 @@ +google.spanner.admin.instance.v1.FreeInstanceMetadata + */ +class FreeInstanceMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Timestamp after which the instance will either be upgraded or + * scheduled for deletion after a grace period. ExpireBehavior is used to + * choose between upgrading or scheduling the free instance for deletion. This + * timestamp is set during the creation of a free instance. + * + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $expire_time = null; + /** + * Output only. If present, the timestamp at which the free instance was + * upgraded to a provisioned instance. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $upgrade_time = null; + /** + * Specifies the expiration behavior of a free instance. The default of + * ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during + * or after creation, and before expiration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3; + */ + private $expire_behavior = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $expire_time + * Output only. Timestamp after which the instance will either be upgraded or + * scheduled for deletion after a grace period. ExpireBehavior is used to + * choose between upgrading or scheduling the free instance for deletion. This + * timestamp is set during the creation of a free instance. + * @type \Google\Protobuf\Timestamp $upgrade_time + * Output only. If present, the timestamp at which the free instance was + * upgraded to a provisioned instance. + * @type int $expire_behavior + * Specifies the expiration behavior of a free instance. The default of + * ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during + * or after creation, and before expiration. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\Admin\Instance\V1\SpannerInstanceAdmin::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Timestamp after which the instance will either be upgraded or + * scheduled for deletion after a grace period. ExpireBehavior is used to + * choose between upgrading or scheduling the free instance for deletion. This + * timestamp is set during the creation of a free instance. + * + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getExpireTime() + { + return $this->expire_time; + } + + public function hasExpireTime() + { + return isset($this->expire_time); + } + + public function clearExpireTime() + { + unset($this->expire_time); + } + + /** + * Output only. Timestamp after which the instance will either be upgraded or + * scheduled for deletion after a grace period. ExpireBehavior is used to + * choose between upgrading or scheduling the free instance for deletion. This + * timestamp is set during the creation of a free instance. + * + * Generated from protobuf field .google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setExpireTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->expire_time = $var; + + return $this; + } + + /** + * Output only. If present, the timestamp at which the free instance was + * upgraded to a provisioned instance. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpgradeTime() + { + return $this->upgrade_time; + } + + public function hasUpgradeTime() + { + return isset($this->upgrade_time); + } + + public function clearUpgradeTime() + { + unset($this->upgrade_time); + } + + /** + * Output only. If present, the timestamp at which the free instance was + * upgraded to a provisioned instance. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpgradeTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->upgrade_time = $var; + + return $this; + } + + /** + * Specifies the expiration behavior of a free instance. The default of + * ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during + * or after creation, and before expiration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3; + * @return int + */ + public function getExpireBehavior() + { + return $this->expire_behavior; + } + + /** + * Specifies the expiration behavior of a free instance. The default of + * ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during + * or after creation, and before expiration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3; + * @param int $var + * @return $this + */ + public function setExpireBehavior($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata\ExpireBehavior::class); + $this->expire_behavior = $var; + + return $this; + } + +} + diff --git a/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata/ExpireBehavior.php b/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata/ExpireBehavior.php new file mode 100644 index 000000000000..84f5ec48409f --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/FreeInstanceMetadata/ExpireBehavior.php @@ -0,0 +1,66 @@ +google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior + */ +class ExpireBehavior +{ + /** + * Not specified. + * + * Generated from protobuf enum EXPIRE_BEHAVIOR_UNSPECIFIED = 0; + */ + const EXPIRE_BEHAVIOR_UNSPECIFIED = 0; + /** + * When the free instance expires, upgrade the instance to a provisioned + * instance. + * + * Generated from protobuf enum FREE_TO_PROVISIONED = 1; + */ + const FREE_TO_PROVISIONED = 1; + /** + * When the free instance expires, disable the instance, and delete it + * after the grace period passes if it has not been upgraded. + * + * Generated from protobuf enum REMOVE_AFTER_GRACE_PERIOD = 2; + */ + const REMOVE_AFTER_GRACE_PERIOD = 2; + + private static $valueToName = [ + self::EXPIRE_BEHAVIOR_UNSPECIFIED => 'EXPIRE_BEHAVIOR_UNSPECIFIED', + self::FREE_TO_PROVISIONED => 'FREE_TO_PROVISIONED', + self::REMOVE_AFTER_GRACE_PERIOD => 'REMOVE_AFTER_GRACE_PERIOD', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(ExpireBehavior::class, \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata_ExpireBehavior::class); + diff --git a/Spanner/src/Admin/Instance/V1/Gapic/InstanceAdminGapicClient.php b/Spanner/src/Admin/Instance/V1/Gapic/InstanceAdminGapicClient.php index 4e93f047478a..369c8441c203 100644 --- a/Spanner/src/Admin/Instance/V1/Gapic/InstanceAdminGapicClient.php +++ b/Spanner/src/Admin/Instance/V1/Gapic/InstanceAdminGapicClient.php @@ -488,7 +488,7 @@ public function __construct(array $options = []) /** * Creates an instance and begins preparing it to begin serving. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new * instance. The instance name is assigned by the caller. If the * named instance already exists, `CreateInstance` returns @@ -514,12 +514,12 @@ public function __construct(array $options = []) * * The instance's allocated resource levels are readable via the API. * * The instance's state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format `/operations/` and * can be used to track creation of the instance. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * * Sample code: @@ -608,7 +608,7 @@ public function createInstance( /** * Creates an instance configuration and begins preparing it to be used. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new * instance configuration. The instance configuration name is assigned by the * caller. If the named instance configuration already exists, @@ -635,13 +635,13 @@ public function createInstance( * [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] * field becomes false. Its state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to track * creation of the instance configuration. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if * successful. * @@ -693,10 +693,10 @@ public function createInstance( * are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 * characters in length. The `custom-` prefix is required to avoid name * conflicts with Google-managed configurations. - * @param InstanceConfig $instanceConfig Required. The InstanceConfig proto of the configuration to create. - * instance_config.name must be + * @param InstanceConfig $instanceConfig Required. The `InstanceConfig` proto of the configuration to create. + * `instance_config.name` must be * `/instanceConfigs/`. - * instance_config.base_config must be a Google managed configuration name, + * `instance_config.base_config` must be a Google-managed configuration name, * e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. * @param array $optionalArgs { * Optional. @@ -746,7 +746,7 @@ public function createInstanceConfig( /** * Creates an instance partition and begins preparing it to be used. The - * returned [long-running operation][google.longrunning.Operation] + * returned long-running operation * can be used to track the progress of preparing the new instance partition. * The instance partition name is assigned by the caller. If the named * instance partition already exists, `CreateInstancePartition` returns @@ -773,13 +773,13 @@ public function createInstanceConfig( * API. * * The instance partition's state becomes `READY`. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to * track creation of the instance partition. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if * successful. * @@ -1281,12 +1281,12 @@ public function getInstancePartition($name, array $optionalArgs = []) } /** - * Lists the user-managed instance configuration [long-running - * operations][google.longrunning.Operation] in the given project. An instance + * Lists the user-managed instance configuration long-running + * operations in the given project. An instance * configuration operation has a name of the form * `projects//instanceConfigs//operations/`. * The long-running operation - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. Operations returned * include those that have completed/failed/canceled within the last 7 days, * and pending operations. Operations returned are ordered by @@ -1330,8 +1330,7 @@ public function getInstancePartition($name, array $optionalArgs = []) * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. * Colon `:` is the contains operator. Filter rules are not case sensitive. * - * The following fields in the [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. @@ -1421,6 +1420,9 @@ public function listInstanceConfigOperations( /** * Lists the supported instance configurations for a given project. * + * Returns both Google-managed configurations and user-managed + * configurations. + * * Sample code: * ``` * $instanceAdminClient = new InstanceAdminClient(); @@ -1498,12 +1500,11 @@ public function listInstanceConfigs($parent, array $optionalArgs = []) } /** - * Lists instance partition [long-running - * operations][google.longrunning.Operation] in the given instance. + * Lists instance partition long-running operations in the given instance. * An instance partition operation has a name of the form * `projects//instances//instancePartitions//operations/`. * The long-running operation - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. Operations returned * include those that have completed/failed/canceled within the last 7 days, * and pending operations. Operations returned are ordered by @@ -1551,8 +1552,7 @@ public function listInstanceConfigs($parent, array $optionalArgs = []) * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. * Colon `:` is the contains operator. Filter rules are not case sensitive. * - * The following fields in the [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. @@ -1599,7 +1599,8 @@ public function listInstanceConfigs($parent, array $optionalArgs = []) * Optional. Deadline used while retrieving metadata for instance partition * operations. Instance partitions whose operation metadata cannot be * retrieved within this deadline will be added to - * [unreachable][ListInstancePartitionOperationsResponse.unreachable] in + * [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] + * in * [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an @@ -1678,7 +1679,9 @@ public function listInstancePartitionOperations( * ``` * * @param string $parent Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. * @param array $optionalArgs { * Optional. * @@ -1857,7 +1860,7 @@ public function listInstances($parent, array $optionalArgs = []) /** * Moves an instance to the target instance configuration. You can use the - * returned [long-running operation][google.longrunning.Operation] to track + * returned long-running operation to track * the progress of moving the instance. * * `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of @@ -1888,13 +1891,13 @@ public function listInstances($parent, array $optionalArgs = []) * transaction abort rate. However, moving an instance doesn't cause any * downtime. * - * The returned [long-running operation][google.longrunning.Operation] has + * The returned long-running operation has * a name of the format * `/operations/` and can be used to track * the move instance operation. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], * if successful. * Cancelling the operation sets its metadata's @@ -2127,8 +2130,7 @@ public function testIamPermissions( /** * Updates an instance, and begins allocating or releasing resources - * as requested. The returned [long-running - * operation][google.longrunning.Operation] can be used to track the + * as requested. The returned long-running operation can be used to track the * progress of updating the instance. If the named instance does not * exist, returns `NOT_FOUND`. * @@ -2156,12 +2158,12 @@ public function testIamPermissions( * tables. * * The instance's new resource levels are readable via the API. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format `/operations/` and * can be used to track the instance modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * * Authorization requires `spanner.instances.update` permission on @@ -2252,7 +2254,7 @@ public function updateInstance( /** * Updates an instance configuration. The returned - * [long-running operation][google.longrunning.Operation] can be used to track + * long-running operation can be used to track * the progress of updating the instance. If the named instance configuration * does not exist, returns `NOT_FOUND`. * @@ -2283,13 +2285,13 @@ public function updateInstance( * [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] * field becomes false. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to track * the instance configuration modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if * successful. * @@ -2394,8 +2396,7 @@ public function updateInstanceConfig( /** * Updates an instance partition, and begins allocating or releasing resources - * as requested. The returned [long-running - * operation][google.longrunning.Operation] can be used to track the + * as requested. The returned long-running operation can be used to track the * progress of updating the instance partition. If the named instance * partition does not exist, returns `NOT_FOUND`. * @@ -2424,13 +2425,13 @@ public function updateInstanceConfig( * partition's tables. * * The instance partition's new resource levels are readable via the API. * - * The returned [long-running operation][google.longrunning.Operation] will + * The returned long-running operation will * have a name of the format * `/operations/` and can be used to * track the instance partition modification. The - * [metadata][google.longrunning.Operation.metadata] field type is + * metadata field type is * [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata]. - * The [response][google.longrunning.Operation.response] field type is + * The response field type is * [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if * successful. * diff --git a/Spanner/src/Admin/Instance/V1/Instance.php b/Spanner/src/Admin/Instance/V1/Instance.php index 27cafab2cc74..a056a931e61c 100644 --- a/Spanner/src/Admin/Instance/V1/Instance.php +++ b/Spanner/src/Admin/Instance/V1/Instance.php @@ -49,9 +49,6 @@ class Instance extends \Google\Protobuf\Internal\Message * field and reflects the current number of nodes allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying node count across replicas (achieved by - * setting asymmetric_autoscaling_options in autoscaling config), the - * node_count here is the maximum node count across all replicas. * For more information, see * [Compute capacity, nodes, and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -69,10 +66,6 @@ class Instance extends \Google\Protobuf\Internal\Message * allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying processing units per replica - * (achieved by setting asymmetric_autoscaling_options in autoscaling config), - * the processing_units here is the maximum processing units across all - * replicas. * For more information, see * [Compute capacity, nodes and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -130,6 +123,12 @@ class Instance extends \Google\Protobuf\Internal\Message * Generated from protobuf field map labels = 7; */ private $labels; + /** + * The `InstanceType` of the current instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10; + */ + private $instance_type = 0; /** * Deprecated. This field is not populated. * @@ -148,6 +147,12 @@ class Instance extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $update_time = null; + /** + * Free instance metadata. Only populated for free instances. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13; + */ + private $free_instance_metadata = null; /** * Optional. The `Edition` of the current instance. * @@ -155,13 +160,14 @@ class Instance extends \Google\Protobuf\Internal\Message */ private $edition = 0; /** - * Optional. Controls the default backup behavior for new databases within the - * instance. - * Note that `AUTOMATIC` is not permitted for free instances, as backups and - * backup schedules are not allowed for free instances. + * Optional. Controls the default backup schedule behavior for new databases + * within the instance. By default, a backup schedule is created automatically + * when a new database is created in a new instance. + * Note that the `AUTOMATIC` value isn't permitted for free instances, + * as backups and backup schedules aren't supported for free instances. * In the `GetInstance` or `ListInstances` response, if the value of - * default_backup_schedule_type is unset or NONE, no default backup - * schedule will be created for new databases within the instance. + * `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't + * create a default backup schedule for new databases in the instance. * * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -195,9 +201,6 @@ class Instance extends \Google\Protobuf\Internal\Message * field and reflects the current number of nodes allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying node count across replicas (achieved by - * setting asymmetric_autoscaling_options in autoscaling config), the - * node_count here is the maximum node count across all replicas. * For more information, see * [Compute capacity, nodes, and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -211,10 +214,6 @@ class Instance extends \Google\Protobuf\Internal\Message * allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying processing units per replica - * (achieved by setting asymmetric_autoscaling_options in autoscaling config), - * the processing_units here is the maximum processing units across all - * replicas. * For more information, see * [Compute capacity, nodes and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -252,22 +251,27 @@ class Instance extends \Google\Protobuf\Internal\Message * specific characters being disallowed. For example, representing labels * as the string: name + "_" + value would prove problematic if we were to * allow "_" in a future release. + * @type int $instance_type + * The `InstanceType` of the current instance. * @type array|\Google\Protobuf\Internal\RepeatedField $endpoint_uris * Deprecated. This field is not populated. * @type \Google\Protobuf\Timestamp $create_time * Output only. The time at which the instance was created. * @type \Google\Protobuf\Timestamp $update_time * Output only. The time at which the instance was most recently updated. + * @type \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata $free_instance_metadata + * Free instance metadata. Only populated for free instances. * @type int $edition * Optional. The `Edition` of the current instance. * @type int $default_backup_schedule_type - * Optional. Controls the default backup behavior for new databases within the - * instance. - * Note that `AUTOMATIC` is not permitted for free instances, as backups and - * backup schedules are not allowed for free instances. + * Optional. Controls the default backup schedule behavior for new databases + * within the instance. By default, a backup schedule is created automatically + * when a new database is created in a new instance. + * Note that the `AUTOMATIC` value isn't permitted for free instances, + * as backups and backup schedules aren't supported for free instances. * In the `GetInstance` or `ListInstances` response, if the value of - * default_backup_schedule_type is unset or NONE, no default backup - * schedule will be created for new databases within the instance. + * `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't + * create a default backup schedule for new databases in the instance. * } */ public function __construct($data = NULL) { @@ -376,9 +380,6 @@ public function setDisplayName($var) * field and reflects the current number of nodes allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying node count across replicas (achieved by - * setting asymmetric_autoscaling_options in autoscaling config), the - * node_count here is the maximum node count across all replicas. * For more information, see * [Compute capacity, nodes, and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -400,9 +401,6 @@ public function getNodeCount() * field and reflects the current number of nodes allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying node count across replicas (achieved by - * setting asymmetric_autoscaling_options in autoscaling config), the - * node_count here is the maximum node count across all replicas. * For more information, see * [Compute capacity, nodes, and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -429,10 +427,6 @@ public function setNodeCount($var) * allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying processing units per replica - * (achieved by setting asymmetric_autoscaling_options in autoscaling config), - * the processing_units here is the maximum processing units across all - * replicas. * For more information, see * [Compute capacity, nodes and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -455,10 +449,6 @@ public function getProcessingUnits() * allocated to the instance. * This might be zero in API responses for instances that are not yet in the * `READY` state. - * If the instance has varying processing units per replica - * (achieved by setting asymmetric_autoscaling_options in autoscaling config), - * the processing_units here is the maximum processing units across all - * replicas. * For more information, see * [Compute capacity, nodes and processing * units](https://cloud.google.com/spanner/docs/compute-capacity). @@ -641,6 +631,32 @@ public function setLabels($var) return $this; } + /** + * The `InstanceType` of the current instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10; + * @return int + */ + public function getInstanceType() + { + return $this->instance_type; + } + + /** + * The `InstanceType` of the current instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.InstanceType instance_type = 10; + * @param int $var + * @return $this + */ + public function setInstanceType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\Instance\InstanceType::class); + $this->instance_type = $var; + + return $this; + } + /** * Deprecated. This field is not populated. * @@ -739,6 +755,42 @@ public function setUpdateTime($var) return $this; } + /** + * Free instance metadata. Only populated for free instances. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13; + * @return \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata|null + */ + public function getFreeInstanceMetadata() + { + return $this->free_instance_metadata; + } + + public function hasFreeInstanceMetadata() + { + return isset($this->free_instance_metadata); + } + + public function clearFreeInstanceMetadata() + { + unset($this->free_instance_metadata); + } + + /** + * Free instance metadata. Only populated for free instances. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.FreeInstanceMetadata free_instance_metadata = 13; + * @param \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata $var + * @return $this + */ + public function setFreeInstanceMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\FreeInstanceMetadata::class); + $this->free_instance_metadata = $var; + + return $this; + } + /** * Optional. The `Edition` of the current instance. * @@ -766,13 +818,14 @@ public function setEdition($var) } /** - * Optional. Controls the default backup behavior for new databases within the - * instance. - * Note that `AUTOMATIC` is not permitted for free instances, as backups and - * backup schedules are not allowed for free instances. + * Optional. Controls the default backup schedule behavior for new databases + * within the instance. By default, a backup schedule is created automatically + * when a new database is created in a new instance. + * Note that the `AUTOMATIC` value isn't permitted for free instances, + * as backups and backup schedules aren't supported for free instances. * In the `GetInstance` or `ListInstances` response, if the value of - * default_backup_schedule_type is unset or NONE, no default backup - * schedule will be created for new databases within the instance. + * `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't + * create a default backup schedule for new databases in the instance. * * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -783,13 +836,14 @@ public function getDefaultBackupScheduleType() } /** - * Optional. Controls the default backup behavior for new databases within the - * instance. - * Note that `AUTOMATIC` is not permitted for free instances, as backups and - * backup schedules are not allowed for free instances. + * Optional. Controls the default backup schedule behavior for new databases + * within the instance. By default, a backup schedule is created automatically + * when a new database is created in a new instance. + * Note that the `AUTOMATIC` value isn't permitted for free instances, + * as backups and backup schedules aren't supported for free instances. * In the `GetInstance` or `ListInstances` response, if the value of - * default_backup_schedule_type is unset or NONE, no default backup - * schedule will be created for new databases within the instance. + * `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't + * create a default backup schedule for new databases in the instance. * * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var diff --git a/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php b/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php index ee1c54f26a01..ca0a5ec8fd95 100644 --- a/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php +++ b/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php @@ -7,8 +7,10 @@ use UnexpectedValueException; /** - * Indicates the default backup behavior for new databases within the - * instance. + * Indicates the + * [default backup + * schedule](https://cloud.google.com/spanner/docs/backup#default-backup-schedules) + * behavior for new databases within the instance. * * Protobuf type google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType */ @@ -21,18 +23,17 @@ class DefaultBackupScheduleType */ const DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0; /** - * No default backup schedule will be created automatically on creation of a - * database within the instance. + * A default backup schedule isn't created automatically when a new database + * is created in the instance. * * Generated from protobuf enum NONE = 1; */ const NONE = 1; /** - * A default backup schedule will be created automatically on creation of a - * database within the instance. The default backup schedule creates a full - * backup every 24 hours and retains the backup for a period of 7 days. Once - * created, the default backup schedule can be edited/deleted similar to any - * other backup schedule. + * A default backup schedule is created automatically when a new database + * is created in the instance. The default backup schedule creates a full + * backup every 24 hours. These full backups are retained for 7 days. + * You can edit or delete the default backup schedule once it's created. * * Generated from protobuf enum AUTOMATIC = 2; */ diff --git a/Spanner/src/Admin/Instance/V1/Instance/InstanceType.php b/Spanner/src/Admin/Instance/V1/Instance/InstanceType.php new file mode 100644 index 000000000000..6e29f52acf69 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/Instance/InstanceType.php @@ -0,0 +1,70 @@ +google.spanner.admin.instance.v1.Instance.InstanceType + */ +class InstanceType +{ + /** + * Not specified. + * + * Generated from protobuf enum INSTANCE_TYPE_UNSPECIFIED = 0; + */ + const INSTANCE_TYPE_UNSPECIFIED = 0; + /** + * Provisioned instances have dedicated resources, standard usage limits and + * support. + * + * Generated from protobuf enum PROVISIONED = 1; + */ + const PROVISIONED = 1; + /** + * Free instances provide no guarantee for dedicated resources, + * [node_count, processing_units] should be 0. They come + * with stricter usage limits and limited support. + * + * Generated from protobuf enum FREE_INSTANCE = 2; + */ + const FREE_INSTANCE = 2; + + private static $valueToName = [ + self::INSTANCE_TYPE_UNSPECIFIED => 'INSTANCE_TYPE_UNSPECIFIED', + self::PROVISIONED => 'PROVISIONED', + self::FREE_INSTANCE => 'FREE_INSTANCE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(InstanceType::class, \Google\Cloud\Spanner\Admin\Instance\V1\Instance_InstanceType::class); + diff --git a/Spanner/src/Admin/Instance/V1/InstanceConfig.php b/Spanner/src/Admin/Instance/V1/InstanceConfig.php index 73b4e0350fee..1f08fb03d2aa 100644 --- a/Spanner/src/Admin/Instance/V1/InstanceConfig.php +++ b/Spanner/src/Admin/Instance/V1/InstanceConfig.php @@ -41,22 +41,26 @@ class InstanceConfig extends \Google\Protobuf\Internal\Message /** * The geographic placement of nodes in this instance configuration and their * replication properties. + * To create user-managed configurations, input + * `replicas` must include all replicas in `replicas` of the `base_config` + * and include one or more replicas in the `optional_replicas` of the + * `base_config`. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3; */ private $replicas; /** - * Output only. The available optional replicas to choose from for user - * managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for + * user-managed configurations. Populated for Google-managed configurations. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $optional_replicas; /** * Base configuration name, e.g. projects//instanceConfigs/nam3, - * based on which this configuration is created. Only set for user managed + * based on which this configuration is created. Only set for user-managed * configurations. `base_config` must refer to a configuration of type - * GOOGLE_MANAGED in the same project as this configuration. + * `GOOGLE_MANAGED` in the same project as this configuration. * * Generated from protobuf field string base_config = 7 [(.google.api.resource_reference) = { */ @@ -122,6 +126,25 @@ class InstanceConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $state = 0; + /** + * Output only. Describes whether free instances are available to be created + * in this instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability free_instance_availability = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $free_instance_availability = 0; + /** + * Output only. The `QuorumType` of the instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.QuorumType quorum_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $quorum_type = 0; + /** + * Output only. The storage limit in bytes per processing unit. + * + * Generated from protobuf field int64 storage_limit_per_processing_unit = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $storage_limit_per_processing_unit = 0; /** * Constructor. @@ -142,14 +165,18 @@ class InstanceConfig extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>|\Google\Protobuf\Internal\RepeatedField $replicas * The geographic placement of nodes in this instance configuration and their * replication properties. + * To create user-managed configurations, input + * `replicas` must include all replicas in `replicas` of the `base_config` + * and include one or more replicas in the `optional_replicas` of the + * `base_config`. * @type array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>|\Google\Protobuf\Internal\RepeatedField $optional_replicas - * Output only. The available optional replicas to choose from for user - * managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for + * user-managed configurations. Populated for Google-managed configurations. * @type string $base_config * Base configuration name, e.g. projects//instanceConfigs/nam3, - * based on which this configuration is created. Only set for user managed + * based on which this configuration is created. Only set for user-managed * configurations. `base_config` must refer to a configuration of type - * GOOGLE_MANAGED in the same project as this configuration. + * `GOOGLE_MANAGED` in the same project as this configuration. * @type array|\Google\Protobuf\Internal\MapField $labels * Cloud Labels are a flexible and lightweight mechanism for organizing cloud * resources into groups that reflect a customer's organizational needs and @@ -191,6 +218,13 @@ class InstanceConfig extends \Google\Protobuf\Internal\Message * @type int $state * Output only. The current instance configuration state. Applicable only for * `USER_MANAGED` configurations. + * @type int $free_instance_availability + * Output only. Describes whether free instances are available to be created + * in this instance configuration. + * @type int $quorum_type + * Output only. The `QuorumType` of the instance configuration. + * @type int|string $storage_limit_per_processing_unit + * Output only. The storage limit in bytes per processing unit. * } */ public function __construct($data = NULL) { @@ -287,6 +321,10 @@ public function setConfigType($var) /** * The geographic placement of nodes in this instance configuration and their * replication properties. + * To create user-managed configurations, input + * `replicas` must include all replicas in `replicas` of the `base_config` + * and include one or more replicas in the `optional_replicas` of the + * `base_config`. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3; * @return \Google\Protobuf\Internal\RepeatedField @@ -299,6 +337,10 @@ public function getReplicas() /** * The geographic placement of nodes in this instance configuration and their * replication properties. + * To create user-managed configurations, input + * `replicas` must include all replicas in `replicas` of the `base_config` + * and include one or more replicas in the `optional_replicas` of the + * `base_config`. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3; * @param array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>|\Google\Protobuf\Internal\RepeatedField $var @@ -313,8 +355,8 @@ public function setReplicas($var) } /** - * Output only. The available optional replicas to choose from for user - * managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for + * user-managed configurations. Populated for Google-managed configurations. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField @@ -325,8 +367,8 @@ public function getOptionalReplicas() } /** - * Output only. The available optional replicas to choose from for user - * managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for + * user-managed configurations. Populated for Google-managed configurations. * * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>|\Google\Protobuf\Internal\RepeatedField $var @@ -342,9 +384,9 @@ public function setOptionalReplicas($var) /** * Base configuration name, e.g. projects//instanceConfigs/nam3, - * based on which this configuration is created. Only set for user managed + * based on which this configuration is created. Only set for user-managed * configurations. `base_config` must refer to a configuration of type - * GOOGLE_MANAGED in the same project as this configuration. + * `GOOGLE_MANAGED` in the same project as this configuration. * * Generated from protobuf field string base_config = 7 [(.google.api.resource_reference) = { * @return string @@ -356,9 +398,9 @@ public function getBaseConfig() /** * Base configuration name, e.g. projects//instanceConfigs/nam3, - * based on which this configuration is created. Only set for user managed + * based on which this configuration is created. Only set for user-managed * configurations. `base_config` must refer to a configuration of type - * GOOGLE_MANAGED in the same project as this configuration. + * `GOOGLE_MANAGED` in the same project as this configuration. * * Generated from protobuf field string base_config = 7 [(.google.api.resource_reference) = { * @param string $var @@ -564,5 +606,85 @@ public function setState($var) return $this; } + /** + * Output only. Describes whether free instances are available to be created + * in this instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability free_instance_availability = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getFreeInstanceAvailability() + { + return $this->free_instance_availability; + } + + /** + * Output only. Describes whether free instances are available to be created + * in this instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability free_instance_availability = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setFreeInstanceAvailability($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig\FreeInstanceAvailability::class); + $this->free_instance_availability = $var; + + return $this; + } + + /** + * Output only. The `QuorumType` of the instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.QuorumType quorum_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getQuorumType() + { + return $this->quorum_type; + } + + /** + * Output only. The `QuorumType` of the instance configuration. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.QuorumType quorum_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setQuorumType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig\QuorumType::class); + $this->quorum_type = $var; + + return $this; + } + + /** + * Output only. The storage limit in bytes per processing unit. + * + * Generated from protobuf field int64 storage_limit_per_processing_unit = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getStorageLimitPerProcessingUnit() + { + return $this->storage_limit_per_processing_unit; + } + + /** + * Output only. The storage limit in bytes per processing unit. + * + * Generated from protobuf field int64 storage_limit_per_processing_unit = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setStorageLimitPerProcessingUnit($var) + { + GPBUtil::checkInt64($var); + $this->storage_limit_per_processing_unit = $var; + + return $this; + } + } diff --git a/Spanner/src/Admin/Instance/V1/InstanceConfig/FreeInstanceAvailability.php b/Spanner/src/Admin/Instance/V1/InstanceConfig/FreeInstanceAvailability.php new file mode 100644 index 000000000000..ae20bdcc9e24 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/InstanceConfig/FreeInstanceAvailability.php @@ -0,0 +1,84 @@ +google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability + */ +class FreeInstanceAvailability +{ + /** + * Not specified. + * + * Generated from protobuf enum FREE_INSTANCE_AVAILABILITY_UNSPECIFIED = 0; + */ + const FREE_INSTANCE_AVAILABILITY_UNSPECIFIED = 0; + /** + * Indicates that free instances are available to be created in this + * instance configuration. + * + * Generated from protobuf enum AVAILABLE = 1; + */ + const AVAILABLE = 1; + /** + * Indicates that free instances are not supported in this instance + * configuration. + * + * Generated from protobuf enum UNSUPPORTED = 2; + */ + const UNSUPPORTED = 2; + /** + * Indicates that free instances are currently not available to be created + * in this instance configuration. + * + * Generated from protobuf enum DISABLED = 3; + */ + const DISABLED = 3; + /** + * Indicates that additional free instances cannot be created in this + * instance configuration because the project has reached its limit of free + * instances. + * + * Generated from protobuf enum QUOTA_EXCEEDED = 4; + */ + const QUOTA_EXCEEDED = 4; + + private static $valueToName = [ + self::FREE_INSTANCE_AVAILABILITY_UNSPECIFIED => 'FREE_INSTANCE_AVAILABILITY_UNSPECIFIED', + self::AVAILABLE => 'AVAILABLE', + self::UNSUPPORTED => 'UNSUPPORTED', + self::DISABLED => 'DISABLED', + self::QUOTA_EXCEEDED => 'QUOTA_EXCEEDED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(FreeInstanceAvailability::class, \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig_FreeInstanceAvailability::class); + diff --git a/Spanner/src/Admin/Instance/V1/InstanceConfig/QuorumType.php b/Spanner/src/Admin/Instance/V1/InstanceConfig/QuorumType.php new file mode 100644 index 000000000000..19b056f5c710 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/InstanceConfig/QuorumType.php @@ -0,0 +1,78 @@ +google.spanner.admin.instance.v1.InstanceConfig.QuorumType + */ +class QuorumType +{ + /** + * Quorum type not specified. + * + * Generated from protobuf enum QUORUM_TYPE_UNSPECIFIED = 0; + */ + const QUORUM_TYPE_UNSPECIFIED = 0; + /** + * An instance configuration tagged with `REGION` quorum type forms a write + * quorum in a single region. + * + * Generated from protobuf enum REGION = 1; + */ + const REGION = 1; + /** + * An instance configuration tagged with the `DUAL_REGION` quorum type forms + * a write quorum with exactly two read-write regions in a multi-region + * configuration. + * This instance configuration requires failover in the event of + * regional failures. + * + * Generated from protobuf enum DUAL_REGION = 2; + */ + const DUAL_REGION = 2; + /** + * An instance configuration tagged with the `MULTI_REGION` quorum type + * forms a write quorum from replicas that are spread across more than one + * region in a multi-region configuration. + * + * Generated from protobuf enum MULTI_REGION = 3; + */ + const MULTI_REGION = 3; + + private static $valueToName = [ + self::QUORUM_TYPE_UNSPECIFIED => 'QUORUM_TYPE_UNSPECIFIED', + self::REGION => 'REGION', + self::DUAL_REGION => 'DUAL_REGION', + self::MULTI_REGION => 'MULTI_REGION', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(QuorumType::class, \Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig_QuorumType::class); + diff --git a/Spanner/src/Admin/Instance/V1/InstanceConfig/Type.php b/Spanner/src/Admin/Instance/V1/InstanceConfig/Type.php index c51f5593a52e..08f5079da568 100644 --- a/Spanner/src/Admin/Instance/V1/InstanceConfig/Type.php +++ b/Spanner/src/Admin/Instance/V1/InstanceConfig/Type.php @@ -20,13 +20,13 @@ class Type */ const TYPE_UNSPECIFIED = 0; /** - * Google managed configuration. + * Google-managed configuration. * * Generated from protobuf enum GOOGLE_MANAGED = 1; */ const GOOGLE_MANAGED = 1; /** - * User managed configuration. + * User-managed configuration. * * Generated from protobuf enum USER_MANAGED = 2; */ diff --git a/Spanner/src/Admin/Instance/V1/InstancePartition.php b/Spanner/src/Admin/Instance/V1/InstancePartition.php index 7ce35ef9a0ca..6616bb2d174c 100644 --- a/Spanner/src/Admin/Instance/V1/InstancePartition.php +++ b/Spanner/src/Admin/Instance/V1/InstancePartition.php @@ -72,12 +72,14 @@ class InstancePartition extends \Google\Protobuf\Internal\Message */ private $referencing_databases; /** + * Output only. Deprecated: This field is not populated. * Output only. The names of the backups that reference this instance * partition. Referencing backups should share the parent instance. The * existence of any referencing backup prevents the instance partition from * being deleted. * - * Generated from protobuf field repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @deprecated */ private $referencing_backups; /** @@ -120,16 +122,16 @@ class InstancePartition extends \Google\Protobuf\Internal\Message * UIs. Must be unique per project and between 4 and 30 characters in length. * @type int $node_count * The number of nodes allocated to this instance partition. - * Users can set the node_count field to specify the target number of nodes - * allocated to the instance partition. + * Users can set the `node_count` field to specify the target number of + * nodes allocated to the instance partition. * This may be zero in API responses for instance partitions that are not * yet in state `READY`. * @type int $processing_units * The number of processing units allocated to this instance partition. - * Users can set the processing_units field to specify the target number of - * processing units allocated to the instance partition. - * This may be zero in API responses for instance partitions that are not - * yet in state `READY`. + * Users can set the `processing_units` field to specify the target number + * of processing units allocated to the instance partition. + * This might be zero in API responses for instance partitions that are not + * yet in the `READY` state. * @type int $state * Output only. The current instance partition state. * @type \Google\Protobuf\Timestamp $create_time @@ -143,6 +145,7 @@ class InstancePartition extends \Google\Protobuf\Internal\Message * The existence of any referencing database prevents the instance partition * from being deleted. * @type array|\Google\Protobuf\Internal\RepeatedField $referencing_backups + * Output only. Deprecated: This field is not populated. * Output only. The names of the backups that reference this instance * partition. Referencing backups should share the parent instance. The * existence of any referencing backup prevents the instance partition from @@ -263,8 +266,8 @@ public function setDisplayName($var) /** * The number of nodes allocated to this instance partition. - * Users can set the node_count field to specify the target number of nodes - * allocated to the instance partition. + * Users can set the `node_count` field to specify the target number of + * nodes allocated to the instance partition. * This may be zero in API responses for instance partitions that are not * yet in state `READY`. * @@ -283,8 +286,8 @@ public function hasNodeCount() /** * The number of nodes allocated to this instance partition. - * Users can set the node_count field to specify the target number of nodes - * allocated to the instance partition. + * Users can set the `node_count` field to specify the target number of + * nodes allocated to the instance partition. * This may be zero in API responses for instance partitions that are not * yet in state `READY`. * @@ -302,10 +305,10 @@ public function setNodeCount($var) /** * The number of processing units allocated to this instance partition. - * Users can set the processing_units field to specify the target number of - * processing units allocated to the instance partition. - * This may be zero in API responses for instance partitions that are not - * yet in state `READY`. + * Users can set the `processing_units` field to specify the target number + * of processing units allocated to the instance partition. + * This might be zero in API responses for instance partitions that are not + * yet in the `READY` state. * * Generated from protobuf field int32 processing_units = 6; * @return int @@ -322,10 +325,10 @@ public function hasProcessingUnits() /** * The number of processing units allocated to this instance partition. - * Users can set the processing_units field to specify the target number of - * processing units allocated to the instance partition. - * This may be zero in API responses for instance partitions that are not - * yet in state `READY`. + * Users can set the `processing_units` field to specify the target number + * of processing units allocated to the instance partition. + * This might be zero in API responses for instance partitions that are not + * yet in the `READY` state. * * Generated from protobuf field int32 processing_units = 6; * @param int $var @@ -472,31 +475,37 @@ public function setReferencingDatabases($var) } /** + * Output only. Deprecated: This field is not populated. * Output only. The names of the backups that reference this instance * partition. Referencing backups should share the parent instance. The * existence of any referencing backup prevents the instance partition from * being deleted. * - * Generated from protobuf field repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField + * @deprecated */ public function getReferencingBackups() { + @trigger_error('referencing_backups is deprecated.', E_USER_DEPRECATED); return $this->referencing_backups; } /** + * Output only. Deprecated: This field is not populated. * Output only. The names of the backups that reference this instance * partition. Referencing backups should share the parent instance. The * existence of any referencing backup prevents the instance partition from * being deleted. * - * Generated from protobuf field repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field repeated string referencing_backups = 11 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this + * @deprecated */ public function setReferencingBackups($var) { + @trigger_error('referencing_backups is deprecated.', E_USER_DEPRECATED); $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->referencing_backups = $arr; diff --git a/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsRequest.php b/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsRequest.php index 17dfdb2ca079..bc7db4ec11ee 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsRequest.php +++ b/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsRequest.php @@ -30,8 +30,7 @@ class ListInstanceConfigOperationsRequest extends \Google\Protobuf\Internal\Mess * The value must be a string, a number, or a boolean. The comparison operator * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. * Colon `:` is the contains operator. Filter rules are not case sensitive. - * The following fields in the [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -114,8 +113,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -196,8 +194,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -243,8 +240,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string diff --git a/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php b/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php index 10d805eb3e32..5554a74f4ab7 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php +++ b/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php @@ -17,10 +17,10 @@ class ListInstanceConfigOperationsResponse extends \Google\Protobuf\Internal\Message { /** - * The list of matching instance configuration [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance configuration long-running operations. Each + * operation's name will be * prefixed by the name of the instance configuration. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; @@ -42,10 +42,10 @@ class ListInstanceConfigOperationsResponse extends \Google\Protobuf\Internal\Mes * Optional. Data for populating the Message object. * * @type array<\Google\LongRunning\Operation>|\Google\Protobuf\Internal\RepeatedField $operations - * The list of matching instance configuration [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance configuration long-running operations. Each + * operation's name will be * prefixed by the name of the instance configuration. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * @type string $next_page_token * `next_page_token` can be sent in a subsequent @@ -59,10 +59,10 @@ public function __construct($data = NULL) { } /** - * The list of matching instance configuration [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance configuration long-running operations. Each + * operation's name will be * prefixed by the name of the instance configuration. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; @@ -74,10 +74,10 @@ public function getOperations() } /** - * The list of matching instance configuration [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance configuration long-running operations. Each + * operation's name will be * prefixed by the name of the instance configuration. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; diff --git a/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsRequest.php b/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsRequest.php index 3f66a1028928..b3a881c4b384 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsRequest.php +++ b/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsRequest.php @@ -30,8 +30,7 @@ class ListInstancePartitionOperationsRequest extends \Google\Protobuf\Internal\M * The value must be a string, a number, or a boolean. The comparison operator * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. * Colon `:` is the contains operator. Filter rules are not case sensitive. - * The following fields in the [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -86,7 +85,8 @@ class ListInstancePartitionOperationsRequest extends \Google\Protobuf\Internal\M * Optional. Deadline used while retrieving metadata for instance partition * operations. Instance partitions whose operation metadata cannot be * retrieved within this deadline will be added to - * [unreachable][ListInstancePartitionOperationsResponse.unreachable] in + * [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] + * in * [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]. * * Generated from protobuf field .google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -124,8 +124,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -168,7 +167,8 @@ public static function build(string $parent): self * Optional. Deadline used while retrieving metadata for instance partition * operations. Instance partitions whose operation metadata cannot be * retrieved within this deadline will be added to - * [unreachable][ListInstancePartitionOperationsResponse.unreachable] in + * [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] + * in * [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]. * } */ @@ -212,8 +212,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -259,8 +258,7 @@ 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 [Operation][google.longrunning.Operation] - * are eligible for filtering: + * The following fields in the Operation are eligible for filtering: * * `name` - The name of the long-running operation * * `done` - False if the operation is in progress, else true. * * `metadata.@type` - the type of metadata. For example, the type string @@ -369,7 +367,8 @@ public function setPageToken($var) * Optional. Deadline used while retrieving metadata for instance partition * operations. Instance partitions whose operation metadata cannot be * retrieved within this deadline will be added to - * [unreachable][ListInstancePartitionOperationsResponse.unreachable] in + * [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] + * in * [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]. * * Generated from protobuf field .google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -394,7 +393,8 @@ public function clearInstancePartitionDeadline() * Optional. Deadline used while retrieving metadata for instance partition * operations. Instance partitions whose operation metadata cannot be * retrieved within this deadline will be added to - * [unreachable][ListInstancePartitionOperationsResponse.unreachable] in + * [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] + * in * [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]. * * Generated from protobuf field .google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsResponse.php b/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsResponse.php index 8ed281a554bf..886c45864495 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsResponse.php +++ b/Spanner/src/Admin/Instance/V1/ListInstancePartitionOperationsResponse.php @@ -17,10 +17,10 @@ class ListInstancePartitionOperationsResponse extends \Google\Protobuf\Internal\Message { /** - * The list of matching instance partition [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance partition long-running operations. Each + * operation's name will be * prefixed by the instance partition's name. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; @@ -51,10 +51,10 @@ class ListInstancePartitionOperationsResponse extends \Google\Protobuf\Internal\ * Optional. Data for populating the Message object. * * @type array<\Google\LongRunning\Operation>|\Google\Protobuf\Internal\RepeatedField $operations - * The list of matching instance partition [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance partition long-running operations. Each + * operation's name will be * prefixed by the instance partition's name. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * @type string $next_page_token * `next_page_token` can be sent in a subsequent @@ -73,10 +73,10 @@ public function __construct($data = NULL) { } /** - * The list of matching instance partition [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance partition long-running operations. Each + * operation's name will be * prefixed by the instance partition's name. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; @@ -88,10 +88,10 @@ public function getOperations() } /** - * The list of matching instance partition [long-running - * operations][google.longrunning.Operation]. Each operation's name will be + * The list of matching instance partition long-running operations. Each + * operation's name will be * prefixed by the instance partition's name. The operation's - * [metadata][google.longrunning.Operation.metadata] field type + * metadata field type * `metadata.type_url` describes the type of the metadata. * * Generated from protobuf field repeated .google.longrunning.Operation operations = 1; diff --git a/Spanner/src/Admin/Instance/V1/ListInstancePartitionsRequest.php b/Spanner/src/Admin/Instance/V1/ListInstancePartitionsRequest.php index 877be2da98d1..370831027f22 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstancePartitionsRequest.php +++ b/Spanner/src/Admin/Instance/V1/ListInstancePartitionsRequest.php @@ -18,7 +18,9 @@ class ListInstancePartitionsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -53,7 +55,9 @@ class ListInstancePartitionsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. Please see + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. Please see * {@see InstanceAdminClient::instanceName()} for help formatting this field. * * @return \Google\Cloud\Spanner\Admin\Instance\V1\ListInstancePartitionsRequest @@ -74,7 +78,9 @@ public static function build(string $parent): self * * @type string $parent * Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. * @type int $page_size * Number of instance partitions to be returned in the response. If 0 or less, * defaults to the server's maximum allowed page size. @@ -99,7 +105,9 @@ public function __construct($data = NULL) { /** * Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -111,7 +119,9 @@ public function getParent() /** * Required. The instance whose instance partitions should be listed. Values - * are of the form `projects//instances/`. + * are of the form `projects//instances/`. Use `{instance} + * = '-'` to list instance partitions for all Instances in a project, e.g., + * `projects/myproject/instances/-`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/Spanner/src/Admin/Instance/V1/ListInstancePartitionsResponse.php b/Spanner/src/Admin/Instance/V1/ListInstancePartitionsResponse.php index 916ce4a772ff..306569fa24d5 100644 --- a/Spanner/src/Admin/Instance/V1/ListInstancePartitionsResponse.php +++ b/Spanner/src/Admin/Instance/V1/ListInstancePartitionsResponse.php @@ -31,9 +31,9 @@ class ListInstancePartitionsResponse extends \Google\Protobuf\Internal\Message */ private $next_page_token = ''; /** - * The list of unreachable instance partitions. - * It includes the names of instance partitions whose metadata could - * not be retrieved within + * The list of unreachable instances or instance partitions. + * It includes the names of instances or instance partitions whose metadata + * could not be retrieved within * [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline]. * * Generated from protobuf field repeated string unreachable = 3; @@ -53,9 +53,9 @@ class ListInstancePartitionsResponse extends \Google\Protobuf\Internal\Message * [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions] * call to fetch more of the matching instance partitions. * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable - * The list of unreachable instance partitions. - * It includes the names of instance partitions whose metadata could - * not be retrieved within + * The list of unreachable instances or instance partitions. + * It includes the names of instances or instance partitions whose metadata + * could not be retrieved within * [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline]. * } */ @@ -121,9 +121,9 @@ public function setNextPageToken($var) } /** - * The list of unreachable instance partitions. - * It includes the names of instance partitions whose metadata could - * not be retrieved within + * The list of unreachable instances or instance partitions. + * It includes the names of instances or instance partitions whose metadata + * could not be retrieved within * [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline]. * * Generated from protobuf field repeated string unreachable = 3; @@ -135,9 +135,9 @@ public function getUnreachable() } /** - * The list of unreachable instance partitions. - * It includes the names of instance partitions whose metadata could - * not be retrieved within + * The list of unreachable instances or instance partitions. + * It includes the names of instances or instance partitions whose metadata + * could not be retrieved within * [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline]. * * Generated from protobuf field repeated string unreachable = 3; diff --git a/Spanner/src/Admin/Instance/V1/ReplicaInfo.php b/Spanner/src/Admin/Instance/V1/ReplicaInfo.php index 858d005c5bc3..0da8919cc59c 100644 --- a/Spanner/src/Admin/Instance/V1/ReplicaInfo.php +++ b/Spanner/src/Admin/Instance/V1/ReplicaInfo.php @@ -14,7 +14,7 @@ class ReplicaInfo extends \Google\Protobuf\Internal\Message { /** - * The location of the serving resources, e.g. "us-central1". + * The location of the serving resources, e.g., "us-central1". * * Generated from protobuf field string location = 1; */ @@ -42,7 +42,7 @@ class ReplicaInfo extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $location - * The location of the serving resources, e.g. "us-central1". + * The location of the serving resources, e.g., "us-central1". * @type int $type * The type of replica. * @type bool $default_leader_location @@ -58,7 +58,7 @@ public function __construct($data = NULL) { } /** - * The location of the serving resources, e.g. "us-central1". + * The location of the serving resources, e.g., "us-central1". * * Generated from protobuf field string location = 1; * @return string @@ -69,7 +69,7 @@ public function getLocation() } /** - * The location of the serving resources, e.g. "us-central1". + * The location of the serving resources, e.g., "us-central1". * * Generated from protobuf field string location = 1; * @param string $var diff --git a/Spanner/src/Admin/Instance/V1/UpdateInstanceConfigRequest.php b/Spanner/src/Admin/Instance/V1/UpdateInstanceConfigRequest.php index 29962464c2b5..5cd410d7208e 100644 --- a/Spanner/src/Admin/Instance/V1/UpdateInstanceConfigRequest.php +++ b/Spanner/src/Admin/Instance/V1/UpdateInstanceConfigRequest.php @@ -10,7 +10,7 @@ /** * The request for - * [UpdateInstanceConfigRequest][InstanceAdmin.UpdateInstanceConfigRequest]. + * [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig]. * * Generated from protobuf message google.spanner.admin.instance.v1.UpdateInstanceConfigRequest */ diff --git a/Spanner/tests/Unit/Admin/Instance/V1/Client/InstanceAdminClientTest.php b/Spanner/tests/Unit/Admin/Instance/V1/Client/InstanceAdminClientTest.php index 1d694ac1b6d9..bd01402c01ee 100644 --- a/Spanner/tests/Unit/Admin/Instance/V1/Client/InstanceAdminClientTest.php +++ b/Spanner/tests/Unit/Admin/Instance/V1/Client/InstanceAdminClientTest.php @@ -277,12 +277,14 @@ public function createInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -884,12 +886,14 @@ public function getInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->instanceConfigName('[PROJECT]', '[INSTANCE_CONFIG]'); @@ -1816,12 +1820,14 @@ public function updateInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); diff --git a/Spanner/tests/Unit/Admin/Instance/V1/InstanceAdminClientTest.php b/Spanner/tests/Unit/Admin/Instance/V1/InstanceAdminClientTest.php index 1cd269d78353..dcd7cec82b34 100644 --- a/Spanner/tests/Unit/Admin/Instance/V1/InstanceAdminClientTest.php +++ b/Spanner/tests/Unit/Admin/Instance/V1/InstanceAdminClientTest.php @@ -248,12 +248,14 @@ public function createInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -819,12 +821,14 @@ public function getInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->instanceConfigName('[PROJECT]', '[INSTANCE_CONFIG]'); @@ -1699,12 +1703,14 @@ public function updateInstanceConfigTest() $baseConfig = 'baseConfig1990483056'; $etag = 'etag3123477'; $reconciling = false; + $storageLimitPerProcessingUnit = 1769187130; $expectedResponse = new InstanceConfig(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setBaseConfig($baseConfig); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setStorageLimitPerProcessingUnit($storageLimitPerProcessingUnit); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation();