Reference documentation and code samples for the Compute V1 Client class SecurityPolicyRule.
Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Generated from protobuf message google.cloud.compute.v1.SecurityPolicyRule
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ action | stringThe Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. |
↳ description | stringAn optional description of this resource. Provide this property when you create the resource. |
↳ header_action | Google\Cloud\Compute\V1\SecurityPolicyRuleHttpHeaderActionOptional, additional actions that are performed on headers. |
↳ kind | string[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules |
↳ match | Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherA match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
↳ preview | boolIf set to true, the specified action is not enforced. |
↳ priority | intAn integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. |
↳ rate_limit_options | Google\Cloud\Compute\V1\SecurityPolicyRuleRateLimitOptionsMust be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. |
↳ redirect_options | Google\Cloud\Compute\V1\SecurityPolicyRuleRedirectOptionsParameters defining the redirect action. Cannot be specified for any other actions. |
getAction
The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
| Returns | |
|---|---|
| Type | Description |
string | |
hasAction
clearAction
setAction
The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getHeaderAction
Optional, additional actions that are performed on headers.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SecurityPolicyRuleHttpHeaderAction|null | |
hasHeaderAction
clearHeaderAction
setHeaderAction
Optional, additional actions that are performed on headers.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Compute\V1\SecurityPolicyRuleHttpHeaderAction |
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getMatch
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SecurityPolicyRuleMatcher|null | |
hasMatch
clearMatch
setMatch
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Compute\V1\SecurityPolicyRuleMatcher |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPreview
If set to true, the specified action is not enforced.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasPreview
clearPreview
setPreview
If set to true, the specified action is not enforced.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPriority
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
| Returns | |
|---|---|
| Type | Description |
int | |
hasPriority
clearPriority
setPriority
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getRateLimitOptions
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SecurityPolicyRuleRateLimitOptions|null | |
hasRateLimitOptions
clearRateLimitOptions
setRateLimitOptions
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Compute\V1\SecurityPolicyRuleRateLimitOptions |
| Returns | |
|---|---|
| Type | Description |
$this | |
getRedirectOptions
Parameters defining the redirect action. Cannot be specified for any other actions.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SecurityPolicyRuleRedirectOptions|null | |
hasRedirectOptions
clearRedirectOptions
setRedirectOptions
Parameters defining the redirect action. Cannot be specified for any other actions.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Compute\V1\SecurityPolicyRuleRedirectOptions |
| Returns | |
|---|---|
| Type | Description |
$this | |