cancelAssistantTurn method

Future<CancelAssistantTurnResponse> cancelAssistantTurn(
  1. CancelAssistantTurnRequest request,
  2. String name, {
  3. String? $fields,
})

Cancels the assistant session's in-flight turn, if any: the explicit user stop for a turn running detached from any stream.

A cancel landing on a task that does not host the turn preempts it through the session turn epoch instead, ending it within one lease renewal.

request - The metadata request object.

Request parameters:

name - Required. The assistant session whose in-flight turn to cancel. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/apps/\[^/\]+/assistantSessions/\[^/\]+$.

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

Completes with a CancelAssistantTurnResponse.

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<CancelAssistantTurnResponse> cancelAssistantTurn(
  CancelAssistantTurnRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':cancelAssistantTurn';

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