Class FirewallRule.Builder (2.54.0) 

public static final class FirewallRule.Builder extends GeneratedMessageV3.Builder<FirewallRule.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FirewallRule.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FirewallRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallRule.Builder
Overrides

build()

public FirewallRule build()
Returns
Type Description
FirewallRule

buildPartial()

public FirewallRule buildPartial()
Returns
Type Description
FirewallRule

clear()

public FirewallRule.Builder clear()
Returns
Type Description
FirewallRule.Builder
Overrides

clearAction()

public FirewallRule.Builder clearAction()

The action to take on matched requests.

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

Returns
Type Description
FirewallRule.Builder

This builder for chaining.

clearDescription()

public FirewallRule.Builder clearDescription()

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

string description = 4;

Returns
Type Description
FirewallRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FirewallRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FirewallRule.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public FirewallRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FirewallRule.Builder
Overrides

clearPriority()

public FirewallRule.Builder clearPriority()

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
FirewallRule.Builder

This builder for chaining.

clearSourceRange()

public FirewallRule.Builder clearSourceRange()

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
FirewallRule.Builder

This builder for chaining.

clone()

public FirewallRule.Builder clone()
Returns
Type Description
FirewallRule.Builder
Overrides

getAction()

public FirewallRule.Action getAction()

The action to take on matched requests.

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

Returns
Type Description
FirewallRule.Action

The action.

getActionValue()

public int getActionValue()

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()

public FirewallRule getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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
Type Description
int

The priority.

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
Type Description
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
Type Description
ByteString

The bytes for sourceRange.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FirewallRule other)

public FirewallRule.Builder mergeFrom(FirewallRule other)
Parameter
Name Description
other FirewallRule
Returns
Type Description
FirewallRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FirewallRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FirewallRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FirewallRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FirewallRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallRule.Builder
Overrides

setAction(FirewallRule.Action value)

public FirewallRule.Builder setAction(FirewallRule.Action value)

The action to take on matched requests.

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

Parameter
Name Description
value FirewallRule.Action

The action to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setActionValue(int value)

public FirewallRule.Builder setActionValue(int value)

The action to take on matched requests.

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

Parameter
Name Description
value int

The enum numeric value on the wire for action to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setDescription(String value)

public FirewallRule.Builder setDescription(String value)

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

string description = 4;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public FirewallRule.Builder setDescriptionBytes(ByteString value)

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

string description = 4;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FirewallRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallRule.Builder
Overrides

setPriority(int value)

public FirewallRule.Builder setPriority(int value)

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;

Parameter
Name Description
value int

The priority to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FirewallRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FirewallRule.Builder
Overrides

setSourceRange(String value)

public FirewallRule.Builder setSourceRange(String value)

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;

Parameter
Name Description
value String

The sourceRange to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setSourceRangeBytes(ByteString value)

public FirewallRule.Builder setSourceRangeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for sourceRange to set.
Returns
Type Description
FirewallRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FirewallRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallRule.Builder
Overrides