Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
| Parameters | |
|---|---|
project |
Required. Project ID for this request.
|
securityPolicy |
Required. Name of the security policy to update.
|
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.
|
body |
Required.
|
Raised exceptions
| Exceptions | |
|---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of Operation.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- patchRule: call: googleapis.compute.beta.securityPolicies.patchRule args: project: ... securityPolicy: ... priority: ... updateMask: ... validateOnly: ... body: action: ... description: ... direction: ... enableLogging: ... headerAction: requestHeadersToAdds: ... match: config: destIpRanges: ... layer4Configs: ... srcIpRanges: ... expr: description: ... expression: ... location: ... title: ... exprOptions: recaptchaOptions: actionTokenSiteKeys: ... sessionTokenSiteKeys: ... versionedExpr: ... networkMatch: destIpRanges: ... destPorts: ... ipProtocols: ... srcAsns: ... srcIpRanges: ... srcPorts: ... srcRegionCodes: ... userDefinedFields: ... preconfiguredWafConfig: exclusions: ... preview: ... priority: ... rateLimitOptions: banDurationSec: ... banThreshold: count: ... intervalSec: ... conformAction: ... enforceOnKey: ... enforceOnKeyConfigs: ... enforceOnKeyName: ... exceedAction: ... exceedRedirectOptions: target: ... type: ... rateLimitThreshold: ... redirectOptions: ... ruleNumber: ... targetResources: ... targetServiceAccounts: ... result: patchRuleResult
JSON
[ { "patchRule": { "call": "googleapis.compute.beta.securityPolicies.patchRule", "args": { "project": "...", "securityPolicy": "...", "priority": "...", "updateMask": "...", "validateOnly": "...", "body": { "action": "...", "description": "...", "direction": "...", "enableLogging": "...", "headerAction": { "requestHeadersToAdds": "..." }, "match": { "config": { "destIpRanges": "...", "layer4Configs": "...", "srcIpRanges": "..." }, "expr": { "description": "...", "expression": "...", "location": "...", "title": "..." }, "exprOptions": { "recaptchaOptions": { "actionTokenSiteKeys": "...", "sessionTokenSiteKeys": "..." } }, "versionedExpr": "..." }, "networkMatch": { "destIpRanges": "...", "destPorts": "...", "ipProtocols": "...", "srcAsns": "...", "srcIpRanges": "...", "srcPorts": "...", "srcRegionCodes": "...", "userDefinedFields": "..." }, "preconfiguredWafConfig": { "exclusions": "..." }, "preview": "...", "priority": "...", "rateLimitOptions": { "banDurationSec": "...", "banThreshold": { "count": "...", "intervalSec": "..." }, "conformAction": "...", "enforceOnKey": "...", "enforceOnKeyConfigs": "...", "enforceOnKeyName": "...", "exceedAction": "...", "exceedRedirectOptions": { "target": "...", "type": "..." }, "rateLimitThreshold": "..." }, "redirectOptions": "...", "ruleNumber": "...", "targetResources": "...", "targetServiceAccounts": "..." } }, "result": "patchRuleResult" } } ]