patch method

Future<ConsumerGroup> patch(
  1. ConsumerGroup request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Updates the properties of a single consumer group.

request - The metadata request object.

Request parameters:

name - Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/clusters/\[^/\]+/consumerGroups/.*$.

updateMask - Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

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

Completes with a ConsumerGroup.

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

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

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