list method

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

Returns the list of all conversations in the specified project.

Request parameters:

parent - Required. The project from which to list all conversation. Format: projects//locations/. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either =,!=, >, or <. - To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).

  • For clarity, expressions can be enclosed in parentheses. Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.

pageSize - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

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

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

Completes with a GoogleCloudDialogflowV2ListConversationsResponse.

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<GoogleCloudDialogflowV2ListConversationsResponse> 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_ = 'v2/' + core.Uri.encodeFull('$parent') + '/conversations';

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