docs: small documentation updates

chore: add enums for additional platform logs PiperOrigin-RevId: 549453285
googleapis · Jul 19, 2023 · b9fb22c · b9fb22c
1 parent bbafc65
commit b9fb22c
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 35 deletions.
diff --git a/google/cloud/deploy/v1/BUILD.bazel b/google/cloud/deploy/v1/BUILD.bazel
@@ -349,7 +349,6 @@ load(
 
 csharp_proto_library(
     name = "deploy_csharp_proto",
-    extra_opts = [""],
     deps = [":deploy_proto"],
 )
 

diff --git a/google/cloud/deploy/v1/cloud_deploy.proto b/google/cloud/deploy/v1/cloud_deploy.proto
@@ -326,7 +326,7 @@ service CloudDeploy {
   }
 }
 
-// A `DeliveryPipeline` resource in the Google Cloud Deploy API.
+// A `DeliveryPipeline` resource in the Cloud Deploy API.
 //
 // A `DeliveryPipeline` defines a pipeline through which a Skaffold
 // configuration can progress.
@@ -347,12 +347,11 @@ message DeliveryPipeline {
   string description = 3;
 
   // User annotations. These attributes can only be set and used by the
-  // user, and not by Google Cloud Deploy.
+  // user, and not by Cloud Deploy.
   map<string, string> annotations = 4;
 
   // Labels are attributes that can be set and used by both the
-  // user and by Google Cloud Deploy. Labels must meet the following
-  // constraints:
+  // user and by Cloud Deploy. Labels must meet the following constraints:
   //
   // * Keys and values can contain only lowercase letters, numeric characters,
   // underscores, and dashes.
@@ -816,7 +815,7 @@ message DeleteDeliveryPipelineRequest {
   string etag = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
-// A `Target` resource in the Google Cloud Deploy API.
+// A `Target` resource in the Cloud Deploy API.
 //
 // A `Target` defines a location to which a Skaffold configuration
 // can be deployed.
@@ -840,14 +839,13 @@ message Target {
   string description = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. User annotations. These attributes can only be set and used by
-  // the user, and not by Google Cloud Deploy. See
+  // the user, and not by Cloud Deploy. See
   // https://google.aip.dev/128#annotations for more details such as format and
   // size limitations.
   map<string, string> annotations = 5 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Labels are attributes that can be set and used by both the
-  // user and by Google Cloud Deploy. Labels must meet the following
-  // constraints:
+  // user and by Cloud Deploy. Labels must meet the following constraints:
   //
   // * Keys and values can contain only lowercase letters, numeric characters,
   // underscores, and dashes.
@@ -1221,7 +1219,7 @@ message DeleteTargetRequest {
   string etag = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
-// A `Release` resource in the Google Cloud Deploy API.
+// A `Release` resource in the Cloud Deploy API.
 //
 // A `Release` defines a specific Skaffold configuration instance
 // that can be deployed.
@@ -1269,15 +1267,15 @@ message Release {
       FAILURE_CAUSE_UNSPECIFIED = 0;
 
       // Cloud Build is not available, either because it is not enabled or
-      // because Google Cloud Deploy has insufficient permissions. See [required
+      // because Cloud Deploy has insufficient permissions. See [required
       // permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
       CLOUD_BUILD_UNAVAILABLE = 1;
 
       // The render operation did not complete successfully; check Cloud Build
       // logs.
       EXECUTION_FAILED = 2;
 
-      // Cloud Build failed to fulfill Google Cloud Deploy's request. See
+      // Cloud Build failed to fulfill Cloud Deploy's request. See
       // failure_message for additional details.
       CLOUD_BUILD_REQUEST_FAILED = 3;
     }
@@ -1359,14 +1357,12 @@ message Release {
   string description = 3;
 
   // User annotations. These attributes can only be set and used by the
-  // user, and not by Google Cloud Deploy. See
-  // https://google.aip.dev/128#annotations for more details such as format and
-  // size limitations.
+  // user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
+  // for more details such as format and size limitations.
   map<string, string> annotations = 4;
 
   // Labels are attributes that can be set and used by both the
-  // user and by Google Cloud Deploy. Labels must meet the following
-  // constraints:
+  // user and by Cloud Deploy. Labels must meet the following constraints:
   //
   // * Keys and values can contain only lowercase letters, numeric characters,
   // underscores, and dashes.
@@ -1420,8 +1416,8 @@ message Release {
   string etag = 16;
 
   // The Skaffold version to use when operating on this release, such as
-  // "1.20.0". Not all versions are valid; Google Cloud Deploy supports a
-  // specific set of versions.
+  // "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set
+  // of versions.
   //
   // If unset, the most recent supported Skaffold version will be used.
   string skaffold_version = 19;
@@ -1616,7 +1612,7 @@ message CreateReleaseRequest {
   bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
-// A `Rollout` resource in the Google Cloud Deploy API.
+// A `Rollout` resource in the Cloud Deploy API.
 //
 // A `Rollout` contains information around a specific deployment to a `Target`.
 message Rollout {
@@ -1706,8 +1702,8 @@ message Rollout {
     // No skaffold verify configuration was found.
     VERIFICATION_CONFIG_NOT_FOUND = 6;
 
-    // Cloud Build failed to fulfill Google Cloud Deploy's request. See
-    // failure_message for additional details.
+    // Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+    // for additional details.
     CLOUD_BUILD_REQUEST_FAILED = 7;
   }
 
@@ -1724,14 +1720,12 @@ message Rollout {
   string description = 3;
 
   // User annotations. These attributes can only be set and used by the
-  // user, and not by Google Cloud Deploy. See
-  // https://google.aip.dev/128#annotations for more details such as format and
-  // size limitations.
+  // user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
+  // for more details such as format and size limitations.
   map<string, string> annotations = 4;
 
   // Labels are attributes that can be set and used by both the
-  // user and by Google Cloud Deploy. Labels must meet the following
-  // constraints:
+  // user and by Cloud Deploy. Labels must meet the following constraints:
   //
   // * Keys and values can contain only lowercase letters, numeric characters,
   // underscores, and dashes.
@@ -2234,7 +2228,7 @@ message AbandonReleaseRequest {
 // The response object for `AbandonRelease`.
 message AbandonReleaseResponse {}
 
-// A `JobRun` resource in the Google Cloud Deploy API.
+// A `JobRun` resource in the Cloud Deploy API.
 //
 // A `JobRun` contains information of a single `Rollout` job evaluation.
 message JobRun {
@@ -2326,7 +2320,7 @@ message DeployJobRun {
     FAILURE_CAUSE_UNSPECIFIED = 0;
 
     // Cloud Build is not available, either because it is not enabled or because
-    // Google Cloud Deploy has insufficient permissions. See [Required
+    // Cloud Deploy has insufficient permissions. See [Required
     // permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
     CLOUD_BUILD_UNAVAILABLE = 1;
 
@@ -2341,8 +2335,8 @@ message DeployJobRun {
     // canary deployment. Check the Cloud Build logs for more information.
     MISSING_RESOURCES_FOR_CANARY = 4;
 
-    // Cloud Build failed to fulfill Google Cloud Deploy's request. See
-    // failure_message for additional details.
+    // Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+    // for additional details.
     CLOUD_BUILD_REQUEST_FAILED = 5;
   }
 
@@ -2378,7 +2372,7 @@ message VerifyJobRun {
     FAILURE_CAUSE_UNSPECIFIED = 0;
 
     // Cloud Build is not available, either because it is not enabled or because
-    // Google Cloud Deploy has insufficient permissions. See [required
+    // Cloud Deploy has insufficient permissions. See [required
     // permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
     CLOUD_BUILD_UNAVAILABLE = 1;
 
@@ -2392,8 +2386,8 @@ message VerifyJobRun {
     // No Skaffold verify configuration was found.
     VERIFICATION_CONFIG_NOT_FOUND = 4;
 
-    // Cloud Build failed to fulfill Google Cloud Deploy's request. See
-    // failure_message for additional details.
+    // Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+    // for additional details.
     CLOUD_BUILD_REQUEST_FAILED = 5;
   }
 

diff --git a/google/cloud/deploy/v1/clouddeploy_v1.yaml b/google/cloud/deploy/v1/clouddeploy_v1.yaml
@@ -1,7 +1,7 @@
 type: google.api.Service
 config_version: 3
 name: clouddeploy.googleapis.com
-title: Google Cloud Deploy API
+title: Cloud Deploy API
 
 apis:
 - name: google.cloud.deploy.v1.CloudDeploy

diff --git a/google/cloud/deploy/v1/log_enums.proto b/google/cloud/deploy/v1/log_enums.proto
@@ -35,6 +35,12 @@ enum Type {
   // A process aborted.
   TYPE_PROCESS_ABORTED = 4;
 
+  // Restriction check failed.
+  TYPE_RESTRICTION_VIOLATED = 5;
+
+  // Resource deleted.
+  TYPE_RESOURCE_DELETED = 6;
+
   // Deprecated: This field is never used. Use release_render log type instead.
   TYPE_RENDER_STATUES_CHANGE = 2 [deprecated = true];
 }