com.google.recaptchaenterprise.v1

Interface FirewallPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FirewallPolicy, FirewallPolicy.Builder

public interface FirewallPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
FirewallAction	getActions(int index) Optional.
int	getActionsCount() Optional.
List<FirewallAction>	getActionsList() Optional.
FirewallActionOrBuilder	getActionsOrBuilder(int index) Optional.
List<? extends FirewallActionOrBuilder>	getActionsOrBuilderList() Optional.
String	getCondition() Optional.
com.google.protobuf.ByteString	getConditionBytes() Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
String	getPath() Optional.
com.google.protobuf.ByteString	getPathBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDescription

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:

The description.

getDescriptionBytes

com.google.protobuf.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:

The bytes for description.

getPath

String getPath()

 Optional. The path for which this policy applies, specified as a glob
 pattern. For more information on glob, see the [manual
 page](https://man7.org/linux/man-pages/man7/glob.7.html).
 A path has a max length of 200 characters.
 

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

Returns:

The path.

getPathBytes

com.google.protobuf.ByteString getPathBytes()

 Optional. The path for which this policy applies, specified as a glob
 pattern. For more information on glob, see the [manual
 page](https://man7.org/linux/man-pages/man7/glob.7.html).
 A path has a max length of 200 characters.
 

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

Returns:

The bytes for path.

getCondition

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](https://github.com/google/cel-spec)
 and its [language
 definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
 A condition has a max length of 500 characters.
 

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

Returns:

The condition.

getConditionBytes

com.google.protobuf.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](https://github.com/google/cel-spec)
 and its [language
 definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
 A condition has a max length of 500 characters.
 

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

Returns:

The bytes for condition.

getActionsList

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];

getActions

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];

getActionsCount

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];

getActionsOrBuilderList

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];

getActionsOrBuilder

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];