Class FirewallAction
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.FirewallAction
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,FirewallActionOrBuilder,Serializable
@Generated
public final class FirewallAction
extends com.google.protobuf.GeneratedMessage
implements FirewallActionOrBuilder
An individual action. Each action represents what to do if a policy matches.Protobuf type
google.cloud.recaptchaenterprise.v1.FirewallAction- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAn allow action continues processing a request unimpeded.static interfacestatic final classA block action serves an HTTP error code a prevents the request from hitting the backend.static interfacestatic final classAn individual action.static enumstatic final classAn include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend.static interfacestatic final classA redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token.static interfacestatic final classA set header action sets a header and forwards the request to the backend.static interfacestatic final classA substitute action transparently serves a different page than the one requested.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAllow()The user request did not match any policy and should be allowed access to the requested resource.The user request did not match any policy and should be allowed access to the requested resource.getBlock()This action denies access to a given page.This action denies access to a given page.static FirewallActionstatic final com.google.protobuf.Descriptors.DescriptorThis action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.com.google.protobuf.Parser<FirewallAction>This action redirects the request to a reCAPTCHA interstitial to attach a token.This action redirects the request to a reCAPTCHA interstitial to attach a token.intThis action sets a custom header but allow the request to continue to the customer backend.This action sets a custom header but allow the request to continue to the customer backend.This action transparently serves a different page to an offending user.This action transparently serves a different page to an offending user.booleanhasAllow()The user request did not match any policy and should be allowed access to the requested resource.booleanhasBlock()This action denies access to a given page.inthashCode()booleanThis action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.booleanThis action redirects the request to a reCAPTCHA interstitial to attach a token.booleanThis action sets a custom header but allow the request to continue to the customer backend.booleanThis action transparently serves a different page to an offending user.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic FirewallAction.Builderstatic FirewallAction.BuildernewBuilder(FirewallAction prototype) protected FirewallAction.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static FirewallActionparseDelimitedFrom(InputStream input) static FirewallActionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FirewallActionparseFrom(byte[] data) static FirewallActionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FirewallActionparseFrom(com.google.protobuf.ByteString data) static FirewallActionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FirewallActionparseFrom(com.google.protobuf.CodedInputStream input) static FirewallActionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FirewallActionparseFrom(InputStream input) static FirewallActionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FirewallActionparseFrom(ByteBuffer data) static FirewallActionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FirewallAction>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
ALLOW_FIELD_NUMBER
public static final int ALLOW_FIELD_NUMBER- See Also:
-
BLOCK_FIELD_NUMBER
public static final int BLOCK_FIELD_NUMBER- See Also:
-
INCLUDE_RECAPTCHA_SCRIPT_FIELD_NUMBER
public static final int INCLUDE_RECAPTCHA_SCRIPT_FIELD_NUMBER- See Also:
-
REDIRECT_FIELD_NUMBER
public static final int REDIRECT_FIELD_NUMBER- See Also:
-
SUBSTITUTE_FIELD_NUMBER
public static final int SUBSTITUTE_FIELD_NUMBER- See Also:
-
SET_HEADER_FIELD_NUMBER
public static final int SET_HEADER_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getFirewallActionOneofCase
- Specified by:
getFirewallActionOneofCasein interfaceFirewallActionOrBuilder
-
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:
hasAllowin interfaceFirewallActionOrBuilder- Returns:
- Whether the allow field is set.
-
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:
getAllowin interfaceFirewallActionOrBuilder- Returns:
- The allow.
-
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;- Specified by:
getAllowOrBuilderin interfaceFirewallActionOrBuilder
-
hasBlock
public boolean hasBlock()This action denies access to a given page. The user gets an HTTP error code.
.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;- Specified by:
hasBlockin interfaceFirewallActionOrBuilder- Returns:
- Whether the block field is set.
-
getBlock
This action denies access to a given page. The user gets an HTTP error code.
.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;- Specified by:
getBlockin interfaceFirewallActionOrBuilder- Returns:
- The block.
-
getBlockOrBuilder
This action denies access to a given page. The user gets an HTTP error code.
.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;- Specified by:
getBlockOrBuilderin interfaceFirewallActionOrBuilder
-
hasIncludeRecaptchaScript
public boolean hasIncludeRecaptchaScript()This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;- Specified by:
hasIncludeRecaptchaScriptin interfaceFirewallActionOrBuilder- Returns:
- Whether the includeRecaptchaScript field is set.
-
getIncludeRecaptchaScript
This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;- Specified by:
getIncludeRecaptchaScriptin interfaceFirewallActionOrBuilder- Returns:
- The includeRecaptchaScript.
-
getIncludeRecaptchaScriptOrBuilder
This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;- Specified by:
getIncludeRecaptchaScriptOrBuilderin interfaceFirewallActionOrBuilder
-
hasRedirect
public boolean hasRedirect()This action redirects the request to a reCAPTCHA interstitial to attach a token.
.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;- Specified by:
hasRedirectin interfaceFirewallActionOrBuilder- Returns:
- Whether the redirect field is set.
-
getRedirect
This action redirects the request to a reCAPTCHA interstitial to attach a token.
.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;- Specified by:
getRedirectin interfaceFirewallActionOrBuilder- Returns:
- The redirect.
-
getRedirectOrBuilder
This action redirects the request to a reCAPTCHA interstitial to attach a token.
.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;- Specified by:
getRedirectOrBuilderin interfaceFirewallActionOrBuilder
-
hasSubstitute
public boolean hasSubstitute()This action transparently serves a different page to an offending user.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;- Specified by:
hasSubstitutein interfaceFirewallActionOrBuilder- Returns:
- Whether the substitute field is set.
-
getSubstitute
This action transparently serves a different page to an offending user.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;- Specified by:
getSubstitutein interfaceFirewallActionOrBuilder- Returns:
- The substitute.
-
getSubstituteOrBuilder
This action transparently serves a different page to an offending user.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;- Specified by:
getSubstituteOrBuilderin interfaceFirewallActionOrBuilder
-
hasSetHeader
public boolean hasSetHeader()This action sets a custom header but allow the request to continue to the customer backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;- Specified by:
hasSetHeaderin interfaceFirewallActionOrBuilder- Returns:
- Whether the setHeader field is set.
-
getSetHeader
This action sets a custom header but allow the request to continue to the customer backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;- Specified by:
getSetHeaderin interfaceFirewallActionOrBuilder- Returns:
- The setHeader.
-
getSetHeaderOrBuilder
This action sets a custom header but allow the request to continue to the customer backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;- Specified by:
getSetHeaderOrBuilderin interfaceFirewallActionOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static FirewallAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FirewallAction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FirewallAction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FirewallAction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FirewallAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FirewallAction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FirewallAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static FirewallAction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static FirewallAction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static FirewallAction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FirewallAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-