Class FirewallRule (2.31.0)

public final class FirewallRule extends GeneratedMessageV3 implements FirewallRuleOrBuilder

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

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_RANGE_FIELD_NUMBER

public static final int SOURCE_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FirewallRule getDefaultInstance()
Returns
TypeDescription
FirewallRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FirewallRule.Builder newBuilder()
Returns
TypeDescription
FirewallRule.Builder

newBuilder(FirewallRule prototype)

public static FirewallRule.Builder newBuilder(FirewallRule prototype)
Parameter
NameDescription
prototypeFirewallRule
Returns
TypeDescription
FirewallRule.Builder

parseDelimitedFrom(InputStream input)

public static FirewallRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FirewallRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirewallRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirewallRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FirewallRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FirewallRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirewallRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FirewallRule> parser()
Returns
TypeDescription
Parser<FirewallRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAction()

public FirewallRule.Action getAction()

The action to take on matched requests.

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

Returns
TypeDescription
FirewallRule.Action

The action.

getActionValue()

public int getActionValue()

The action to take on matched requests.

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

Returns
TypeDescription
int

The enum numeric value on the wire for action.

getDefaultInstanceForType()

public FirewallRule getDefaultInstanceForType()
Returns
TypeDescription
FirewallRule

getDescription()

public String getDescription()

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

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 4;

Returns
TypeDescription
ByteString

The bytes for description.

getParserForType()

public Parser<FirewallRule> getParserForType()
Returns
TypeDescription
Parser<FirewallRule>
Overrides

getPriority()

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

int32 priority = 1;

Returns
TypeDescription
int

The priority.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

<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
TypeDescription
String

The sourceRange.

getSourceRangeBytes()

public ByteString getSourceRangeBytes()

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
TypeDescription
ByteString

The bytes for sourceRange.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FirewallRule.Builder newBuilderForType()
Returns
TypeDescription
FirewallRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FirewallRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FirewallRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FirewallRule.Builder toBuilder()
Returns
TypeDescription
FirewallRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException