- 3.50.0 (latest)
- 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 static final class FirewallPolicy.Builder extends GeneratedMessageV3.Builder<FirewallPolicy.Builder> implements FirewallPolicyOrBuilderA 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.BuilderImplements
FirewallPolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addActions(FirewallAction value)
public FirewallPolicy.Builder addActions(FirewallAction value) 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 |
value | FirewallAction |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
addActions(FirewallAction.Builder builderForValue)
public FirewallPolicy.Builder addActions(FirewallAction.Builder builderForValue) 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 |
builderForValue | FirewallAction.Builder |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
addActions(int index, FirewallAction value)
public FirewallPolicy.Builder addActions(int index, FirewallAction value) 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;
| 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) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | FirewallAction.Builder |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
addActionsBuilder()
public FirewallAction.Builder addActionsBuilder() 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 |
FirewallAction.Builder | |
addActionsBuilder(int index)
public FirewallAction.Builder addActionsBuilder(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.Builder | |
addAllActions(Iterable<? extends FirewallAction> values)
public FirewallPolicy.Builder addAllActions(Iterable<? extends FirewallAction> values) 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 |
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 | |
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 | |
clearActions()
public FirewallPolicy.Builder clearActions() 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 |
FirewallPolicy.Builder | |
clearCondition()
public FirewallPolicy.Builder clearCondition()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 |
FirewallPolicy.Builder | This builder for chaining. |
clearDescription()
public FirewallPolicy.Builder clearDescription()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 |
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 | |
clearName()
public FirewallPolicy.Builder clearName() The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
string name = 1;
| 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 | |
clearPath()
public FirewallPolicy.Builder clearPath()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 |
FirewallPolicy.Builder | This builder for chaining. |
clone()
public FirewallPolicy.Builder clone()| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
getActions(int index)
public 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 | |
getActionsBuilder(int index)
public FirewallAction.Builder getActionsBuilder(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.Builder | |
getActionsBuilderList()
public List<FirewallAction.Builder> getActionsBuilderList() 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<Builder> | |
getActionsCount()
public 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 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 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 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 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 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. |
getDefaultInstanceForType()
public FirewallPolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
FirewallPolicy | |
getDescription()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getName()
public 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public FirewallPolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
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 | |
removeActions(int index)
public FirewallPolicy.Builder removeActions(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 |
FirewallPolicy.Builder | |
setActions(int index, FirewallAction value)
public FirewallPolicy.Builder setActions(int index, FirewallAction value) 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;
| 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) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | FirewallAction.Builder |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |
setCondition(String value)
public FirewallPolicy.Builder setCondition(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setConditionBytes(ByteString value)
public FirewallPolicy.Builder setConditionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for condition to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setDescription(String value)
public FirewallPolicy.Builder setDescription(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public FirewallPolicy.Builder setDescriptionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | |
setName(String value)
public FirewallPolicy.Builder setName(String value) The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public FirewallPolicy.Builder setNameBytes(ByteString value) The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setPath(String value)
public FirewallPolicy.Builder setPath(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe path to set. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | This builder for chaining. |
setPathBytes(ByteString value)
public FirewallPolicy.Builder setPathBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | |
setUnknownFields(UnknownFieldSet unknownFields)
public final FirewallPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy.Builder | |