list method

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

Lists analyses.

Request parameters:

parent - Required. The parent resource of the analyses. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+/conversations/\[^/\]+$.

filter - A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

pageSize - The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

pageToken - The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior ListAnalyses call and the system should return the next page of data.

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

Completes with a GoogleCloudContactcenterinsightsV1ListAnalysesResponse.

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<GoogleCloudContactcenterinsightsV1ListAnalysesResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/analyses';

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