patch method

Future<Operation> patch(
  1. Subnetwork request,
  2. String project,
  3. String region,
  4. String subnetwork, {
  5. int? drainTimeoutSeconds,
  6. String? requestId,
  7. String? $fields,
})

Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.

request - The metadata request object.

Request parameters:

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

region - Name of the region scoping this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

subnetwork - Name of the Subnetwork resource to patch. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

drainTimeoutSeconds - The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true:

  • the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER
  • the subnetwork being patched has role = BACKUP
  • the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

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.

Implementation

async.Future<Operation> patch(
  Subnetwork request,
  core.String project,
  core.String region,
  core.String subnetwork, {
  core.int? drainTimeoutSeconds,
  core.String? requestId,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'drainTimeoutSeconds': ?drainTimeoutSeconds == null
        ? null
        : ['${drainTimeoutSeconds}'],
    'requestId': ?requestId == null ? null : [requestId],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'projects/' +
      commons.escapeVariable('$project') +
      '/regions/' +
      commons.escapeVariable('$region') +
      '/subnetworks/' +
      commons.escapeVariable('$subnetwork');

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