list method

Future<GoogleCloudDialogflowCxV3ListTestCasesResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? view,
  5. String? $fields,
})

Fetches a list of test cases for a given agent.

Request parameters:

parent - Required. The agent to list all pages for. Format: projects//locations//agents/. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/agents/\[^/\]+$.

pageSize - The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.

pageToken - The next_page_token value returned from a previous list request.

view - Specifies whether response should include all fields or just the metadata. Possible string values are:

  • "TEST_CASE_VIEW_UNSPECIFIED" : The default / unset value. The API will default to the BASIC view.
  • "BASIC" : Include basic metadata about the test case, but not the conversation turns. This is the default value.
  • "FULL" : Include everything.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudDialogflowCxV3ListTestCasesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudDialogflowCxV3ListTestCasesResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/' + core.Uri.encodeFull('$parent') + '/testCases';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudDialogflowCxV3ListTestCasesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}