feat: added page in TestConfig (#239)

* feat: added page in TestConfig
docs: clarified wording around Cloud Storage usage

PiperOrigin-RevId: 433282831

Source-Link: googleapis/googleapis@0e87dc7

Source-Link: googleapis/googleapis-gen@1928631
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkyODYzMWYzZWU5MTQ4OGZlMDdiM2Q4MTg4YTUyZDEwODYyNDUzYSJ9

protos/google/cloud/dialogflow/cx/v3/agent.proto

@@ -348,6 +348,12 @@ message ExportAgentRequest {
   // export the agent to. The format of this URI must be
   // `gs://<bucket-name>/<object-name>`.
   // 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).
   string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Environment name. If not set, draft environment is assumed.
@@ -405,6 +411,12 @@ message RestoreAgentRequest {
     // The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
     // to restore agent from. The format of this URI must be
     // `gs://<bucket-name>/<object-name>`.
+    //
+    // Dialogflow performs a read operation for the Cloud Storage object
+    // on the caller's behalf, so your request authentication must
+    // have read permissions for the object. For more information, see
+    // [Dialogflow access
+    // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     string agent_uri = 2;
 
     // Uncompressed raw byte content for agent.

protos/google/cloud/dialogflow/cx/v3/flow.proto

@@ -559,6 +559,12 @@ message ImportFlowRequest {
     // The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
     // to import flow from. The format of this URI must be
     // `gs://<bucket-name>/<object-name>`.
+    //
+    // Dialogflow performs a read operation for the Cloud Storage object
+    // on the caller's behalf, so your request authentication must
+    // have read permissions for the object. For more information, see
+    // [Dialogflow access
+    // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     string flow_uri = 2;
 
     // Uncompressed raw byte content for flow.
@@ -595,6 +601,12 @@ message ExportFlowRequest {
   // export the flow to. The format of this URI must be
   // `gs://<bucket-name>/<object-name>`.
   // 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).
   string flow_uri = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Whether to export flows referenced by the specified flow.

protos/google/cloud/dialogflow/cx/v3/test_case.proto

@@ -270,12 +270,29 @@ message TestConfig {
   // Session parameters to be compared when calculating differences.
   repeated string tracking_parameters = 1;
 
-  // Flow name. If not set, default start flow is assumed.
+  // Flow name to start the test case with.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   // ID>/flows/<Flow ID>`.
+  //
+  // Only one of `flow` and `page` should be set to indicate the starting point
+  // of the test case. If both are set, `page` takes precedence over `flow`. If
+  // neither is set, the test case will start with start page on the default
+  // start flow.
   string flow = 2 [(google.api.resource_reference) = {
                      type: "dialogflow.googleapis.com/Flow"
                    }];
+
+  // The [page][google.cloud.dialogflow.cx.v3.Page] to start the test case with.
+  // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+  // ID>/flows/<Flow ID>/pages/<Page ID>`.
+  //
+  // Only one of `flow` and `page` should be set to indicate the starting point
+  // of the test case. If both are set, `page` takes precedence over `flow`. If
+  // neither is set, the test case will start with start page on the default
+  // start flow.
+  string page = 3 [(google.api.resource_reference) = {
+                     type: "dialogflow.googleapis.com/Page"
+                   }];
 }
 
 // One interaction between a human and virtual agent. The human provides some
@@ -744,6 +761,12 @@ message ImportTestCasesRequest {
     // The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
     // to import test cases from. The format of this URI must be
     // `gs://<bucket-name>/<object-name>`.
+    //
+    // Dialogflow performs a read operation for the Cloud Storage object
+    // on the caller's behalf, so your request authentication must
+    // have read permissions for the object. For more information, see
+    // [Dialogflow access
+    // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
     string gcs_uri = 2;
 
     // Uncompressed raw byte content for test cases.
@@ -806,6 +829,12 @@ message ExportTestCasesRequest {
     // export the test cases to. The format of this URI must be
     // `gs://<bucket-name>/<object-name>`. 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).
     string gcs_uri = 2;
   }
 

samples/generated/v3/agents.export_agent.js

@@ -35,6 +35,11 @@ function main(name) {
    *  export the agent to. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`.
    *  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).
    */
   // const agentUri = 'abc123'
   /**

samples/generated/v3/agents.restore_agent.js

@@ -34,6 +34,11 @@ function main(name) {
    *  The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
    *  to restore agent from. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`.
+   *  Dialogflow performs a read operation for the Cloud Storage object
+   *  on the caller's behalf, so your request authentication must
+   *  have read permissions for the object. For more information, see
+   *  Dialogflow access
+   *  control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    */
   // const agentUri = 'abc123'
   /**

samples/generated/v3/flows.export_flow.js

@@ -36,6 +36,11 @@ function main(name) {
    *  export the flow to. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`.
    *  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).
    */
   // const flowUri = 'abc123'
   /**

samples/generated/v3/flows.import_flow.js

@@ -34,6 +34,11 @@ function main(parent) {
    *  The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
    *  to import flow from. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`.
+   *  Dialogflow performs a read operation for the Cloud Storage object
+   *  on the caller's behalf, so your request authentication must
+   *  have read permissions for the object. For more information, see
+   *  Dialogflow access
+   *  control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    */
   // const flowUri = 'abc123'
   /**

samples/generated/v3/snippet_metadata.google.cloud.dialogflow.cx.v3.json

@@ -238,7 +238,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 65,
+          "end": 70,
           "type": "FULL"
         }
       ],
@@ -286,7 +286,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 66,
+          "end": 71,
           "type": "FULL"
         }
       ],
@@ -1898,7 +1898,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 66,
+          "end": 71,
           "type": "FULL"
         }
       ],
@@ -1950,7 +1950,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 64,
+          "end": 69,
           "type": "FULL"
         }
       ],
@@ -3466,7 +3466,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 62,
+          "end": 67,
           "type": "FULL"
         }
       ],
@@ -3514,7 +3514,7 @@
       "segments": [
         {
           "start": 25,
-          "end": 74,
+          "end": 79,
           "type": "FULL"
         }
       ],

samples/generated/v3/test_cases.export_test_cases.js

@@ -35,6 +35,11 @@ function main(parent) {
    *  export the test cases to. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`. 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).
    */
   // const gcsUri = 'abc123'
   /**

samples/generated/v3/test_cases.import_test_cases.js

@@ -34,6 +34,11 @@ function main(parent) {
    *  The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
    *  to import test cases from. The format of this URI must be
    *  `gs://<bucket-name>/<object-name>`.
+   *  Dialogflow performs a read operation for the Cloud Storage object
+   *  on the caller's behalf, so your request authentication must
+   *  have read permissions for the object. For more information, see
+   *  Dialogflow access
+   *  control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    */
   // const gcsUri = 'abc123'
   /**

src/v3/agents_client.ts

@@ -1030,6 +1030,12 @@ export class AgentsClient {
    *   export the agent to. The format of this URI must be
    *   `gs://<bucket-name>/<object-name>`.
    *   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).
    * @param {string} [request.environment]
    *   Optional. Environment name. If not set, draft environment is assumed.
    *   Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
@@ -1192,6 +1198,12 @@ export class AgentsClient {
    *   The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
    *   to restore agent from. The format of this URI must be
    *   `gs://<bucket-name>/<object-name>`.
+   *
+   *   Dialogflow performs a read operation for the Cloud Storage object
+   *   on the caller's behalf, so your request authentication must
+   *   have read permissions for the object. For more information, see
+   *   [Dialogflow access
+   *   control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
    * @param {Buffer} request.agentContent
    *   Uncompressed raw byte content for agent.
    * @param {google.cloud.dialogflow.cx.v3.RestoreAgentRequest.RestoreOption} request.restoreOption