issueCommand method

Future<Operation> issueCommand(Command request, String name, { String? $fields, })

Issues a command to a device.

The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.

request - The metadata request object.

Request parameters:

name - The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. Value must have pattern ^enterprises/\[^/\]+/devices/\[^/\]+$.

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

Completes with a Operation.

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<Operation> issueCommand(
  Command 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') + ':issueCommand';

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