Visitar URL original
docs: [clouddeploy] small documentation updates (#9653) · googleapis/google-cloud-java@e77037d · GitHub
Skip to content

Commit e77037d

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [clouddeploy] small documentation updates (#9653)
* docs: small documentation updates chore: add enums for additional platform logs PiperOrigin-RevId: 549453285 Source-Link: googleapis/googleapis@b9fb22c Source-Link: https://github.com/googleapis/googleapis-gen/commit/ea3ae98030b5e04e7288a2a9bd3eca81663491be Copy-Tag: eyJwIjoiamF2YS1kZXBsb3kvLk93bEJvdC55YW1sIiwiaCI6ImVhM2FlOTgwMzBiNWUwNGU3Mjg4YTJhOWJkM2VjYTgxNjYzNDkxYmUifQ== * 🦉 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>
1 parent 289b04b commit e77037d

17 files changed

Lines changed: 295 additions & 346 deletions

File tree

‎java-deploy/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>libraries-bom</artifactId>
23-
<version>26.18.0</version>
23+
<version>26.19.0</version>
2424
<type>pom</type>
2525
<scope>import</scope>
2626
</dependency>
@@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
195195
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
196196
[stability-image]: https://img.shields.io/badge/stability-stable-green
197197
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-deploy.svg
198-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-deploy/1.18.0
198+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-deploy/1.19.0
199199
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
200200
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
201201
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

‎java-deploy/google-cloud-deploy/src/main/java/com/google/cloud/deploy/v1/package-info.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*/
1616

1717
/**
18-
* A client to Google Cloud Deploy API
18+
* A client to Cloud Deploy API
1919
*
2020
* <p>The interfaces provided are listed below, along with usage samples.
2121
*

‎java-deploy/proto-google-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeliveryPipeline.java‎

Lines changed: 24 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*
2323
*
2424
* <pre>
25-
* A `DeliveryPipeline` resource in the Google Cloud Deploy API.
25+
* A `DeliveryPipeline` resource in the Cloud Deploy API.
2626
*
2727
* A `DeliveryPipeline` defines a pipeline through which a Skaffold
2828
* configuration can progress.
@@ -314,7 +314,7 @@ public int getAnnotationsCount() {
314314
*
315315
* <pre>
316316
* User annotations. These attributes can only be set and used by the
317-
* user, and not by Google Cloud Deploy.
317+
* user, and not by Cloud Deploy.
318318
* </pre>
319319
*
320320
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -337,7 +337,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotations() {
337337
*
338338
* <pre>
339339
* User annotations. These attributes can only be set and used by the
340-
* user, and not by Google Cloud Deploy.
340+
* user, and not by Cloud Deploy.
341341
* </pre>
342342
*
343343
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -351,7 +351,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
351351
*
352352
* <pre>
353353
* User annotations. These attributes can only be set and used by the
354-
* user, and not by Google Cloud Deploy.
354+
* user, and not by Cloud Deploy.
355355
* </pre>
356356
*
357357
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -372,7 +372,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
372372
*
373373
* <pre>
374374
* User annotations. These attributes can only be set and used by the
375-
* user, and not by Google Cloud Deploy.
375+
* user, and not by Cloud Deploy.
376376
* </pre>
377377
*
378378
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -420,8 +420,7 @@ public int getLabelsCount() {
420420
*
421421
* <pre>
422422
* Labels are attributes that can be set and used by both the
423-
* user and by Google Cloud Deploy. Labels must meet the following
424-
* constraints:
423+
* user and by Cloud Deploy. Labels must meet the following constraints:
425424
*
426425
* * Keys and values can contain only lowercase letters, numeric characters,
427426
* underscores, and dashes.
@@ -453,8 +452,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabels() {
453452
*
454453
* <pre>
455454
* Labels are attributes that can be set and used by both the
456-
* user and by Google Cloud Deploy. Labels must meet the following
457-
* constraints:
455+
* user and by Cloud Deploy. Labels must meet the following constraints:
458456
*
459457
* * Keys and values can contain only lowercase letters, numeric characters,
460458
* underscores, and dashes.
@@ -477,8 +475,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
477475
*
478476
* <pre>
479477
* Labels are attributes that can be set and used by both the
480-
* user and by Google Cloud Deploy. Labels must meet the following
481-
* constraints:
478+
* user and by Cloud Deploy. Labels must meet the following constraints:
482479
*
483480
* * Keys and values can contain only lowercase letters, numeric characters,
484481
* underscores, and dashes.
@@ -508,8 +505,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
508505
*
509506
* <pre>
510507
* Labels are attributes that can be set and used by both the
511-
* user and by Google Cloud Deploy. Labels must meet the following
512-
* constraints:
508+
* user and by Cloud Deploy. Labels must meet the following constraints:
513509
*
514510
* * Keys and values can contain only lowercase letters, numeric characters,
515511
* underscores, and dashes.
@@ -1116,7 +1112,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
11161112
*
11171113
*
11181114
* <pre>
1119-
* A `DeliveryPipeline` resource in the Google Cloud Deploy API.
1115+
* A `DeliveryPipeline` resource in the Cloud Deploy API.
11201116
*
11211117
* A `DeliveryPipeline` defines a pipeline through which a Skaffold
11221118
* configuration can progress.
@@ -1869,7 +1865,7 @@ public int getAnnotationsCount() {
18691865
*
18701866
* <pre>
18711867
* User annotations. These attributes can only be set and used by the
1872-
* user, and not by Google Cloud Deploy.
1868+
* user, and not by Cloud Deploy.
18731869
* </pre>
18741870
*
18751871
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1892,7 +1888,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotations() {
18921888
*
18931889
* <pre>
18941890
* User annotations. These attributes can only be set and used by the
1895-
* user, and not by Google Cloud Deploy.
1891+
* user, and not by Cloud Deploy.
18961892
* </pre>
18971893
*
18981894
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1906,7 +1902,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
19061902
*
19071903
* <pre>
19081904
* User annotations. These attributes can only be set and used by the
1909-
* user, and not by Google Cloud Deploy.
1905+
* user, and not by Cloud Deploy.
19101906
* </pre>
19111907
*
19121908
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1927,7 +1923,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
19271923
*
19281924
* <pre>
19291925
* User annotations. These attributes can only be set and used by the
1930-
* user, and not by Google Cloud Deploy.
1926+
* user, and not by Cloud Deploy.
19311927
* </pre>
19321928
*
19331929
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1954,7 +1950,7 @@ public Builder clearAnnotations() {
19541950
*
19551951
* <pre>
19561952
* User annotations. These attributes can only be set and used by the
1957-
* user, and not by Google Cloud Deploy.
1953+
* user, and not by Cloud Deploy.
19581954
* </pre>
19591955
*
19601956
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1977,7 +1973,7 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableAnnotations()
19771973
*
19781974
* <pre>
19791975
* User annotations. These attributes can only be set and used by the
1980-
* user, and not by Google Cloud Deploy.
1976+
* user, and not by Cloud Deploy.
19811977
* </pre>
19821978
*
19831979
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -1998,7 +1994,7 @@ public Builder putAnnotations(java.lang.String key, java.lang.String value) {
19981994
*
19991995
* <pre>
20001996
* User annotations. These attributes can only be set and used by the
2001-
* user, and not by Google Cloud Deploy.
1997+
* user, and not by Cloud Deploy.
20021998
* </pre>
20031999
*
20042000
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -2039,8 +2035,7 @@ public int getLabelsCount() {
20392035
*
20402036
* <pre>
20412037
* Labels are attributes that can be set and used by both the
2042-
* user and by Google Cloud Deploy. Labels must meet the following
2043-
* constraints:
2038+
* user and by Cloud Deploy. Labels must meet the following constraints:
20442039
*
20452040
* * Keys and values can contain only lowercase letters, numeric characters,
20462041
* underscores, and dashes.
@@ -2072,8 +2067,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabels() {
20722067
*
20732068
* <pre>
20742069
* Labels are attributes that can be set and used by both the
2075-
* user and by Google Cloud Deploy. Labels must meet the following
2076-
* constraints:
2070+
* user and by Cloud Deploy. Labels must meet the following constraints:
20772071
*
20782072
* * Keys and values can contain only lowercase letters, numeric characters,
20792073
* underscores, and dashes.
@@ -2096,8 +2090,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
20962090
*
20972091
* <pre>
20982092
* Labels are attributes that can be set and used by both the
2099-
* user and by Google Cloud Deploy. Labels must meet the following
2100-
* constraints:
2093+
* user and by Cloud Deploy. Labels must meet the following constraints:
21012094
*
21022095
* * Keys and values can contain only lowercase letters, numeric characters,
21032096
* underscores, and dashes.
@@ -2127,8 +2120,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
21272120
*
21282121
* <pre>
21292122
* Labels are attributes that can be set and used by both the
2130-
* user and by Google Cloud Deploy. Labels must meet the following
2131-
* constraints:
2123+
* user and by Cloud Deploy. Labels must meet the following constraints:
21322124
*
21332125
* * Keys and values can contain only lowercase letters, numeric characters,
21342126
* underscores, and dashes.
@@ -2164,8 +2156,7 @@ public Builder clearLabels() {
21642156
*
21652157
* <pre>
21662158
* Labels are attributes that can be set and used by both the
2167-
* user and by Google Cloud Deploy. Labels must meet the following
2168-
* constraints:
2159+
* user and by Cloud Deploy. Labels must meet the following constraints:
21692160
*
21702161
* * Keys and values can contain only lowercase letters, numeric characters,
21712162
* underscores, and dashes.
@@ -2197,8 +2188,7 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableLabels() {
21972188
*
21982189
* <pre>
21992190
* Labels are attributes that can be set and used by both the
2200-
* user and by Google Cloud Deploy. Labels must meet the following
2201-
* constraints:
2191+
* user and by Cloud Deploy. Labels must meet the following constraints:
22022192
*
22032193
* * Keys and values can contain only lowercase letters, numeric characters,
22042194
* underscores, and dashes.
@@ -2228,8 +2218,7 @@ public Builder putLabels(java.lang.String key, java.lang.String value) {
22282218
*
22292219
* <pre>
22302220
* Labels are attributes that can be set and used by both the
2231-
* user and by Google Cloud Deploy. Labels must meet the following
2232-
* constraints:
2221+
* user and by Cloud Deploy. Labels must meet the following constraints:
22332222
*
22342223
* * Keys and values can contain only lowercase letters, numeric characters,
22352224
* underscores, and dashes.

‎java-deploy/proto-google-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeliveryPipelineOrBuilder.java‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public interface DeliveryPipelineOrBuilder
105105
*
106106
* <pre>
107107
* User annotations. These attributes can only be set and used by the
108-
* user, and not by Google Cloud Deploy.
108+
* user, and not by Cloud Deploy.
109109
* </pre>
110110
*
111111
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -116,7 +116,7 @@ public interface DeliveryPipelineOrBuilder
116116
*
117117
* <pre>
118118
* User annotations. These attributes can only be set and used by the
119-
* user, and not by Google Cloud Deploy.
119+
* user, and not by Cloud Deploy.
120120
* </pre>
121121
*
122122
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -130,7 +130,7 @@ public interface DeliveryPipelineOrBuilder
130130
*
131131
* <pre>
132132
* User annotations. These attributes can only be set and used by the
133-
* user, and not by Google Cloud Deploy.
133+
* user, and not by Cloud Deploy.
134134
* </pre>
135135
*
136136
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -141,7 +141,7 @@ public interface DeliveryPipelineOrBuilder
141141
*
142142
* <pre>
143143
* User annotations. These attributes can only be set and used by the
144-
* user, and not by Google Cloud Deploy.
144+
* user, and not by Cloud Deploy.
145145
* </pre>
146146
*
147147
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -156,7 +156,7 @@ java.lang.String getAnnotationsOrDefault(
156156
*
157157
* <pre>
158158
* User annotations. These attributes can only be set and used by the
159-
* user, and not by Google Cloud Deploy.
159+
* user, and not by Cloud Deploy.
160160
* </pre>
161161
*
162162
* <code>map&lt;string, string&gt; annotations = 4;</code>
@@ -168,8 +168,7 @@ java.lang.String getAnnotationsOrDefault(
168168
*
169169
* <pre>
170170
* Labels are attributes that can be set and used by both the
171-
* user and by Google Cloud Deploy. Labels must meet the following
172-
* constraints:
171+
* user and by Cloud Deploy. Labels must meet the following constraints:
173172
*
174173
* * Keys and values can contain only lowercase letters, numeric characters,
175174
* underscores, and dashes.
@@ -189,8 +188,7 @@ java.lang.String getAnnotationsOrDefault(
189188
*
190189
* <pre>
191190
* Labels are attributes that can be set and used by both the
192-
* user and by Google Cloud Deploy. Labels must meet the following
193-
* constraints:
191+
* user and by Cloud Deploy. Labels must meet the following constraints:
194192
*
195193
* * Keys and values can contain only lowercase letters, numeric characters,
196194
* underscores, and dashes.
@@ -213,8 +211,7 @@ java.lang.String getAnnotationsOrDefault(
213211
*
214212
* <pre>
215213
* Labels are attributes that can be set and used by both the
216-
* user and by Google Cloud Deploy. Labels must meet the following
217-
* constraints:
214+
* user and by Cloud Deploy. Labels must meet the following constraints:
218215
*
219216
* * Keys and values can contain only lowercase letters, numeric characters,
220217
* underscores, and dashes.
@@ -234,8 +231,7 @@ java.lang.String getAnnotationsOrDefault(
234231
*
235232
* <pre>
236233
* Labels are attributes that can be set and used by both the
237-
* user and by Google Cloud Deploy. Labels must meet the following
238-
* constraints:
234+
* user and by Cloud Deploy. Labels must meet the following constraints:
239235
*
240236
* * Keys and values can contain only lowercase letters, numeric characters,
241237
* underscores, and dashes.
@@ -259,8 +255,7 @@ java.lang.String getLabelsOrDefault(
259255
*
260256
* <pre>
261257
* Labels are attributes that can be set and used by both the
262-
* user and by Google Cloud Deploy. Labels must meet the following
263-
* constraints:
258+
* user and by Cloud Deploy. Labels must meet the following constraints:
264259
*
265260
* * Keys and values can contain only lowercase letters, numeric characters,
266261
* underscores, and dashes.

‎java-deploy/proto-google-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeployJobRun.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
8989
*
9090
* <pre>
9191
* Cloud Build is not available, either because it is not enabled or because
92-
* Google Cloud Deploy has insufficient permissions. See [Required
92+
* Cloud Deploy has insufficient permissions. See [Required
9393
* permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
9494
* </pre>
9595
*
@@ -132,8 +132,8 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
132132
*
133133
*
134134
* <pre>
135-
* Cloud Build failed to fulfill Google Cloud Deploy's request. See
136-
* failure_message for additional details.
135+
* Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
136+
* for additional details.
137137
* </pre>
138138
*
139139
* <code>CLOUD_BUILD_REQUEST_FAILED = 5;</code>
@@ -157,7 +157,7 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
157157
*
158158
* <pre>
159159
* Cloud Build is not available, either because it is not enabled or because
160-
* Google Cloud Deploy has insufficient permissions. See [Required
160+
* Cloud Deploy has insufficient permissions. See [Required
161161
* permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
162162
* </pre>
163163
*
@@ -200,8 +200,8 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
200200
*
201201
*
202202
* <pre>
203-
* Cloud Build failed to fulfill Google Cloud Deploy's request. See
204-
* failure_message for additional details.
203+
* Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
204+
* for additional details.
205205
* </pre>
206206
*
207207
* <code>CLOUD_BUILD_REQUEST_FAILED = 5;</code>

0 commit comments

Comments
 (0)