- 1.52.0 (latest)
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface SecurityPolicyRuleOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAction()
public abstract String 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.
optional string action = 187661878;
| Type | Description |
String | The action. |
getActionBytes()
public abstract ByteString getActionBytes()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.
optional string action = 187661878;
| Type | Description |
ByteString | The bytes for action. |
getDescription()
public abstract String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
ByteString | The bytes for description. |
getHeaderAction()
public abstract SecurityPolicyRuleHttpHeaderAction getHeaderAction()Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
| Type | Description |
SecurityPolicyRuleHttpHeaderAction | The headerAction. |
getHeaderActionOrBuilder()
public abstract SecurityPolicyRuleHttpHeaderActionOrBuilder getHeaderActionOrBuilder()Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
| Type | Description |
SecurityPolicyRuleHttpHeaderActionOrBuilder |
getKind()
public abstract String getKind()[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
| Type | Description |
String | The kind. |
getKindBytes()
public abstract ByteString getKindBytes()[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
| Type | Description |
ByteString | The bytes for kind. |
getMatch()
public abstract SecurityPolicyRuleMatcher getMatch()A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;
| Type | Description |
SecurityPolicyRuleMatcher | The match. |
getMatchOrBuilder()
public abstract SecurityPolicyRuleMatcherOrBuilder getMatchOrBuilder()A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;
| Type | Description |
SecurityPolicyRuleMatcherOrBuilder |
getPreview()
public abstract boolean getPreview()If set to true, the specified action is not enforced.
optional bool preview = 218686408;
| Type | Description |
boolean | The preview. |
getPriority()
public abstract int 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.
optional int32 priority = 445151652;
| Type | Description |
int | The priority. |
getRateLimitOptions()
public abstract SecurityPolicyRuleRateLimitOptions getRateLimitOptions()Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
| Type | Description |
SecurityPolicyRuleRateLimitOptions | The rateLimitOptions. |
getRateLimitOptionsOrBuilder()
public abstract SecurityPolicyRuleRateLimitOptionsOrBuilder getRateLimitOptionsOrBuilder()Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
| Type | Description |
SecurityPolicyRuleRateLimitOptionsOrBuilder |
getRedirectOptions()
public abstract SecurityPolicyRuleRedirectOptions getRedirectOptions()Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
| Type | Description |
SecurityPolicyRuleRedirectOptions | The redirectOptions. |
getRedirectOptionsOrBuilder()
public abstract SecurityPolicyRuleRedirectOptionsOrBuilder getRedirectOptionsOrBuilder()Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
| Type | Description |
SecurityPolicyRuleRedirectOptionsOrBuilder |
hasAction()
public abstract boolean hasAction()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.
optional string action = 187661878;
| Type | Description |
boolean | Whether the action field is set. |
hasDescription()
public abstract boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
boolean | Whether the description field is set. |
hasHeaderAction()
public abstract boolean hasHeaderAction()Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
| Type | Description |
boolean | Whether the headerAction field is set. |
hasKind()
public abstract boolean hasKind()[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
| Type | Description |
boolean | Whether the kind field is set. |
hasMatch()
public abstract boolean hasMatch()A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;
| Type | Description |
boolean | Whether the match field is set. |
hasPreview()
public abstract boolean hasPreview()If set to true, the specified action is not enforced.
optional bool preview = 218686408;
| Type | Description |
boolean | Whether the preview field is set. |
hasPriority()
public abstract boolean hasPriority()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.
optional int32 priority = 445151652;
| Type | Description |
boolean | Whether the priority field is set. |
hasRateLimitOptions()
public abstract boolean hasRateLimitOptions()Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
| Type | Description |
boolean | Whether the rateLimitOptions field is set. |
hasRedirectOptions()
public abstract boolean hasRedirectOptions()Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
| Type | Description |
boolean | Whether the redirectOptions field is set. |