cancel method

Future<Empty> cancel(
  1. CancelDeviceSessionRequest request,
  2. String name, {
  3. String? $fields,
})

POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel Changes the DeviceSession to state FINISHED and terminates all connections.

Canceled sessions are not deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy.

request - The metadata request object.

Request parameters:

name - Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" Value must have pattern ^projects/\[^/\]+/deviceSessions/\[^/\]+$.

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

Completes with a Empty.

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

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

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