SecurityPolicyRule (Compute Engine API v1-rev20240430-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.SecurityPolicyRule

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class SecurityPolicyRule
extends com.google.api.client.json.GenericJson
```
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).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

SecurityPolicyRule()

Constructors
Constructor and Description
`SecurityPolicyRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityPolicyRule`	`clone()`
`String`	`getAction()` The Action to perform when the rule is matched.
`String`	`getDescription()` An optional description of this resource.
`SecurityPolicyRuleHttpHeaderAction`	`getHeaderAction()` Optional, additional actions that are performed on headers.
`String`	`getKind()` [Output only] Type of the resource.
`SecurityPolicyRuleMatcher`	`getMatch()` A match condition that incoming traffic is evaluated against.
`SecurityPolicyRuleNetworkMatcher`	`getNetworkMatch()` A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies.
`SecurityPolicyRulePreconfiguredWafConfig`	`getPreconfiguredWafConfig()` Preconfigured WAF configuration to be applied for the rule.
`Boolean`	`getPreview()` If set to true, the specified action is not enforced.
`Integer`	`getPriority()` An integer indicating the priority of a rule in the list.
`SecurityPolicyRuleRateLimitOptions`	`getRateLimitOptions()` Must be specified if the action is "rate_based_ban" or "throttle".
`SecurityPolicyRuleRedirectOptions`	`getRedirectOptions()` Parameters defining the redirect action.
`SecurityPolicyRule`	`set(String fieldName, Object value)`
`SecurityPolicyRule`	`setAction(String action)` The Action to perform when the rule is matched.
`SecurityPolicyRule`	`setDescription(String description)` An optional description of this resource.
`SecurityPolicyRule`	`setHeaderAction(SecurityPolicyRuleHttpHeaderAction headerAction)` Optional, additional actions that are performed on headers.
`SecurityPolicyRule`	`setKind(String kind)` [Output only] Type of the resource.
`SecurityPolicyRule`	`setMatch(SecurityPolicyRuleMatcher match)` A match condition that incoming traffic is evaluated against.
`SecurityPolicyRule`	`setNetworkMatch(SecurityPolicyRuleNetworkMatcher networkMatch)` A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies.
`SecurityPolicyRule`	`setPreconfiguredWafConfig(SecurityPolicyRulePreconfiguredWafConfig preconfiguredWafConfig)` Preconfigured WAF configuration to be applied for the rule.
`SecurityPolicyRule`	`setPreview(Boolean preview)` If set to true, the specified action is not enforced.
`SecurityPolicyRule`	`setPriority(Integer priority)` An integer indicating the priority of a rule in the list.
`SecurityPolicyRule`	`setRateLimitOptions(SecurityPolicyRuleRateLimitOptions rateLimitOptions)` Must be specified if the action is "rate_based_ban" or "throttle".
`SecurityPolicyRule`	`setRedirectOptions(SecurityPolicyRuleRedirectOptions redirectOptions)` Parameters defining the redirect action.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - SecurityPolicyRule
```
public SecurityPolicyRule()
```
- Method Detail
  - getAction
```
public String getAction()
```
    The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` 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. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - 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:
    
    value or null for none
  - setAction
```
public SecurityPolicyRule setAction(String action)
```
    The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` 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. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
    
    Parameters:
    
    action - action or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public SecurityPolicyRule setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getHeaderAction
```
public SecurityPolicyRuleHttpHeaderAction getHeaderAction()
```
    Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    
    Returns:
    
    value or null for none
  - setHeaderAction
```
public SecurityPolicyRule setHeaderAction(SecurityPolicyRuleHttpHeaderAction headerAction)
```
    Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    
    Parameters:
    
    headerAction - headerAction or null for none
  - getKind
```
public String getKind()
```
    [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
    
    Returns:
    
    value or null for none
  - setKind
```
public SecurityPolicyRule setKind(String kind)
```
    [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
    
    Parameters:
    
    kind - kind or null for none
  - getMatch
```
public SecurityPolicyRuleMatcher getMatch()
```
    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
    
    Returns:
    
    value or null for none
  - setMatch
```
public SecurityPolicyRule setMatch(SecurityPolicyRuleMatcher match)
```
    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
    
    Parameters:
    
    match - match or null for none
  - getNetworkMatch
```
public SecurityPolicyRuleNetworkMatcher getNetworkMatch()
```
    A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
    
    Returns:
    
    value or null for none
  - setNetworkMatch
```
public SecurityPolicyRule setNetworkMatch(SecurityPolicyRuleNetworkMatcher networkMatch)
```
    A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
    
    Parameters:
    
    networkMatch - networkMatch or null for none
  - getPreconfiguredWafConfig
```
public SecurityPolicyRulePreconfiguredWafConfig getPreconfiguredWafConfig()
```
    Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
    
    Returns:
    
    value or null for none
  - setPreconfiguredWafConfig
```
public SecurityPolicyRule setPreconfiguredWafConfig(SecurityPolicyRulePreconfiguredWafConfig preconfiguredWafConfig)
```
    Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
    
    Parameters:
    
    preconfiguredWafConfig - preconfiguredWafConfig or null for none
  - getPreview
```
public Boolean getPreview()
```
    If set to true, the specified action is not enforced.
    
    Returns:
    
    value or null for none
  - setPreview
```
public SecurityPolicyRule setPreview(Boolean preview)
```
    If set to true, the specified action is not enforced.
    
    Parameters:
    
    preview - preview or null for none
  - getPriority
```
public Integer 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:
    
    value or null for none
  - setPriority
```
public SecurityPolicyRule setPriority(Integer priority)
```
    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.
    
    Parameters:
    
    priority - priority or null for none
  - getRateLimitOptions
```
public SecurityPolicyRuleRateLimitOptions getRateLimitOptions()
```
    Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
    
    Returns:
    
    value or null for none
  - setRateLimitOptions
```
public SecurityPolicyRule setRateLimitOptions(SecurityPolicyRuleRateLimitOptions rateLimitOptions)
```
    Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
    
    Parameters:
    
    rateLimitOptions - rateLimitOptions or null for none
  - getRedirectOptions
```
public SecurityPolicyRuleRedirectOptions getRedirectOptions()
```
    Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    
    Returns:
    
    value or null for none
  - setRedirectOptions
```
public SecurityPolicyRule setRedirectOptions(SecurityPolicyRuleRedirectOptions redirectOptions)
```
    Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    
    Parameters:
    
    redirectOptions - redirectOptions or null for none
  - set
```
public SecurityPolicyRule set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SecurityPolicyRule clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class SecurityPolicyRule

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

SecurityPolicyRule

Method Detail

getAction

setAction

getDescription

setDescription

getHeaderAction

setHeaderAction

getKind

setKind

getMatch

setMatch

getNetworkMatch

setNetworkMatch

getPreconfiguredWafConfig

setPreconfiguredWafConfig

getPreview

setPreview

getPriority

setPriority

getRateLimitOptions

setRateLimitOptions

getRedirectOptions

setRedirectOptions

set

clone