- 3.75.0 (latest)
 - 3.73.0
 - 3.72.0
 - 3.71.0
 - 3.70.0
 - 3.69.0
 - 3.67.0
 - 3.65.0
 - 3.64.0
 - 3.61.0
 - 3.60.0
 - 3.59.0
 - 3.57.0
 - 3.56.0
 - 3.55.0
 - 3.54.0
 - 3.53.0
 - 3.52.0
 - 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 static final class FirewallAction.Builder extends GeneratedMessageV3.Builder<FirewallAction.Builder> implements FirewallActionOrBuilderAn individual action. Each action represents what to do if a policy matches.
 Protobuf type google.cloud.recaptchaenterprise.v1.FirewallAction
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FirewallAction.BuilderImplements
FirewallActionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FirewallAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
build()
public FirewallAction build()| Returns | |
|---|---|
| Type | Description | 
FirewallAction | 
        |
buildPartial()
public FirewallAction buildPartial()| Returns | |
|---|---|
| Type | Description | 
FirewallAction | 
        |
clear()
public FirewallAction.Builder clear()| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearAllow()
public FirewallAction.Builder clearAllow()The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearBlock()
public FirewallAction.Builder clearBlock()This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public FirewallAction.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearFirewallActionOneof()
public FirewallAction.Builder clearFirewallActionOneof()| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearOneof(Descriptors.OneofDescriptor oneof)
public FirewallAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearRedirect()
public FirewallAction.Builder clearRedirect()This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearSetHeader()
public FirewallAction.Builder clearSetHeader()This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clearSubstitute()
public FirewallAction.Builder clearSubstitute()This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
clone()
public FirewallAction.Builder clone()| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
getAllow()
public FirewallAction.AllowAction getAllow()The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.AllowAction | 
        The allow.  | 
      
getAllowBuilder()
public FirewallAction.AllowAction.Builder getAllowBuilder()The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.AllowAction.Builder | 
        |
getAllowOrBuilder()
public FirewallAction.AllowActionOrBuilder getAllowOrBuilder()The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.AllowActionOrBuilder | 
        |
getBlock()
public FirewallAction.BlockAction getBlock()This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.BlockAction | 
        The block.  | 
      
getBlockBuilder()
public FirewallAction.BlockAction.Builder getBlockBuilder()This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.BlockAction.Builder | 
        |
getBlockOrBuilder()
public FirewallAction.BlockActionOrBuilder getBlockOrBuilder()This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.BlockActionOrBuilder | 
        |
getDefaultInstanceForType()
public FirewallAction getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
FirewallAction | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getFirewallActionOneofCase()
public FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()| Returns | |
|---|---|
| Type | Description | 
FirewallAction.FirewallActionOneofCase | 
        |
getRedirect()
public FirewallAction.RedirectAction getRedirect()This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.RedirectAction | 
        The redirect.  | 
      
getRedirectBuilder()
public FirewallAction.RedirectAction.Builder getRedirectBuilder()This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.RedirectAction.Builder | 
        |
getRedirectOrBuilder()
public FirewallAction.RedirectActionOrBuilder getRedirectOrBuilder()This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.RedirectActionOrBuilder | 
        |
getSetHeader()
public FirewallAction.SetHeaderAction getSetHeader()This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SetHeaderAction | 
        The setHeader.  | 
      
getSetHeaderBuilder()
public FirewallAction.SetHeaderAction.Builder getSetHeaderBuilder()This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SetHeaderAction.Builder | 
        |
getSetHeaderOrBuilder()
public FirewallAction.SetHeaderActionOrBuilder getSetHeaderOrBuilder()This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SetHeaderActionOrBuilder | 
        |
getSubstitute()
public FirewallAction.SubstituteAction getSubstitute()This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SubstituteAction | 
        The substitute.  | 
      
getSubstituteBuilder()
public FirewallAction.SubstituteAction.Builder getSubstituteBuilder()This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SubstituteAction.Builder | 
        |
getSubstituteOrBuilder()
public FirewallAction.SubstituteActionOrBuilder getSubstituteOrBuilder()This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.SubstituteActionOrBuilder | 
        |
hasAllow()
public boolean hasAllow()The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the allow field is set.  | 
      
hasBlock()
public boolean hasBlock()This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the block field is set.  | 
      
hasRedirect()
public boolean hasRedirect()This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the redirect field is set.  | 
      
hasSetHeader()
public boolean hasSetHeader()This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the setHeader field is set.  | 
      
hasSubstitute()
public boolean hasSubstitute()This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the substitute field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeAllow(FirewallAction.AllowAction value)
public FirewallAction.Builder mergeAllow(FirewallAction.AllowAction value)The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.AllowAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeBlock(FirewallAction.BlockAction value)
public FirewallAction.Builder mergeBlock(FirewallAction.BlockAction value)This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.BlockAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FirewallAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public FirewallAction.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeFrom(FirewallAction other)
public FirewallAction.Builder mergeFrom(FirewallAction other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        FirewallAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeRedirect(FirewallAction.RedirectAction value)
public FirewallAction.Builder mergeRedirect(FirewallAction.RedirectAction value)This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.RedirectAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeSetHeader(FirewallAction.SetHeaderAction value)
public FirewallAction.Builder mergeSetHeader(FirewallAction.SetHeaderAction value)This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.SetHeaderAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeSubstitute(FirewallAction.SubstituteAction value)
public FirewallAction.Builder mergeSubstitute(FirewallAction.SubstituteAction value)This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.SubstituteAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FirewallAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setAllow(FirewallAction.AllowAction value)
public FirewallAction.Builder setAllow(FirewallAction.AllowAction value)The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.AllowAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setAllow(FirewallAction.AllowAction.Builder builderForValue)
public FirewallAction.Builder setAllow(FirewallAction.AllowAction.Builder builderForValue)The user request did not match any policy and should be allowed access to the requested resource.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        FirewallAction.AllowAction.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setBlock(FirewallAction.BlockAction value)
public FirewallAction.Builder setBlock(FirewallAction.BlockAction value)This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.BlockAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setBlock(FirewallAction.BlockAction.Builder builderForValue)
public FirewallAction.Builder setBlock(FirewallAction.BlockAction.Builder builderForValue)This action will deny access to a given page. The user will get an HTTP error code.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        FirewallAction.BlockAction.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public FirewallAction.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setRedirect(FirewallAction.RedirectAction value)
public FirewallAction.Builder setRedirect(FirewallAction.RedirectAction value)This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.RedirectAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setRedirect(FirewallAction.RedirectAction.Builder builderForValue)
public FirewallAction.Builder setRedirect(FirewallAction.RedirectAction.Builder builderForValue)This action will redirect the request to a ReCaptcha interstitial to attach a token.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        FirewallAction.RedirectAction.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FirewallAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setSetHeader(FirewallAction.SetHeaderAction value)
public FirewallAction.Builder setSetHeader(FirewallAction.SetHeaderAction value)This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.SetHeaderAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)
public FirewallAction.Builder setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)This action will set a custom header but allow the request to continue to the customer backend.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        FirewallAction.SetHeaderAction.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setSubstitute(FirewallAction.SubstituteAction value)
public FirewallAction.Builder setSubstitute(FirewallAction.SubstituteAction value)This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        FirewallAction.SubstituteAction | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)
public FirewallAction.Builder setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)This action will transparently serve a different page to an offending user.
 .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        FirewallAction.SubstituteAction.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final FirewallAction.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
FirewallAction.Builder | 
        |