patch method

Future<Operation> patch(
  1. Subscription request,
  2. String name, {
  3. String? updateMask,
  4. bool? validateOnly,
  5. String? $fields,
})

Updates or renews a Google Workspace subscription.

To learn how to use this method, see Update or renew a Google Workspace subscription. For a subscription on a Chat target resource, you can update a subscription as: - A Chat app by specifying an authorization scope that begins with chat.app andgetting one-time administrator approval (Developer Preview). To learn more, see Authorize as a Chat app with administrator approval.

  • A user by specifying an authorization scope that doesn't include app in its name. To learn more, see Authorize as a Chat user.

request - The metadata request object.

Request parameters:

name - Identifier. Resource name of the subscription. Format: subscriptions/{subscription} Value must have pattern ^subscriptions/\[^/\]+$.

updateMask - Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: * expire_time: The timestamp when the subscription expires. * ttl: The time-to-live (TTL) or duration of the subscription.

  • event_types: The list of event types to receive about the target resource. When using the * wildcard (equivalent to PUT), omitted fields are set to empty values and rejected if they're invalid.

validateOnly - Optional. If set to true, validates and previews the request, but doesn't update the subscription.

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

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

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