com.google.api.services.compute.model

Class FirewallPolicyRule

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.FirewallPolicyRule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FirewallPolicyRule
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
FirewallPolicyRule()

Method Summary

Modifier and Type	Method and Description
FirewallPolicyRule	clone()
String	getAction() The Action to perform when the client connection triggers the rule.
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.
String	getKind() [Output only] Type of the resource.
FirewallPolicyRuleMatcher	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.
Integer	getRuleTupleCount() [Output Only] Calculation of the complexity of a single firewall policy rule.
List<String>	getTargetResources() A list of network resource URLs to which this rule applies.
List<String>	getTargetSecureLabels() A list of secure labels that controls which instances the firewall rule applies to.
List<String>	getTargetServiceAccounts() A list of service accounts indicating the sets of instances that are applied with this rule.
FirewallPolicyRule	set(String fieldName, Object value)
FirewallPolicyRule	setAction(String action) The Action to perform when the client connection triggers the rule.
FirewallPolicyRule	setDescription(String description) An optional description of this resource.
FirewallPolicyRule	setDirection(String direction) The direction in which this rule applies.
FirewallPolicyRule	setEnableLogging(Boolean enableLogging) Denotes whether to enable logging for a particular rule.
FirewallPolicyRule	setKind(String kind) [Output only] Type of the resource.
FirewallPolicyRule	setMatch(FirewallPolicyRuleMatcher match) A match condition that incoming traffic is evaluated against.
FirewallPolicyRule	setPreview(Boolean preview) If set to true, the specified action is not enforced.
FirewallPolicyRule	setPriority(Integer priority) An integer indicating the priority of a rule in the list.
FirewallPolicyRule	setRuleTupleCount(Integer ruleTupleCount) [Output Only] Calculation of the complexity of a single firewall policy rule.
FirewallPolicyRule	setTargetResources(List<String> targetResources) A list of network resource URLs to which this rule applies.
FirewallPolicyRule	setTargetSecureLabels(List<String> targetSecureLabels) A list of secure labels that controls which instances the firewall rule applies to.
FirewallPolicyRule	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

FirewallPolicyRule

public FirewallPolicyRule()

Method Detail

getAction

public String getAction()

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

Returns:

value or null for none

setAction

public FirewallPolicyRule setAction(String action)

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

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 FirewallPolicyRule 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.

Returns:

value or null for none

setDirection

public FirewallPolicyRule setDirection(String direction)

The direction in which this rule applies.

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.

Returns:

value or null for none

setEnableLogging

public FirewallPolicyRule 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.

Parameters:

enableLogging - enableLogging or null for none

getKind

public String getKind()

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Returns:

value or null for none

setKind

public FirewallPolicyRule setKind(String kind)

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Parameters:

kind - kind or null for none

getMatch

public FirewallPolicyRuleMatcher 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 FirewallPolicyRule setMatch(FirewallPolicyRuleMatcher 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 FirewallPolicyRule 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 prority.

Returns:

value or null for none

setPriority

public FirewallPolicyRule 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 prority.

Parameters:

priority - priority or null for none

getRuleTupleCount

public Integer getRuleTupleCount()

[Output Only] Calculation of the complexity of a single firewall policy rule.

Returns:

value or null for none

setRuleTupleCount

public FirewallPolicyRule setRuleTupleCount(Integer ruleTupleCount)

[Output Only] Calculation of the complexity of a single firewall 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.

Returns:

value or null for none

setTargetResources

public FirewallPolicyRule 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.

Parameters:

targetResources - targetResources or null for none

getTargetSecureLabels

public List<String> getTargetSecureLabels()

A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

Returns:

value or null for none

setTargetSecureLabels

public FirewallPolicyRule setTargetSecureLabels(List<String> targetSecureLabels)

A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

Parameters:

targetSecureLabels - targetSecureLabels 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 FirewallPolicyRule 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 FirewallPolicyRule set(String fieldName,
                              Object value)

Overrides:

set in class GenericJson

clone

public FirewallPolicyRule clone()

Overrides:

clone in class GenericJson