Interface FirewallPolicyOrBuilder (3.27.0)

Version 3.27.0

• 3.52.0 (latest)
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.12
• 2.6.1
• 2.5.0
• 2.4.10
• 2.3.1

public interface FirewallPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActions(int index)

public abstract FirewallAction getActions(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
FirewallAction

getActionsCount()

public abstract int getActionsCount()

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;

Returns
Type	Description
int

getActionsList()

public abstract List<FirewallAction> getActionsList()

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;

Returns
Type	Description
List<FirewallAction>

getActionsOrBuilder(int index)

public abstract FirewallActionOrBuilder getActionsOrBuilder(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
FirewallActionOrBuilder

getActionsOrBuilderList()

public abstract List<? extends FirewallActionOrBuilder> getActionsOrBuilderList()

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;

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

getCondition()

public abstract String getCondition()

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;

Returns
Type	Description
String	The condition.

getConditionBytes()

public abstract ByteString getConditionBytes()

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;

Returns
Type	Description
ByteString	The bytes for condition.

getDescription()

public abstract String getDescription()

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;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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;

Returns
Type	Description
ByteString	The bytes for description.

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getPath()

public abstract String getPath()

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;

Returns
Type	Description
String	The path.

getPathBytes()

public abstract ByteString getPathBytes()

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;

Returns
Type	Description
ByteString	The bytes for path.