From ed19628c9c2eb23b00bfafb980ca1becec8fd70c Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 19 Jul 2024 14:04:41 -0700 Subject: [PATCH] docs: formatting, grammar, better comments for MaintenanceWindow and SqlUpdateTrack (#7535) PiperOrigin-RevId: 653721475 Source-Link: https://github.com/googleapis/googleapis/commit/7613f7dbea263507d08dfbe8d44115a978617be3 Source-Link: https://github.com/googleapis/googleapis-gen/commit/ef27c860335c765803173e3dc934944bd64845e8 Copy-Tag: eyJwIjoiU3FsQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImVmMjdjODYwMzM1Yzc2NTgwMzE3M2UzZGM5MzQ5NDRiZDY0ODQ1ZTgifQ== --- SqlAdmin/src/V1/MaintenanceWindow.php | 60 ++++++++++++++++----------- SqlAdmin/src/V1/SqlUpdateTrack.php | 21 +++++----- 2 files changed, 47 insertions(+), 34 deletions(-) diff --git a/SqlAdmin/src/V1/MaintenanceWindow.php b/SqlAdmin/src/V1/MaintenanceWindow.php index e33837d44c42..5ca180bd001b 100644 --- a/SqlAdmin/src/V1/MaintenanceWindow.php +++ b/SqlAdmin/src/V1/MaintenanceWindow.php @@ -17,21 +17,23 @@ class MaintenanceWindow extends \Google\Protobuf\Internal\Message { /** - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * * Generated from protobuf field .google.protobuf.Int32Value hour = 1; */ protected $hour = null; /** - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * * Generated from protobuf field .google.protobuf.Int32Value day = 2; */ protected $day = null; /** - * Maintenance timing setting: `canary` (Earlier) or `stable` (Later). - * [Learn - * more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). + * Maintenance timing settings: `canary`, `stable`, or `week5`. + * For more information, see [About maintenance on Cloud SQL + * instances](https://cloud.google.com/sql/docs/mysql/maintenance). * * Generated from protobuf field .google.cloud.sql.v1.SqlUpdateTrack update_track = 3; */ @@ -50,13 +52,15 @@ class MaintenanceWindow extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Protobuf\Int32Value $hour - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * @type \Google\Protobuf\Int32Value $day - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * @type int $update_track - * Maintenance timing setting: `canary` (Earlier) or `stable` (Later). - * [Learn - * more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). + * Maintenance timing settings: `canary`, `stable`, or `week5`. + * For more information, see [About maintenance on Cloud SQL + * instances](https://cloud.google.com/sql/docs/mysql/maintenance). * @type string $kind * This is always `sql#maintenanceWindow`. * } @@ -67,7 +71,7 @@ public function __construct($data = NULL) { } /** - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * * Generated from protobuf field .google.protobuf.Int32Value hour = 1; * @return \Google\Protobuf\Int32Value|null @@ -90,7 +94,7 @@ public function clearHour() /** * Returns the unboxed value from getHour() - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * * Generated from protobuf field .google.protobuf.Int32Value hour = 1; * @return int|null @@ -101,7 +105,7 @@ public function getHourUnwrapped() } /** - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * * Generated from protobuf field .google.protobuf.Int32Value hour = 1; * @param \Google\Protobuf\Int32Value $var @@ -118,7 +122,7 @@ public function setHour($var) /** * Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object. - * hour of day - 0 to 23. + * Hour of day - 0 to 23. Specify in the UTC time zone. * * Generated from protobuf field .google.protobuf.Int32Value hour = 1; * @param int|null $var @@ -130,7 +134,9 @@ public function setHourUnwrapped($var) return $this;} /** - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * * Generated from protobuf field .google.protobuf.Int32Value day = 2; * @return \Google\Protobuf\Int32Value|null @@ -153,7 +159,9 @@ public function clearDay() /** * Returns the unboxed value from getDay() - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * * Generated from protobuf field .google.protobuf.Int32Value day = 2; * @return int|null @@ -164,7 +172,9 @@ public function getDayUnwrapped() } /** - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * * Generated from protobuf field .google.protobuf.Int32Value day = 2; * @param \Google\Protobuf\Int32Value $var @@ -181,7 +191,9 @@ public function setDay($var) /** * Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object. - * day of week (1-7), starting on Monday. + * Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, + * `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + * Returned in output as an integer, 1 to 7, where `1` equals Monday. * * Generated from protobuf field .google.protobuf.Int32Value day = 2; * @param int|null $var @@ -193,9 +205,9 @@ public function setDayUnwrapped($var) return $this;} /** - * Maintenance timing setting: `canary` (Earlier) or `stable` (Later). - * [Learn - * more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). + * Maintenance timing settings: `canary`, `stable`, or `week5`. + * For more information, see [About maintenance on Cloud SQL + * instances](https://cloud.google.com/sql/docs/mysql/maintenance). * * Generated from protobuf field .google.cloud.sql.v1.SqlUpdateTrack update_track = 3; * @return int @@ -206,9 +218,9 @@ public function getUpdateTrack() } /** - * Maintenance timing setting: `canary` (Earlier) or `stable` (Later). - * [Learn - * more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). + * Maintenance timing settings: `canary`, `stable`, or `week5`. + * For more information, see [About maintenance on Cloud SQL + * instances](https://cloud.google.com/sql/docs/mysql/maintenance). * * Generated from protobuf field .google.cloud.sql.v1.SqlUpdateTrack update_track = 3; * @param int $var diff --git a/SqlAdmin/src/V1/SqlUpdateTrack.php b/SqlAdmin/src/V1/SqlUpdateTrack.php index 88e415c33b22..b83f41093d28 100644 --- a/SqlAdmin/src/V1/SqlUpdateTrack.php +++ b/SqlAdmin/src/V1/SqlUpdateTrack.php @@ -18,26 +18,27 @@ class SqlUpdateTrack */ const SQL_UPDATE_TRACK_UNSPECIFIED = 0; /** - * For instance update that requires a restart, this update track indicates - * your instance prefer to restart for new version early in maintenance - * window. + * For an instance with a scheduled maintenance window, this maintenance + * timing indicates that the maintenance update is scheduled 7 to 14 days + * after the notification is sent out. Also referred to as `Week 1` (Console) + * and `preview` (gcloud CLI). * * Generated from protobuf enum canary = 1; */ const canary = 1; /** - * For instance update that requires a restart, this update track indicates - * your instance prefer to let Cloud SQL choose the timing of restart (within - * its Maintenance window, if applicable). + * For an instance with a scheduled maintenance window, this maintenance + * timing indicates that the maintenance update is scheduled 15 to 21 days + * after the notification is sent out. Also referred to as `Week 2` (Console) + * and `production` (gcloud CLI). * * Generated from protobuf enum stable = 2; */ const stable = 2; /** - * For instance update that requires a restart, this update track indicates - * your instance prefer to let Cloud SQL choose the timing of restart (within - * its Maintenance window, if applicable) to be at least 5 weeks after the - * notification. + * For instance with a scheduled maintenance window, this maintenance + * timing indicates that the maintenance update is scheduled 35 to 42 days + * after the notification is sent out. * * Generated from protobuf enum week5 = 3; */