docs: added explanation for uri fields in resources (#451)

- [ ] Regenerate this pull request now. docs: improved docs format PiperOrigin-RevId: 435479428 Source-Link: googleapis/googleapis@4dd75c2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0f3e9df388b2f84a3d6812826d20a950447c6ebb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGYzZTlkZjM4OGIyZjg0YTNkNjgxMjgyNmQyMGE5NTA0NDdjNmViYiJ9
googleapis · Mar 21, 2022 · 0c506ce · 0c506ce
1 parent d19cb06
commit 0c506ce
Show file tree

Hide file tree

Showing 25 changed files with 829 additions and 532 deletions.
diff --git a/...w-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportAgentRequest.java b/...w-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportAgentRequest.java
@@ -192,6 +192,11 @@ public com.google.protobuf.ByteString getNameBytes() {
    * export the agent to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized agent is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -218,6 +223,11 @@ public java.lang.String getAgentUri() {
    * export the agent to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized agent is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -775,6 +785,11 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
      * export the agent to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized agent is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -800,6 +815,11 @@ public java.lang.String getAgentUri() {
      * export the agent to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized agent is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -825,6 +845,11 @@ public com.google.protobuf.ByteString getAgentUriBytes() {
      * export the agent to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized agent is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -849,6 +874,11 @@ public Builder setAgentUri(java.lang.String value) {
      * export the agent to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized agent is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -869,6 +899,11 @@ public Builder clearAgentUri() {
      * export the agent to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized agent is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...ta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportAgentRequestOrBuilder.java b/...ta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportAgentRequestOrBuilder.java
@@ -62,6 +62,11 @@ public interface ExportAgentRequestOrBuilder
    * export the agent to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized agent is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -77,6 +82,11 @@ public interface ExportAgentRequestOrBuilder
    * export the agent to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized agent is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string agent_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...ow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportFlowRequest.java b/...ow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportFlowRequest.java
@@ -191,6 +191,11 @@ public com.google.protobuf.ByteString getNameBytes() {
    * export the flow to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized flow is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -217,6 +222,11 @@ public java.lang.String getFlowUri() {
    * export the flow to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized flow is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -739,6 +749,11 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
      * export the flow to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized flow is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -764,6 +779,11 @@ public java.lang.String getFlowUri() {
      * export the flow to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized flow is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -789,6 +809,11 @@ public com.google.protobuf.ByteString getFlowUriBytes() {
      * export the flow to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized flow is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -813,6 +838,11 @@ public Builder setFlowUri(java.lang.String value) {
      * export the flow to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized flow is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -833,6 +863,11 @@ public Builder clearFlowUri() {
      * export the flow to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
      * If left unspecified, the serialized flow is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...eta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportFlowRequestOrBuilder.java b/...eta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportFlowRequestOrBuilder.java
@@ -64,6 +64,11 @@ public interface ExportFlowRequestOrBuilder
    * export the flow to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized flow is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -79,6 +84,11 @@ public interface ExportFlowRequestOrBuilder
    * export the flow to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
    * If left unspecified, the serialized flow is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportTestCasesRequest.java b/...-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportTestCasesRequest.java
@@ -401,6 +401,11 @@ public com.google.protobuf.ByteString getParentBytes() {
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>
@@ -418,6 +423,11 @@ public boolean hasGcsUri() {
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>
@@ -448,6 +458,11 @@ public java.lang.String getGcsUri() {
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>
@@ -1118,6 +1133,11 @@ public Builder setParentBytes(com.google.protobuf.ByteString value) {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>
@@ -1136,6 +1156,11 @@ public boolean hasGcsUri() {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>
@@ -1167,6 +1192,11 @@ public java.lang.String getGcsUri() {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>
@@ -1198,6 +1228,11 @@ public com.google.protobuf.ByteString getGcsUriBytes() {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>
@@ -1222,6 +1257,11 @@ public Builder setGcsUri(java.lang.String value) {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>
@@ -1244,6 +1284,11 @@ public Builder clearGcsUri() {
      * export the test cases to. The format of this URI must be
      * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
      * cases is returned inline.
+     * Dialogflow performs a write operation for the Cloud Storage object
+     * on the caller's behalf, so your request authentication must
+     * have write permissions for the object. For more information, see
+     * [Dialogflow access
+     * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      * </pre>
      *
      * <code>string gcs_uri = 2;</code>

diff --git a/...src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportTestCasesRequestOrBuilder.java b/...src/main/java/com/google/cloud/dialogflow/cx/v3beta1/ExportTestCasesRequestOrBuilder.java
@@ -62,6 +62,11 @@ public interface ExportTestCasesRequestOrBuilder
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>
@@ -77,6 +82,11 @@ public interface ExportTestCasesRequestOrBuilder
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>
@@ -92,6 +102,11 @@ public interface ExportTestCasesRequestOrBuilder
    * export the test cases to. The format of this URI must be
    * `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`. If unspecified, the serialized test
    * cases is returned inline.
+   * Dialogflow performs a write operation for the Cloud Storage object
+   * on the caller's behalf, so your request authentication must
+   * have write permissions for the object. For more information, see
+   * [Dialogflow access
+   * control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * </pre>
    *
    * <code>string gcs_uri = 2;</code>