Class FirewallRule (2.59.0)

publicfinalclass FirewallRuleextendsGeneratedMessageV3implementsFirewallRuleOrBuilder

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

Protobuf type google.appengine.v1.FirewallRule

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ACTION_FIELD_NUMBER

publicstaticfinalintACTION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

publicstaticfinalintPRIORITY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_RANGE_FIELD_NUMBER

publicstaticfinalintSOURCE_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticFirewallRulegetDefaultInstance()
Returns
Type Description
FirewallRule

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticFirewallRule.BuildernewBuilder()
Returns
Type Description
FirewallRule.Builder

newBuilder(FirewallRule prototype)

publicstaticFirewallRule.BuildernewBuilder(FirewallRuleprototype)
Parameter
Name Description
prototype FirewallRule
Returns
Type Description
FirewallRule.Builder

parseDelimitedFrom(InputStream input)

publicstaticFirewallRuleparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticFirewallRuleparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticFirewallRuleparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticFirewallRuleparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticFirewallRuleparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticFirewallRuleparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticFirewallRuleparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<FirewallRule>parser()
Returns
Type Description
Parser<FirewallRule>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAction()

publicFirewallRule.ActiongetAction()

The action to take on matched requests.

.google.appengine.v1.FirewallRule.Action action = 2;

Returns
Type Description
FirewallRule.Action

The action.

getActionValue()

publicintgetActionValue()

The action to take on matched requests.

.google.appengine.v1.FirewallRule.Action action = 2;

Returns
Type Description
int

The enum numeric value on the wire for action.

getDefaultInstanceForType()

publicFirewallRulegetDefaultInstanceForType()
Returns
Type Description
FirewallRule

getDescription()

publicStringgetDescription()

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

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

publicByteStringgetDescriptionBytes()

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

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getParserForType()

publicParser<FirewallRule>getParserForType()
Returns
Type Description
Parser<FirewallRule>
Overrides

getPriority()

publicintgetPriority()

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.

int32 priority = 1;

Returns
Type Description
int

The priority.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSourceRange()

publicStringgetSourceRange()

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.

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

string source_range = 3;

Returns
Type Description
String

The sourceRange.

getSourceRangeBytes()

publicByteStringgetSourceRangeBytes()

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.

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

string source_range = 3;

Returns
Type Description
ByteString

The bytes for sourceRange.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicFirewallRule.BuildernewBuilderForType()
Returns
Type Description
FirewallRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedFirewallRule.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FirewallRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicFirewallRule.BuildertoBuilder()
Returns
Type Description
FirewallRule.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.