patch method

Future<ChromeOsDevice> patch(
  1. ChromeOsDevice request,
  2. String customerId,
  3. String deviceId, {
  4. String? projection,
  5. String? $fields,
})

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.

This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

request - The metadata request object.

Request parameters:

customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).

deviceId - The unique ID of the device. The deviceIds are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method.

projection - Determines whether the response contains the full list of properties or only a subset. Possible string values are:

  • "BASIC" : Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
  • "FULL" : Includes all metadata fields

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

Completes with a ChromeOsDevice.

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

  final url_ = 'admin/directory/v1/customer/' +
      commons.escapeVariable('$customerId') +
      '/devices/chromeos/' +
      commons.escapeVariable('$deviceId');

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