Skip to content
This repository was archived by the owner on Jul 20, 2023. It is now read-only.

Commit 283c389

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
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: https://github.com/googleapis/googleapis-gen/commit/1928631f3ee91488fe07b3d8188a52d10862453a Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkyODYzMWYzZWU5MTQ4OGZlMDdiM2Q4MTg4YTUyZDEwODYyNDUzYSJ9
1 parent 6807d30 commit 283c389

16 files changed

+163
-8
lines changed

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

+12
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,12 @@ message ExportAgentRequest {
348348
// export the agent to. The format of this URI must be
349349
// `gs://<bucket-name>/<object-name>`.
350350
// If left unspecified, the serialized agent is returned inline.
351+
//
352+
// Dialogflow performs a write operation for the Cloud Storage object
353+
// on the caller's behalf, so your request authentication must
354+
// have write permissions for the object. For more information, see
355+
// [Dialogflow access
356+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
351357
string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];
352358

353359
// Optional. Environment name. If not set, draft environment is assumed.
@@ -405,6 +411,12 @@ message RestoreAgentRequest {
405411
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
406412
// to restore agent from. The format of this URI must be
407413
// `gs://<bucket-name>/<object-name>`.
414+
//
415+
// Dialogflow performs a read operation for the Cloud Storage object
416+
// on the caller's behalf, so your request authentication must
417+
// have read permissions for the object. For more information, see
418+
// [Dialogflow access
419+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
408420
string agent_uri = 2;
409421

410422
// Uncompressed raw byte content for agent.

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

+12
Original file line numberDiff line numberDiff line change
@@ -559,6 +559,12 @@ message ImportFlowRequest {
559559
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
560560
// to import flow from. The format of this URI must be
561561
// `gs://<bucket-name>/<object-name>`.
562+
//
563+
// Dialogflow performs a read operation for the Cloud Storage object
564+
// on the caller's behalf, so your request authentication must
565+
// have read permissions for the object. For more information, see
566+
// [Dialogflow access
567+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
562568
string flow_uri = 2;
563569

564570
// Uncompressed raw byte content for flow.
@@ -595,6 +601,12 @@ message ExportFlowRequest {
595601
// export the flow to. The format of this URI must be
596602
// `gs://<bucket-name>/<object-name>`.
597603
// If left unspecified, the serialized flow is returned inline.
604+
//
605+
// Dialogflow performs a write operation for the Cloud Storage object
606+
// on the caller's behalf, so your request authentication must
607+
// have write permissions for the object. For more information, see
608+
// [Dialogflow access
609+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
598610
string flow_uri = 2 [(google.api.field_behavior) = OPTIONAL];
599611

600612
// Optional. Whether to export flows referenced by the specified flow.

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

+30-1
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,29 @@ message TestConfig {
270270
// Session parameters to be compared when calculating differences.
271271
repeated string tracking_parameters = 1;
272272

273-
// Flow name. If not set, default start flow is assumed.
273+
// Flow name to start the test case with.
274274
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
275275
// ID>/flows/<Flow ID>`.
276+
//
277+
// Only one of `flow` and `page` should be set to indicate the starting point
278+
// of the test case. If both are set, `page` takes precedence over `flow`. If
279+
// neither is set, the test case will start with start page on the default
280+
// start flow.
276281
string flow = 2 [(google.api.resource_reference) = {
277282
type: "dialogflow.googleapis.com/Flow"
278283
}];
284+
285+
// The [page][google.cloud.dialogflow.cx.v3.Page] to start the test case with.
286+
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
287+
// ID>/flows/<Flow ID>/pages/<Page ID>`.
288+
//
289+
// Only one of `flow` and `page` should be set to indicate the starting point
290+
// of the test case. If both are set, `page` takes precedence over `flow`. If
291+
// neither is set, the test case will start with start page on the default
292+
// start flow.
293+
string page = 3 [(google.api.resource_reference) = {
294+
type: "dialogflow.googleapis.com/Page"
295+
}];
279296
}
280297

281298
// One interaction between a human and virtual agent. The human provides some
@@ -744,6 +761,12 @@ message ImportTestCasesRequest {
744761
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
745762
// to import test cases from. The format of this URI must be
746763
// `gs://<bucket-name>/<object-name>`.
764+
//
765+
// Dialogflow performs a read operation for the Cloud Storage object
766+
// on the caller's behalf, so your request authentication must
767+
// have read permissions for the object. For more information, see
768+
// [Dialogflow access
769+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
747770
string gcs_uri = 2;
748771

749772
// Uncompressed raw byte content for test cases.
@@ -806,6 +829,12 @@ message ExportTestCasesRequest {
806829
// export the test cases to. The format of this URI must be
807830
// `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
808831
// cases is returned inline.
832+
//
833+
// Dialogflow performs a write operation for the Cloud Storage object
834+
// on the caller's behalf, so your request authentication must
835+
// have write permissions for the object. For more information, see
836+
// [Dialogflow access
837+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
809838
string gcs_uri = 2;
810839
}
811840

‎protos/protos.d.ts

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎protos/protos.js

+24-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎protos/protos.json

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎samples/generated/v3/agents.export_agent.js

+5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ function main(name) {
3535
* export the agent to. The format of this URI must be
3636
* `gs://<bucket-name>/<object-name>`.
3737
* If left unspecified, the serialized agent is returned inline.
38+
* Dialogflow performs a write operation for the Cloud Storage object
39+
* on the caller's behalf, so your request authentication must
40+
* have write permissions for the object. For more information, see
41+
* Dialogflow access
42+
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
3843
*/
3944
// const agentUri = 'abc123'
4045
/**

‎samples/generated/v3/agents.restore_agent.js

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

‎samples/generated/v3/flows.export_flow.js

+5
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ function main(name) {
3636
* export the flow to. The format of this URI must be
3737
* `gs://<bucket-name>/<object-name>`.
3838
* If left unspecified, the serialized flow is returned inline.
39+
* Dialogflow performs a write operation for the Cloud Storage object
40+
* on the caller's behalf, so your request authentication must
41+
* have write permissions for the object. For more information, see
42+
* Dialogflow access
43+
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
3944
*/
4045
// const flowUri = 'abc123'
4146
/**

‎samples/generated/v3/flows.import_flow.js

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

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@
238238
"segments": [
239239
{
240240
"start": 25,
241-
"end": 65,
241+
"end": 70,
242242
"type": "FULL"
243243
}
244244
],
@@ -286,7 +286,7 @@
286286
"segments": [
287287
{
288288
"start": 25,
289-
"end": 66,
289+
"end": 71,
290290
"type": "FULL"
291291
}
292292
],
@@ -1898,7 +1898,7 @@
18981898
"segments": [
18991899
{
19001900
"start": 25,
1901-
"end": 66,
1901+
"end": 71,
19021902
"type": "FULL"
19031903
}
19041904
],
@@ -1950,7 +1950,7 @@
19501950
"segments": [
19511951
{
19521952
"start": 25,
1953-
"end": 64,
1953+
"end": 69,
19541954
"type": "FULL"
19551955
}
19561956
],
@@ -3466,7 +3466,7 @@
34663466
"segments": [
34673467
{
34683468
"start": 25,
3469-
"end": 62,
3469+
"end": 67,
34703470
"type": "FULL"
34713471
}
34723472
],
@@ -3514,7 +3514,7 @@
35143514
"segments": [
35153515
{
35163516
"start": 25,
3517-
"end": 74,
3517+
"end": 79,
35183518
"type": "FULL"
35193519
}
35203520
],

‎samples/generated/v3/test_cases.export_test_cases.js

+5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ function main(parent) {
3535
* export the test cases to. The format of this URI must be
3636
* `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
3737
* cases is returned inline.
38+
* Dialogflow performs a write operation for the Cloud Storage object
39+
* on the caller's behalf, so your request authentication must
40+
* have write permissions for the object. For more information, see
41+
* Dialogflow access
42+
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
3843
*/
3944
// const gcsUri = 'abc123'
4045
/**

‎samples/generated/v3/test_cases.import_test_cases.js

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

‎src/v3/agents_client.ts

+12
Original file line numberDiff line numberDiff line change
@@ -1030,6 +1030,12 @@ export class AgentsClient {
10301030
* export the agent to. The format of this URI must be
10311031
* `gs://<bucket-name>/<object-name>`.
10321032
* If left unspecified, the serialized agent is returned inline.
1033+
*
1034+
* Dialogflow performs a write operation for the Cloud Storage object
1035+
* on the caller's behalf, so your request authentication must
1036+
* have write permissions for the object. For more information, see
1037+
* [Dialogflow access
1038+
* control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
10331039
* @param {string} [request.environment]
10341040
* Optional. Environment name. If not set, draft environment is assumed.
10351041
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
@@ -1192,6 +1198,12 @@ export class AgentsClient {
11921198
* The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
11931199
* to restore agent from. The format of this URI must be
11941200
* `gs://<bucket-name>/<object-name>`.
1201+
*
1202+
* Dialogflow performs a read operation for the Cloud Storage object
1203+
* on the caller's behalf, so your request authentication must
1204+
* have read permissions for the object. For more information, see
1205+
* [Dialogflow access
1206+
* control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
11951207
* @param {Buffer} request.agentContent
11961208
* Uncompressed raw byte content for agent.
11971209
* @param {google.cloud.dialogflow.cx.v3.RestoreAgentRequest.RestoreOption} request.restoreOption

0 commit comments

Comments
 (0)