com.google.api.services.appengine.v1.model

Class FirewallRule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.FirewallRule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FirewallRule
extends com.google.api.client.json.GenericJson

A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

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 App Engine Admin 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
FirewallRule()

Method Summary

Modifier and Type	Method and Description
FirewallRule	clone()
String	getAction() The action to take on matched requests.
String	getDescription() An optional string description of this rule.
Integer	getPriority() A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation.
String	getSourceRange() IP address or range, defined using CIDR notation, of requests that this rule applies to.
FirewallRule	set(String fieldName, Object value)
FirewallRule	setAction(String action) The action to take on matched requests.
FirewallRule	setDescription(String description) An optional string description of this rule.
FirewallRule	setPriority(Integer priority) A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation.
FirewallRule	setSourceRange(String sourceRange) IP address or range, defined using CIDR notation, of requests that this rule applies to.

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

FirewallRule

public FirewallRule()

Method Detail

getAction

public String getAction()

The action to take on matched requests.

Returns:

value or null for none

setAction

public FirewallRule setAction(String action)

The action to take on matched requests.

Parameters:

action - action or null for none

getDescription

public String getDescription()

An optional string description of this rule. This field has a maximum length of 400 characters.

Returns:

value or null for none

setDescription

public FirewallRule setDescription(String description)

An optional string description of this rule. This field has a maximum length of 400 characters.

Parameters:

description - description or null for none

getPriority

public Integer getPriority()

A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

Returns:

value or null for none

setPriority

public FirewallRule setPriority(Integer priority)

A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

Parameters:

priority - priority or null for none

getSourceRange

public String getSourceRange()

IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.

Returns:

value or null for none

setSourceRange

public FirewallRule setSourceRange(String sourceRange)

IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.

Parameters:

sourceRange - sourceRange or null for none

set

public FirewallRule set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FirewallRule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson