Class FirewallRule.Builder (2.33.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

Implements

FirewallRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public FirewallRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`FirewallRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

string source_range = 3;

Returns
Type	Description
`String`	The sourceRange.

getSourceRangeBytes()

public ByteString getSourceRangeBytes()

string source_range = 3;

Returns
Type	Description
`ByteString`	The bytes for sourceRange.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public FirewallRule.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`FirewallRule.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FirewallRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`FirewallRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSourceRange(String value)

public FirewallRule.Builder setSourceRange(String value)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)