SecurityPolicyRule (Compute Engine API beta-rev20220726-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 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
  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.
`String`	`getDirection()` The direction in which this rule applies.
`Boolean`	`getEnableLogging()` Denotes whether to enable logging for a particular rule.
`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.
`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.
`Long`	`getRuleNumber()` Identifier for the rule.
`Integer`	`getRuleTupleCount()` [Output Only] Calculation of the complexity of a single firewall security policy rule.
`List<String>`	`getTargetResources()` A list of network resource URLs to which this rule applies.
`List<String>`	`getTargetServiceAccounts()` A list of service accounts indicating the sets of instances that are applied with this rule.
`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`	`setDirection(String direction)` The direction in which this rule applies.
`SecurityPolicyRule`	`setEnableLogging(Boolean enableLogging)` Denotes whether to enable logging for a particular rule.
`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`	`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.
`SecurityPolicyRule`	`setRuleNumber(Long ruleNumber)` Identifier for the rule.
`SecurityPolicyRule`	`setRuleTupleCount(Integer ruleTupleCount)` [Output Only] Calculation of the complexity of a single firewall security policy rule.
`SecurityPolicyRule`	`setTargetResources(List<String> targetResources)` A list of network resource URLs to which this rule applies.
`SecurityPolicyRule`	`setTargetServiceAccounts(List<String> targetServiceAccounts)` A list of service accounts indicating the sets of instances that are applied with this rule.

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(): 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:
    
    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(): 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.
    
    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
  - getDirection
```
public String getDirection()
```
    The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.
    
    Returns:
    
    value or null for none
  - setDirection
```
public SecurityPolicyRule setDirection(String direction)
```
    The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.
    
    Parameters:
    
    direction - direction or null for none
  - getEnableLogging
```
public Boolean getEnableLogging()
```
    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.
    
    Returns:
    
    value or null for none
  - setEnableLogging
```
public SecurityPolicyRule setEnableLogging(Boolean enableLogging)
```
    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.
    
    Parameters:
    
    enableLogging - enableLogging or null for none
  - getHeaderAction
```
public SecurityPolicyRuleHttpHeaderAction getHeaderAction()
```
    Optional, additional actions that are performed on headers.
    
    Returns:
    
    value or null for none
  - setHeaderAction
```
public SecurityPolicyRule setHeaderAction(SecurityPolicyRuleHttpHeaderAction headerAction)
```
    Optional, additional actions that are performed on headers.
    
    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
  - 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.
    
    Returns:
    
    value or null for none
  - setRedirectOptions
```
public SecurityPolicyRule setRedirectOptions(SecurityPolicyRuleRedirectOptions redirectOptions)
```
    Parameters defining the redirect action. Cannot be specified for any other actions.
    
    Parameters:
    
    redirectOptions - redirectOptions or null for none
  - getRuleNumber
```
public Long getRuleNumber()
```
    Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.
    
    Returns:
    
    value or null for none
  - setRuleNumber
```
public SecurityPolicyRule setRuleNumber(Long ruleNumber)
```
    Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.
    
    Parameters:
    
    ruleNumber - ruleNumber or null for none
  - getRuleTupleCount
```
public Integer getRuleTupleCount()
```
    [Output Only] Calculation of the complexity of a single firewall security policy rule.
    
    Returns:
    
    value or null for none
  - setRuleTupleCount
```
public SecurityPolicyRule setRuleTupleCount(Integer ruleTupleCount)
```
    [Output Only] Calculation of the complexity of a single firewall security policy rule.
    
    Parameters:
    
    ruleTupleCount - ruleTupleCount or null for none
  - getTargetResources
```
public List<String> getTargetResources()
```
    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.
    
    Returns:
    
    value or null for none
  - setTargetResources
```
public SecurityPolicyRule setTargetResources(List<String> targetResources)
```
    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.
    
    Parameters:
    
    targetResources - targetResources or null for none
  - getTargetServiceAccounts
```
public List<String> getTargetServiceAccounts()
```
    A list of service accounts indicating the sets of instances that are applied with this rule.
    
    Returns:
    
    value or null for none
  - setTargetServiceAccounts
```
public SecurityPolicyRule setTargetServiceAccounts(List<String> targetServiceAccounts)
```
    A list of service accounts indicating the sets of instances that are applied with this rule.
    
    Parameters:
    
    targetServiceAccounts - targetServiceAccounts or null for none
  - set
```
public SecurityPolicyRule set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public SecurityPolicyRule clone()
```
    Overrides:
    
    clone in class 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

getDirection

setDirection

getEnableLogging

setEnableLogging

getHeaderAction

setHeaderAction

getKind

setKind

getMatch

setMatch

getPreview

setPreview

getPriority

setPriority

getRateLimitOptions

setRateLimitOptions

getRedirectOptions

setRedirectOptions

getRuleNumber

setRuleNumber

getRuleTupleCount

setRuleTupleCount

getTargetResources

setTargetResources

getTargetServiceAccounts

setTargetServiceAccounts

set

clone