patch method

Future<Property> patch(
  1. Property request,
  2. String fileId,
  3. String propertyKey, {
  4. String? visibility,
  5. String? $fields,
})

Updates a property.

request - The metadata request object.

Request parameters:

fileId - The ID of the file.

propertyKey - The key of the property.

visibility - The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

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

Completes with a Property.

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<Property> patch(
  Property request,
  core.String fileId,
  core.String propertyKey, {
  core.String? visibility,
  core.String? $fields,
}) async {
  final body_ = convert_1.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (visibility != null) 'visibility': [visibility],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'files/' +
      commons.escapeVariable('$fileId') +
      '/properties/' +
      commons.escapeVariable('$propertyKey');

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