patch method

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

Use this method to update the configuration of a stream.

request - The metadata request object.

Request parameters:

name - Output only. The stream's name. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/streams/\[^/\]+$.

force - Optional. Execute the update without validating it.

requestId - Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMask - Optional. Field mask is used to specify the fields to be overwritten in the stream 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. If the user does not provide a mask then all fields will be overwritten.

validateOnly - Optional. Only validate the stream with the changes, without actually updating it. The default is false.

$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(
  Stream request,
  core.String name, {
  core.bool? force,
  core.String? requestId,
  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 (force != null) 'force': ['${force}'],
    if (requestId != null) 'requestId': [requestId],
    if (updateMask != null) 'updateMask': [updateMask],
    if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1alpha1/' + 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>);
}