Class FirewallPolicy.Builder (3.51.0) 

public static final class FirewallPolicy.Builder extends GeneratedMessageV3.Builder<FirewallPolicy.Builder> implements FirewallPolicyOrBuilder

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Protobuf type google.cloud.recaptchaenterprise.v1.FirewallPolicy

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addActions(FirewallAction value)

public FirewallPolicy.Builder addActions(FirewallAction value)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FirewallAction
Returns
Type Description
FirewallPolicy.Builder

addActions(FirewallAction.Builder builderForValue)

public FirewallPolicy.Builder addActions(FirewallAction.Builder builderForValue)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue FirewallAction.Builder
Returns
Type Description
FirewallPolicy.Builder

addActions(int index, FirewallAction value)

public FirewallPolicy.Builder addActions(int index, FirewallAction value)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value FirewallAction
Returns
Type Description
FirewallPolicy.Builder

addActions(int index, FirewallAction.Builder builderForValue)

public FirewallPolicy.Builder addActions(int index, FirewallAction.Builder builderForValue)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue FirewallAction.Builder
Returns
Type Description
FirewallPolicy.Builder

addActionsBuilder()

public FirewallAction.Builder addActionsBuilder()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallAction.Builder

addActionsBuilder(int index)

public FirewallAction.Builder addActionsBuilder(int index)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FirewallAction.Builder

addAllActions(Iterable<? extends FirewallAction> values)

public FirewallPolicy.Builder addAllActions(Iterable<? extends FirewallAction> values)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.recaptchaenterprise.v1.FirewallAction>
Returns
Type Description
FirewallPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FirewallPolicy build()
Returns
Type Description
FirewallPolicy

buildPartial()

public FirewallPolicy buildPartial()
Returns
Type Description
FirewallPolicy

clear()

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

clearActions()

public FirewallPolicy.Builder clearActions()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallPolicy.Builder

clearCondition()

public FirewallPolicy.Builder clearCondition()

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.

string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearDescription()

public FirewallPolicy.Builder clearDescription()

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public FirewallPolicy.Builder clearName()

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPath()

public FirewallPolicy.Builder clearPath()

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

string path = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clone()

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

getActions(int index)

public FirewallAction getActions(int index)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FirewallAction

getActionsBuilder(int index)

public FirewallAction.Builder getActionsBuilder(int index)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FirewallAction.Builder

getActionsBuilderList()

public List<FirewallAction.Builder> getActionsBuilderList()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getActionsCount()

public int getActionsCount()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getActionsList()

public List<FirewallAction> getActionsList()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<FirewallAction>

getActionsOrBuilder(int index)

public FirewallActionOrBuilder getActionsOrBuilder(int index)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FirewallActionOrBuilder

getActionsOrBuilderList()

public List<? extends FirewallActionOrBuilder> getActionsOrBuilderList()

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.recaptchaenterprise.v1.FirewallActionOrBuilder>

getCondition()

public String getCondition()

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.

string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The condition.

getConditionBytes()

public ByteString getConditionBytes()

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.

string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for condition.

getDefaultInstanceForType()

public FirewallPolicy getDefaultInstanceForType()
Returns
Type Description
FirewallPolicy

getDescription()

public String getDescription()

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPath()

public String getPath()

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

string path = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The path.

getPathBytes()

public ByteString getPathBytes()

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

string path = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for path.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(FirewallPolicy other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeActions(int index)

public FirewallPolicy.Builder removeActions(int index)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicy.Builder

setActions(int index, FirewallAction value)

public FirewallPolicy.Builder setActions(int index, FirewallAction value)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value FirewallAction
Returns
Type Description
FirewallPolicy.Builder

setActions(int index, FirewallAction.Builder builderForValue)

public FirewallPolicy.Builder setActions(int index, FirewallAction.Builder builderForValue)

Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue FirewallAction.Builder
Returns
Type Description
FirewallPolicy.Builder

setCondition(String value)

public FirewallPolicy.Builder setCondition(String value)

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.

string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The condition to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setConditionBytes(ByteString value)

public FirewallPolicy.Builder setConditionBytes(ByteString value)

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.

string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for condition to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDescription(String value)

public FirewallPolicy.Builder setDescription(String value)

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public FirewallPolicy.Builder setDescriptionBytes(ByteString value)

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public FirewallPolicy.Builder setName(String value)

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FirewallPolicy.Builder setNameBytes(ByteString value)

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setPath(String value)

public FirewallPolicy.Builder setPath(String value)

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

string path = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The path to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setPathBytes(ByteString value)

public FirewallPolicy.Builder setPathBytes(ByteString value)

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

string path = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for path to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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