From 1ecd7e8d4a241f9be0a6a6d468ae6c085e056ad2 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:47:47 -0500 Subject: [PATCH] feat:fixed formatting of some documentation (#7829) * docs:fixed formatting of some documentation feat:add EncryptionKeyRevocationAction and shutdown duration configuration to Services PiperOrigin-RevId: 695811695 Source-Link: https://github.com/googleapis/googleapis/commit/b80051505c80564af3a7b222d7346c3edcaea8dd Source-Link: https://github.com/googleapis/googleapis-gen/commit/eeb7f0e99eb596b7ba7f37ed088f238ffed21f57 Copy-Tag: eyJwIjoiUnVuLy5Pd2xCb3QueWFtbCIsImgiOiJlZWI3ZjBlOTllYjU5NmI3YmE3ZjM3ZWQwODhmMjM4ZmZlZDIxZjU3In0= --- Run/metadata/V2/RevisionTemplate.php | 9 +-- Run/src/V2/RevisionTemplate.php | 98 +++++++++++++++++++++++++--- Run/src/V2/SecretVolumeSource.php | 28 ++++---- Run/src/V2/VersionToPath.php | 28 ++++---- 4 files changed, 119 insertions(+), 44 deletions(-) diff --git a/Run/metadata/V2/RevisionTemplate.php b/Run/metadata/V2/RevisionTemplate.php index 51eb821e6f7a..0df8acbe163b 100644 --- a/Run/metadata/V2/RevisionTemplate.php +++ b/Run/metadata/V2/RevisionTemplate.php @@ -21,9 +21,8 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Duration::initOnce(); $pool->internalAddGeneratedFile( ' -£ - -+google/cloud/run/v2/revision_template.protogoogle.cloud.run.v2google/api/resource.proto!google/cloud/run/v2/k8s.min.proto)google/cloud/run/v2/vendor_settings.protogoogle/protobuf/duration.proto"î +Ð ++google/cloud/run/v2/revision_template.protogoogle.cloud.run.v2google/api/resource.proto!google/cloud/run/v2/k8s.min.proto)google/cloud/run/v2/vendor_settings.protogoogle/protobuf/duration.proto"› RevisionTemplate5 revision ( B#àAúA run.googleapis.com/RevisionF @@ -42,7 +41,9 @@ public static function initOnce() { encryption_key ( B&úA# !cloudkms.googleapis.com/CryptoKey- max_instance_request_concurrency (BàA; - service_mesh ( 2 .google.cloud.run.v2.ServiceMeshBàA + service_mesh ( 2 .google.cloud.run.v2.ServiceMeshBàAa + encryption_key_revocation_action (22.google.cloud.run.v2.EncryptionKeyRevocationActionBàAH + encryption_key_shutdown_duration ( 2.google.protobuf.DurationBàA session_affinity (BàA" health_check_disabled (BàA= node_selector ( 2!.google.cloud.run.v2.NodeSelectorBàA- diff --git a/Run/src/V2/RevisionTemplate.php b/Run/src/V2/RevisionTemplate.php index 4ba3f6a2eb08..36d1686c1e8b 100644 --- a/Run/src/V2/RevisionTemplate.php +++ b/Run/src/V2/RevisionTemplate.php @@ -110,8 +110,8 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message protected $encryption_key = ''; /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. If not specified or 0, defaults to 80 when requested - * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + * can receive. If not specified or 0, concurrency defaults to 80 when + * requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -122,6 +122,19 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 16 [(.google.api.field_behavior) = OPTIONAL]; */ protected $service_mesh = null; + /** + * Optional. The action to take if the encryption key is revoked. + * + * Generated from protobuf field .google.cloud.run.v2.EncryptionKeyRevocationAction encryption_key_revocation_action = 17 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $encryption_key_revocation_action = 0; + /** + * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration + * before shutting down all instances. The minimum increment is 1 hour. + * + * Generated from protobuf field .google.protobuf.Duration encryption_key_shutdown_duration = 18 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $encryption_key_shutdown_duration = null; /** * Optional. Enable session affinity. * @@ -197,10 +210,15 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message * https://cloud.google.com/run/docs/securing/using-cmek * @type int $max_instance_request_concurrency * Optional. Sets the maximum number of requests that each serving instance - * can receive. If not specified or 0, defaults to 80 when requested - * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + * can receive. If not specified or 0, concurrency defaults to 80 when + * requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * @type \Google\Cloud\Run\V2\ServiceMesh $service_mesh * Optional. Enables service mesh connectivity. + * @type int $encryption_key_revocation_action + * Optional. The action to take if the encryption key is revoked. + * @type \Google\Protobuf\Duration $encryption_key_shutdown_duration + * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration + * before shutting down all instances. The minimum increment is 1 hour. * @type bool $session_affinity * Optional. Enable session affinity. * @type bool $health_check_disabled @@ -584,8 +602,8 @@ public function setEncryptionKey($var) /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. If not specified or 0, defaults to 80 when requested - * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + * can receive. If not specified or 0, concurrency defaults to 80 when + * requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -597,8 +615,8 @@ public function getMaxInstanceRequestConcurrency() /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. If not specified or 0, defaults to 80 when requested - * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + * can receive. If not specified or 0, concurrency defaults to 80 when + * requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -648,6 +666,70 @@ public function setServiceMesh($var) return $this; } + /** + * Optional. The action to take if the encryption key is revoked. + * + * Generated from protobuf field .google.cloud.run.v2.EncryptionKeyRevocationAction encryption_key_revocation_action = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getEncryptionKeyRevocationAction() + { + return $this->encryption_key_revocation_action; + } + + /** + * Optional. The action to take if the encryption key is revoked. + * + * Generated from protobuf field .google.cloud.run.v2.EncryptionKeyRevocationAction encryption_key_revocation_action = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setEncryptionKeyRevocationAction($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Run\V2\EncryptionKeyRevocationAction::class); + $this->encryption_key_revocation_action = $var; + + return $this; + } + + /** + * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration + * before shutting down all instances. The minimum increment is 1 hour. + * + * Generated from protobuf field .google.protobuf.Duration encryption_key_shutdown_duration = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Duration|null + */ + public function getEncryptionKeyShutdownDuration() + { + return $this->encryption_key_shutdown_duration; + } + + public function hasEncryptionKeyShutdownDuration() + { + return isset($this->encryption_key_shutdown_duration); + } + + public function clearEncryptionKeyShutdownDuration() + { + unset($this->encryption_key_shutdown_duration); + } + + /** + * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration + * before shutting down all instances. The minimum increment is 1 hour. + * + * Generated from protobuf field .google.protobuf.Duration encryption_key_shutdown_duration = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setEncryptionKeyShutdownDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->encryption_key_shutdown_duration = $var; + + return $this; + } + /** * Optional. Enable session affinity. * diff --git a/Run/src/V2/SecretVolumeSource.php b/Run/src/V2/SecretVolumeSource.php index 9ee40f9e029b..1007b817c053 100644 --- a/Run/src/V2/SecretVolumeSource.php +++ b/Run/src/V2/SecretVolumeSource.php @@ -44,10 +44,9 @@ class SecretVolumeSource extends \Google\Protobuf\Internal\Message * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * This might be in conflict with other options that affect the @@ -82,10 +81,9 @@ class SecretVolumeSource extends \Google\Protobuf\Internal\Message * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * This might be in conflict with other options that affect the @@ -171,10 +169,9 @@ public function setItems($var) * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * This might be in conflict with other options that affect the @@ -196,10 +193,9 @@ public function getDefaultMode() * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * This might be in conflict with other options that affect the diff --git a/Run/src/V2/VersionToPath.php b/Run/src/V2/VersionToPath.php index 0b16674ef3ea..0bb46774d607 100644 --- a/Run/src/V2/VersionToPath.php +++ b/Run/src/V2/VersionToPath.php @@ -38,10 +38,9 @@ class VersionToPath extends \Google\Protobuf\Internal\Message * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * @@ -69,10 +68,9 @@ class VersionToPath extends \Google\Protobuf\Internal\Message * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * } @@ -146,10 +144,9 @@ public function setVersion($var) * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. * @@ -169,10 +166,9 @@ public function getMode() * * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal * integer value should look exactly as the chmod numeric notation with a - * leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or - * 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or - * 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 - * (base-10). + * leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) + * or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or + * 493 (base-10). * * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. *