patch method

Future<Operation> patch (
  1. ForwardingRule request,
  2. String project,
  3. String forwardingRule,
  4. {String requestId,
  5. String $fields}

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

request - The metadata request object.

Request parameters:

project - Project ID for this request. Value must have pattern "(?:(?:-a-z0-9{1,63}.)*(?:a-z?):)?(?:0-9{1,19}|(?:a-z0-9?))".

forwardingRule - Name of the ForwardingRule resource to patch. Value must have pattern "a-z?|0-9{0,19}".

requestId - An optional 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.

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).

$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.


async.Future<Operation> patch(
    ForwardingRule request, core.String project, core.String forwardingRule,
    {core.String requestId, core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (request != null) {
    _body = convert.json.encode((request).toJson());
  if (project == null) {
    throw new core.ArgumentError("Parameter project is required.");
  if (forwardingRule == null) {
    throw new core.ArgumentError("Parameter forwardingRule is required.");
  if (requestId != null) {
    _queryParams["requestId"] = [requestId];
  if ($fields != null) {
    _queryParams["fields"] = [$fields];

  _url = commons.Escaper.ecapeVariable('$project') +
      '/global/forwardingRules/' +

  var _response = _requester.request(_url, "PATCH",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response.then((data) => new Operation.fromJson(data));