docs: [servicehealth] update proto comments (#10393)

* docs: update proto comments PiperOrigin-RevId: 607453590 Source-Link: googleapis/googleapis@f65b9f2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/31d0d15acfe31204627f797fc7df6794a5fbe0c0 Copy-Tag: eyJwIjoiamF2YS1zZXJ2aWNlaGVhbHRoLy5Pd2xCb3QueWFtbCIsImgiOiIzMWQwZDE1YWNmZTMxMjA0NjI3Zjc5N2ZjN2RmNjc5NGE1ZmJlMGMwIn0= * 🦉 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 <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Feb 16, 2024 · 96f8994 · 96f8994
1 parent 2315a47
commit 96f8994
Show file tree

Hide file tree

Showing 61 changed files with 118 additions and 85 deletions.
diff --git a/java-servicehealth/README.md b/java-servicehealth/README.md
@@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-servicehealth/java11.html
 [stability-image]: https://img.shields.io/badge/stability-preview-yellow
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-servicehealth.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-servicehealth/0.1.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-servicehealth/0.2.0
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/...ud-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/ServiceHealthClient.java b/...ud-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/ServiceHealthClient.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/ServiceHealthSettings.java b/...-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/ServiceHealthSettings.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -174,7 +174,6 @@ public static TransportChannelProvider defaultTransportChannelProvider() {
     return ServiceHealthStubSettings.defaultTransportChannelProvider();
   }
 
-  @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
   public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
     return ServiceHealthStubSettings.defaultApiClientHeaderProviderBuilder();
   }

diff --git a/...gle-cloud-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/package-info.java b/...gle-cloud-servicehealth/src/main/java/com/google/cloud/servicehealth/v1/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...rc/main/java/com/google/cloud/servicehealth/v1/stub/GrpcServiceHealthCallableFactory.java b/...rc/main/java/com/google/cloud/servicehealth/v1/stub/GrpcServiceHealthCallableFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...icehealth/src/main/java/com/google/cloud/servicehealth/v1/stub/GrpcServiceHealthStub.java b/...icehealth/src/main/java/com/google/cloud/servicehealth/v1/stub/GrpcServiceHealthStub.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ain/java/com/google/cloud/servicehealth/v1/stub/HttpJsonServiceHealthCallableFactory.java b/...ain/java/com/google/cloud/servicehealth/v1/stub/HttpJsonServiceHealthCallableFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ealth/src/main/java/com/google/cloud/servicehealth/v1/stub/HttpJsonServiceHealthStub.java b/...ealth/src/main/java/com/google/cloud/servicehealth/v1/stub/HttpJsonServiceHealthStub.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...servicehealth/src/main/java/com/google/cloud/servicehealth/v1/stub/ServiceHealthStub.java b/...servicehealth/src/main/java/com/google/cloud/servicehealth/v1/stub/ServiceHealthStub.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ealth/src/main/java/com/google/cloud/servicehealth/v1/stub/ServiceHealthStubSettings.java b/...ealth/src/main/java/com/google/cloud/servicehealth/v1/stub/ServiceHealthStubSettings.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -511,7 +511,6 @@ public static TransportChannelProvider defaultTransportChannelProvider() {
     return defaultGrpcTransportProviderBuilder().build();
   }
 
-  @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
   public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
     return ApiClientHeaderProvider.newBuilder()
         .setGeneratedLibToken(
@@ -520,7 +519,6 @@ public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProvider
             GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
   }
 
-  @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
   public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
     return ApiClientHeaderProvider.newBuilder()
         .setGeneratedLibToken(

diff --git a/...le-cloud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockLocations.java b/...le-cloud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockLocations.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...loud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockLocationsImpl.java b/...loud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockLocationsImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...loud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockServiceHealth.java b/...loud-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockServiceHealth.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockServiceHealthImpl.java b/...-servicehealth/src/test/java/com/google/cloud/servicehealth/v1/MockServiceHealthImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...alth/src/test/java/com/google/cloud/servicehealth/v1/ServiceHealthClientHttpJsonTest.java b/...alth/src/test/java/com/google/cloud/servicehealth/v1/ServiceHealthClientHttpJsonTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ervicehealth/src/test/java/com/google/cloud/servicehealth/v1/ServiceHealthClientTest.java b/...ervicehealth/src/test/java/com/google/cloud/servicehealth/v1/ServiceHealthClientTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...-google-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/Event.java b/...-google-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/Event.java
@@ -606,9 +606,13 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was automatically closed because the issues couldn’t be
-     * confirmed or is no longer impacting Google Cloud Products and/or
-     * Locations.
+     * The incident was automatically closed because of the following reasons:
+     *
+     *  * The impact of the incident could not be confirmed.
+     *  * The incident was intermittent or resolved itself.
+     *
+     *  The incident does not have a resolution because no action or
+     *  investigation happened. If it is intermittent, the incident may reopen.
      * </pre>
      *
      * <code>AUTO_CLOSED = 9;</code>
@@ -618,7 +622,9 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was verified as non-impactful. No further action required.
+     * Upon investigation, Google engineers concluded that the incident is not
+     * affecting a Google Cloud product. This state can change if the incident
+     * is reviewed again.
      * </pre>
      *
      * <code>FALSE_POSITIVE = 10;</code>
@@ -686,9 +692,13 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was automatically closed because the issues couldn’t be
-     * confirmed or is no longer impacting Google Cloud Products and/or
-     * Locations.
+     * The incident was automatically closed because of the following reasons:
+     *
+     *  * The impact of the incident could not be confirmed.
+     *  * The incident was intermittent or resolved itself.
+     *
+     *  The incident does not have a resolution because no action or
+     *  investigation happened. If it is intermittent, the incident may reopen.
      * </pre>
      *
      * <code>AUTO_CLOSED = 9;</code>
@@ -698,7 +708,9 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was verified as non-impactful. No further action required.
+     * Upon investigation, Google engineers concluded that the incident is not
+     * affecting a Google Cloud product. This state can change if the incident
+     * is reviewed again.
      * </pre>
      *
      * <code>FALSE_POSITIVE = 10;</code>

diff --git a/...gle-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/EventName.java b/...gle-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/EventName.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/LocationName.java b/...-cloud-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/LocationName.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...d-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationEvent.java b/...d-servicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationEvent.java
@@ -612,9 +612,13 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was automatically closed because the issues couldn’t be
-     * confirmed or is no longer impacting Google Cloud Products and/or
-     * Locations.
+     * The incident was automatically closed because of the following reasons:
+     *
+     *  * The impact of the incident could not be confirmed.
+     *  * The incident was intermittent or resolved itself.
+     *
+     *  The incident does not have a resolution because no action or
+     *  investigation happened. If it is intermittent, the incident may reopen.
      * </pre>
      *
      * <code>AUTO_CLOSED = 9;</code>
@@ -624,7 +628,9 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was verified as non-impactful. No further action required.
+     * Upon investigation, Google engineers concluded that the incident is not
+     * affecting a Google Cloud product. This state can change if the incident
+     * is reviewed again.
      * </pre>
      *
      * <code>FALSE_POSITIVE = 10;</code>
@@ -692,9 +698,13 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was automatically closed because the issues couldn’t be
-     * confirmed or is no longer impacting Google Cloud Products and/or
-     * Locations.
+     * The incident was automatically closed because of the following reasons:
+     *
+     *  * The impact of the incident could not be confirmed.
+     *  * The incident was intermittent or resolved itself.
+     *
+     *  The incident does not have a resolution because no action or
+     *  investigation happened. If it is intermittent, the incident may reopen.
      * </pre>
      *
      * <code>AUTO_CLOSED = 9;</code>
@@ -704,7 +714,9 @@ public enum DetailedState implements com.google.protobuf.ProtocolMessageEnum {
      *
      *
      * <pre>
-     * The incident was verified as non-impactful. No further action required.
+     * Upon investigation, Google engineers concluded that the incident is not
+     * affecting a Google Cloud product. This state can change if the incident
+     * is reviewed again.
      * </pre>
      *
      * <code>FALSE_POSITIVE = 10;</code>

diff --git a/...rvicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationEventName.java b/...rvicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationEventName.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...vicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationImpactName.java b/...vicehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationImpactName.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...cehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationLocationName.java b/...cehealth-v1/src/main/java/com/google/cloud/servicehealth/v1/OrganizationLocationName.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...cloud-servicehealth-v1/src/main/proto/google/cloud/servicehealth/v1/event_resources.proto b/...cloud-servicehealth-v1/src/main/proto/google/cloud/servicehealth/v1/event_resources.proto
@@ -105,12 +105,18 @@ message Event {
     // name of the parent.
     MERGED = 4;
 
-    // The incident was automatically closed because the issues couldn’t be
-    // confirmed or is no longer impacting Google Cloud Products and/or
-    // Locations.
+    // The incident was automatically closed because of the following reasons:
+    //
+    //  * The impact of the incident could not be confirmed.
+    //  * The incident was intermittent or resolved itself.
+    //
+    //  The incident does not have a resolution because no action or
+    //  investigation happened. If it is intermittent, the incident may reopen.
     AUTO_CLOSED = 9;
 
-    // The incident was verified as non-impactful. No further action required.
+    // Upon investigation, Google engineers concluded that the incident is not
+    // affecting a Google Cloud product. This state can change if the incident
+    // is reviewed again.
     FALSE_POSITIVE = 10;
   }
 
@@ -273,12 +279,18 @@ message OrganizationEvent {
     // parent.
     MERGED = 4;
 
-    // The incident was automatically closed because the issues couldn’t be
-    // confirmed or is no longer impacting Google Cloud Products and/or
-    // Locations.
+    // The incident was automatically closed because of the following reasons:
+    //
+    //  * The impact of the incident could not be confirmed.
+    //  * The incident was intermittent or resolved itself.
+    //
+    //  The incident does not have a resolution because no action or
+    //  investigation happened. If it is intermittent, the incident may reopen.
     AUTO_CLOSED = 9;
 
-    // The incident was verified as non-impactful. No further action required.
+    // Upon investigation, Google engineers concluded that the incident is not
+    // affecting a Google Cloud product. This state can change if the incident
+    // is reviewed again.
     FALSE_POSITIVE = 10;
   }
 

diff --git a/.../google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetCredentialsProvider.java b/.../google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetCredentialsProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetCredentialsProvider1.java b/...google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetCredentialsProvider1.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...nerated/com/google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetEndpoint.java b/...nerated/com/google/cloud/servicehealth/v1/servicehealth/create/SyncCreateSetEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ets/generated/com/google/cloud/servicehealth/v1/servicehealth/getevent/AsyncGetEvent.java b/...ets/generated/com/google/cloud/servicehealth/v1/servicehealth/getevent/AsyncGetEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...pets/generated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEvent.java b/...pets/generated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...rated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEventEventname.java b/...rated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEventEventname.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...enerated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEventString.java b/...enerated/com/google/cloud/servicehealth/v1/servicehealth/getevent/SyncGetEventString.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...nerated/com/google/cloud/servicehealth/v1/servicehealth/getlocation/AsyncGetLocation.java b/...nerated/com/google/cloud/servicehealth/v1/servicehealth/getlocation/AsyncGetLocation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...enerated/com/google/cloud/servicehealth/v1/servicehealth/getlocation/SyncGetLocation.java b/...enerated/com/google/cloud/servicehealth/v1/servicehealth/getlocation/SyncGetLocation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.