Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: [clouddeploy] small documentation updates #9653

Merged
merged 2 commits into from
Jul 20, 2023
Merged

docs: [clouddeploy] small documentation updates #9653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
339440e
docs: small documentation updates
gcf-owl-bot[bot] Jul 20, 2023
547f08e
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions java-deploy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.18.0</version>
<version>26.19.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -195,7 +195,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/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-deploy.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-deploy/1.18.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-deploy/1.19.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
Expand Down
2 changes: 1 addition & 1 deletion java-deploy/google-cloud-deploy/src/main/java/com/google/cloud/deploy/v1/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

/**
* A client to Google Cloud Deploy API
* A client to Cloud Deploy API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
Expand Down
59 changes: 24 additions & 35 deletions ...oto-google-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeliveryPipeline.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*
*
* <pre>
* 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.
Expand Down Expand Up @@ -314,7 +314,7 @@ public int getAnnotationsCount() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -337,7 +337,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotations() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -351,7 +351,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -372,7 +372,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand Down Expand Up @@ -420,8 +420,7 @@ public int getLabelsCount() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -453,8 +452,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabels() {
*
* <pre>
* 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.
Expand All @@ -477,8 +475,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -508,8 +505,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -1116,7 +1112,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* 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.
Expand Down Expand Up @@ -1869,7 +1865,7 @@ public int getAnnotationsCount() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1892,7 +1888,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotations() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1906,7 +1902,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1927,7 +1923,7 @@ public java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1954,7 +1950,7 @@ public Builder clearAnnotations() {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1977,7 +1973,7 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableAnnotations()
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -1998,7 +1994,7 @@ public Builder putAnnotations(java.lang.String key, java.lang.String value) {
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand Down Expand Up @@ -2039,8 +2035,7 @@ public int getLabelsCount() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -2072,8 +2067,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabels() {
*
* <pre>
* 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.
Expand All @@ -2096,8 +2090,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -2127,8 +2120,7 @@ public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -2164,8 +2156,7 @@ public Builder clearLabels() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -2197,8 +2188,7 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableLabels() {
*
* <pre>
* 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.
Expand Down Expand Up @@ -2228,8 +2218,7 @@ public Builder putLabels(java.lang.String key, java.lang.String value) {
*
* <pre>
* 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.
Expand Down
25 changes: 10 additions & 15 deletions ...e-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeliveryPipelineOrBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public interface DeliveryPipelineOrBuilder
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -116,7 +116,7 @@ public interface DeliveryPipelineOrBuilder
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -130,7 +130,7 @@ public interface DeliveryPipelineOrBuilder
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -141,7 +141,7 @@ public interface DeliveryPipelineOrBuilder
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -156,7 +156,7 @@ java.lang.String getAnnotationsOrDefault(
*
* <pre>
* 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.
* </pre>
*
* <code>map&lt;string, string&gt; annotations = 4;</code>
Expand All @@ -168,8 +168,7 @@ java.lang.String getAnnotationsOrDefault(
*
* <pre>
* 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.
Expand All @@ -189,8 +188,7 @@ java.lang.String getAnnotationsOrDefault(
*
* <pre>
* 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.
Expand All @@ -213,8 +211,7 @@ java.lang.String getAnnotationsOrDefault(
*
* <pre>
* 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.
Expand All @@ -234,8 +231,7 @@ java.lang.String getAnnotationsOrDefault(
*
* <pre>
* 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.
Expand All @@ -259,8 +255,7 @@ java.lang.String getLabelsOrDefault(
*
* <pre>
* 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.
Expand Down
12 changes: 6 additions & 6 deletions ...y/proto-google-cloud-deploy-v1/src/main/java/com/google/cloud/deploy/v1/DeployJobRun.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
*
* <pre>
* 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).
* </pre>
*
Expand Down Expand Up @@ -132,8 +132,8 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* 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.
* </pre>
*
* <code>CLOUD_BUILD_REQUEST_FAILED = 5;</code>
Expand All @@ -157,7 +157,7 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
*
* <pre>
* 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).
* </pre>
*
Expand Down Expand Up @@ -200,8 +200,8 @@ public enum FailureCause implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* 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.
* </pre>
*
* <code>CLOUD_BUILD_REQUEST_FAILED = 5;</code>
Expand Down
Loading
Loading