From e6a07e1c46d6a01df424e791cfa19998e06cfa10 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 24 Jan 2023 23:18:52 -0800 Subject: [PATCH] chore(certificate-manager): update proto comments (#3883) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: workaround crashes in gRPC for C++ For more details see https://github.com/grpc/grpc/issues/32171 PiperOrigin-RevId: 504336960 Source-Link: https://github.com/googleapis/googleapis/commit/7bfa825d0618f4b9857e68866782694c972585ff Source-Link: https://github.com/googleapis/googleapis-gen/commit/00b38b8e3a39c06be20d049b46c4a39fd09fabef Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNlcnRpZmljYXRlbWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiMDBiMzhiOGUzYTM5YzA2YmUyMGQwNDliNDZjNGEzOWZkMDlmYWJlZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com> --- .../v1/certificate_manager.proto | 24 ++++++++++++------- .../src/v1/certificate_manager_client.ts | 8 +++---- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/packages/google-cloud-certificatemanager/protos/google/cloud/certificatemanager/v1/certificate_manager.proto b/packages/google-cloud-certificatemanager/protos/google/cloud/certificatemanager/v1/certificate_manager.proto index 07b4c085957..29cd39aae22 100644 --- a/packages/google-cloud-certificatemanager/protos/google/cloud/certificatemanager/v1/certificate_manager.proto +++ b/packages/google-cloud-certificatemanager/protos/google/cloud/certificatemanager/v1/certificate_manager.proto @@ -46,15 +46,15 @@ option ruby_package = "Google::Cloud::CertificateManager::V1"; // // The Certificates Manager service exposes the following resources: // -// * `Certificate` which describes a single TLS certificate. -// * `CertificateMap` which describes a collection of certificates that can be +// * `Certificate` that describes a single TLS certificate. +// * `CertificateMap` that describes a collection of certificates that can be // attached to a target resource. -// * `CertificateMapEntry` which describes a single configuration entry that +// * `CertificateMapEntry` that describes a single configuration entry that // consists of a SNI and a group of certificates. It's a subresource of // CertificateMap. // // Certificate, CertificateMap and CertificateMapEntry IDs -// have to match "^[a-z0-9-]{1,63}$" regexp, which means that +// have to fully match the regexp `[a-z0-9-]{1,63}`. In other words, // - only lower case letters, digits, and hyphen are allowed // - length of the resource ID has to be in [1,63] range. // @@ -794,7 +794,9 @@ message Certificate { // Certificate Manager provisions and renews Managed Certificates // automatically, for as long as it's authorized to do so. message ManagedCertificate { + // State of the managed certificate resource. enum State { + // State is unspecified. STATE_UNSPECIFIED = 0; // Certificate Manager attempts to provision or renew the certificate. @@ -815,7 +817,9 @@ message Certificate { // Information about issues with provisioning a Managed Certificate. message ProvisioningIssue { + // Reason for provisioning failures. enum Reason { + // Reason is unspecified. REASON_UNSPECIFIED = 0; // Certificate provisioning failed due to an issue with one or more of @@ -841,7 +845,9 @@ message Certificate { // State of the latest attempt to authorize a domain for certificate // issuance. message AuthorizationAttemptInfo { + // State of the domain for managed certificate issuance. enum State { + // State is unspecified. STATE_UNSPECIFIED = 0; // Certificate provisioning for this domain is under way. GCP will @@ -857,7 +863,9 @@ message Certificate { FAILED = 7; } + // Reason for failure of the authorization attempt for the domain. enum FailureReason { + // FailureReason is unspecified. FAILURE_REASON_UNSPECIFIED = 0; // There was a problem with the user's DNS or load balancer @@ -904,7 +912,7 @@ message Certificate { } ]; - // The resource name for a + // Immutable. The resource name for a // [CertificateIssuanceConfig][google.cloud.certificatemanager.v1.CertificateIssuanceConfig] // used to configure private PKI certificates in the format // `projects/*/locations/*/certificateIssuanceConfigs/*`. @@ -993,7 +1001,7 @@ message CertificateMap { pattern: "projects/{project}/locations/{location}/certificateMaps/{certificate_map}" }; - // Describes a Target Proxy which uses this Certificate Map. + // Describes a Target Proxy that uses this Certificate Map. message GclbTarget { // Defines IP configuration where this Certificate Map is serving. message IpConfig { @@ -1042,7 +1050,7 @@ message CertificateMap { // Set of labels associated with a Certificate Map. map labels = 3; - // Output only. A list of GCLB targets which use this Certificate Map. + // Output only. A list of GCLB targets that use this Certificate Map. // A Target Proxy is only present on this list if it's attached to a // Forwarding Rule. repeated GclbTarget gclb_targets = 4 @@ -1150,7 +1158,7 @@ message DnsAuthorization { // One or more paragraphs of text description of a DnsAuthorization. string description = 5; - // Required. Immutable. A domain which is being authorized. A DnsAuthorization + // Required. Immutable. A domain that is being authorized. A DnsAuthorization // resource covers a single domain and its wildcard, e.g. authorization for // `example.com` can be used to issue certificates for `example.com` and // `*.example.com`. diff --git a/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts b/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts index f96a0074f87..8c1b74afd96 100644 --- a/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts +++ b/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts @@ -55,15 +55,15 @@ const version = require('../../../package.json').version; * * The Certificates Manager service exposes the following resources: * - * * `Certificate` which describes a single TLS certificate. - * * `CertificateMap` which describes a collection of certificates that can be + * * `Certificate` that describes a single TLS certificate. + * * `CertificateMap` that describes a collection of certificates that can be * attached to a target resource. - * * `CertificateMapEntry` which describes a single configuration entry that + * * `CertificateMapEntry` that describes a single configuration entry that * consists of a SNI and a group of certificates. It's a subresource of * CertificateMap. * * Certificate, CertificateMap and CertificateMapEntry IDs - * have to match "^[a-z0-9-]{1,63}$" regexp, which means that + * have to fully match the regexp `[a-z0-9-]{1,63}`. In other words, * - only lower case letters, digits, and hyphen are allowed * - length of the resource ID has to be in [1,63] range. *