patchRule method

Future<Operation> patchRule(SecurityPolicyRule request, String project, String region, String securityPolicy, { int? priority, String? updateMask, bool? validateOnly, String? $fields, })

Patches a rule at the specified priority.

To clear fields in the rule, leave the fields empty and specify them in the updateMask.

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\])?.

securityPolicy - Name of the security policy to update. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

priority - The priority of the rule to patch.

updateMask - Indicates fields to be cleared as part of this request.

validateOnly - If true, the request will not be committed.

$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> patchRule(
  SecurityPolicyRule request,
  core.String project,
  core.String region,
  core.String securityPolicy, {
  core.int? priority,
  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 (priority != null) 'priority': ['${priority}'],
    if (updateMask != null) 'updateMask': [updateMask],
    if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/regions/' +
      commons.escapeVariable('$region') +
      '/securityPolicies/' +
      commons.escapeVariable('$securityPolicy') +
      '/patchRule';

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