FirewallAction.Builder (proto-google-cloud-recaptchaenterprise-v1 3.72.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>
    - - com.google.recaptchaenterprise.v1.FirewallAction.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FirewallActionOrBuilder, Cloneable

Enclosing class:

FirewallAction
```
public static final class FirewallAction.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>
implements FirewallActionOrBuilder
```
```
 An individual action. Each action represents what to do if a policy
 matches.
 
```
Protobuf type google.cloud.recaptchaenterprise.v1.FirewallAction

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FirewallAction.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`FirewallAction`	`build()`
`FirewallAction`	`buildPartial()`
`FirewallAction.Builder`	`clear()`
`FirewallAction.Builder`	`clearAllow()` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.Builder`	`clearBlock()` This action denies access to a given page.
`FirewallAction.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`FirewallAction.Builder`	`clearFirewallActionOneof()`
`FirewallAction.Builder`	`clearIncludeRecaptchaScript()` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`FirewallAction.Builder`	`clearRedirect()` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.Builder`	`clearSetHeader()` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.Builder`	`clearSubstitute()` This action transparently serves a different page to an offending user.
`FirewallAction.Builder`	`clone()`
`FirewallAction.AllowAction`	`getAllow()` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.AllowAction.Builder`	`getAllowBuilder()` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.AllowActionOrBuilder`	`getAllowOrBuilder()` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.BlockAction`	`getBlock()` This action denies access to a given page.
`FirewallAction.BlockAction.Builder`	`getBlockBuilder()` This action denies access to a given page.
`FirewallAction.BlockActionOrBuilder`	`getBlockOrBuilder()` This action denies access to a given page.
`FirewallAction`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`FirewallAction.FirewallActionOneofCase`	`getFirewallActionOneofCase()`
`FirewallAction.IncludeRecaptchaScriptAction`	`getIncludeRecaptchaScript()` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.IncludeRecaptchaScriptAction.Builder`	`getIncludeRecaptchaScriptBuilder()` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.IncludeRecaptchaScriptActionOrBuilder`	`getIncludeRecaptchaScriptOrBuilder()` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.RedirectAction`	`getRedirect()` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.RedirectAction.Builder`	`getRedirectBuilder()` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.RedirectActionOrBuilder`	`getRedirectOrBuilder()` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.SetHeaderAction`	`getSetHeader()` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.SetHeaderAction.Builder`	`getSetHeaderBuilder()` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.SetHeaderActionOrBuilder`	`getSetHeaderOrBuilder()` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.SubstituteAction`	`getSubstitute()` This action transparently serves a different page to an offending user.
`FirewallAction.SubstituteAction.Builder`	`getSubstituteBuilder()` This action transparently serves a different page to an offending user.
`FirewallAction.SubstituteActionOrBuilder`	`getSubstituteOrBuilder()` This action transparently serves a different page to an offending user.
`boolean`	`hasAllow()` The user request did not match any policy and should be allowed access to the requested resource.
`boolean`	`hasBlock()` This action denies access to a given page.
`boolean`	`hasIncludeRecaptchaScript()` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`boolean`	`hasRedirect()` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`boolean`	`hasSetHeader()` This action sets a custom header but allow the request to continue to the customer backend.
`boolean`	`hasSubstitute()` This action transparently serves a different page to an offending user.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`FirewallAction.Builder`	`mergeAllow(FirewallAction.AllowAction value)` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.Builder`	`mergeBlock(FirewallAction.BlockAction value)` This action denies access to a given page.
`FirewallAction.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`FirewallAction.Builder`	`mergeFrom(FirewallAction other)`
`FirewallAction.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`FirewallAction.Builder`	`mergeIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.Builder`	`mergeRedirect(FirewallAction.RedirectAction value)` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.Builder`	`mergeSetHeader(FirewallAction.SetHeaderAction value)` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.Builder`	`mergeSubstitute(FirewallAction.SubstituteAction value)` This action transparently serves a different page to an offending user.
`FirewallAction.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`FirewallAction.Builder`	`setAllow(FirewallAction.AllowAction.Builder builderForValue)` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.Builder`	`setAllow(FirewallAction.AllowAction value)` The user request did not match any policy and should be allowed access to the requested resource.
`FirewallAction.Builder`	`setBlock(FirewallAction.BlockAction.Builder builderForValue)` This action denies access to a given page.
`FirewallAction.Builder`	`setBlock(FirewallAction.BlockAction value)` This action denies access to a given page.
`FirewallAction.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`FirewallAction.Builder`	`setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction.Builder builderForValue)` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.Builder`	`setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)` This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
`FirewallAction.Builder`	`setRedirect(FirewallAction.RedirectAction.Builder builderForValue)` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.Builder`	`setRedirect(FirewallAction.RedirectAction value)` This action redirects the request to a reCAPTCHA interstitial to attach a token.
`FirewallAction.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`FirewallAction.Builder`	`setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.Builder`	`setSetHeader(FirewallAction.SetHeaderAction value)` This action sets a custom header but allow the request to continue to the customer backend.
`FirewallAction.Builder`	`setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)` This action transparently serves a different page to an offending user.
`FirewallAction.Builder`	`setSubstitute(FirewallAction.SubstituteAction value)` This action transparently serves a different page to an offending user.
`FirewallAction.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

clear
```
public FirewallAction.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

getDefaultInstanceForType
```
public FirewallAction getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public FirewallAction build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public FirewallAction buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public FirewallAction.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

setField

public FirewallAction.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

clearField
```
public FirewallAction.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

clearOneof
```
public FirewallAction.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

setRepeatedField

public FirewallAction.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

addRepeatedField

public FirewallAction.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

mergeFrom
```
public FirewallAction.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirewallAction.Builder>

mergeFrom

public FirewallAction.Builder mergeFrom(FirewallAction other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallAction.Builder>

mergeFrom
```
public FirewallAction.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirewallAction.Builder>

Throws:

IOException

getFirewallActionOneofCase
```
public FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()
```
Specified by:

getFirewallActionOneofCase in interface FirewallActionOrBuilder

clearFirewallActionOneof

public FirewallAction.Builder clearFirewallActionOneof()

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;
Specified by:

hasAllow in interface FirewallActionOrBuilder

Returns:

Whether the allow field is set.

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;
Specified by:

getAllow in interface FirewallActionOrBuilder

Returns:

The allow.