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:
  • 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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getFirewallActionOneofCase

      public FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()
      Specified by:
      getFirewallActionOneofCase in interface FirewallActionOrBuilder
    • 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.
    • 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;
      Specified by:
      getAllowOrBuilder in interface FirewallActionOrBuilder
    • 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:
      hasBlock in interface FirewallActionOrBuilder
      Returns:
      Whether the block field is set.
    • getBlock

      public FirewallAction.BlockAction 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:
      getBlock in interface FirewallActionOrBuilder
      Returns:
      The block.
    • getBlockOrBuilder

      public FirewallAction.BlockActionOrBuilder 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:
      getBlockOrBuilder in interface FirewallActionOrBuilder
    • 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:
      hasIncludeRecaptchaScript in interface FirewallActionOrBuilder
      Returns:
      Whether the includeRecaptchaScript field is set.
    • getIncludeRecaptchaScript

      public FirewallAction.IncludeRecaptchaScriptAction 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:
      getIncludeRecaptchaScript in interface FirewallActionOrBuilder
      Returns:
      The includeRecaptchaScript.
    • getIncludeRecaptchaScriptOrBuilder

      public FirewallAction.IncludeRecaptchaScriptActionOrBuilder 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:
      getIncludeRecaptchaScriptOrBuilder in interface FirewallActionOrBuilder
    • 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:
      hasRedirect in interface FirewallActionOrBuilder
      Returns:
      Whether the redirect field is set.
    • getRedirect

      public FirewallAction.RedirectAction getRedirect()
       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
      Specified by:
      getRedirect in interface FirewallActionOrBuilder
      Returns:
      The redirect.
    • getRedirectOrBuilder

      public FirewallAction.RedirectActionOrBuilder getRedirectOrBuilder()
       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
      Specified by:
      getRedirectOrBuilder in interface FirewallActionOrBuilder
    • 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:
      hasSubstitute in interface FirewallActionOrBuilder
      Returns:
      Whether the substitute field is set.
    • getSubstitute

      public FirewallAction.SubstituteAction getSubstitute()
       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
      Specified by:
      getSubstitute in interface FirewallActionOrBuilder
      Returns:
      The substitute.
    • getSubstituteOrBuilder

      public FirewallAction.SubstituteActionOrBuilder getSubstituteOrBuilder()
       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
      Specified by:
      getSubstituteOrBuilder in interface FirewallActionOrBuilder
    • 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:
      hasSetHeader in interface FirewallActionOrBuilder
      Returns:
      Whether the setHeader field is set.
    • getSetHeader

      public FirewallAction.SetHeaderAction 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:
      getSetHeader in interface FirewallActionOrBuilder
      Returns:
      The setHeader.
    • getSetHeaderOrBuilder

      public FirewallAction.SetHeaderActionOrBuilder 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:
      getSetHeaderOrBuilder in interface FirewallActionOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static FirewallAction parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FirewallAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static FirewallAction parseDelimitedFrom(InputStream input) throws IOException
      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

      public FirewallAction.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static FirewallAction.Builder newBuilder()
    • newBuilder

      public static FirewallAction.Builder newBuilder(FirewallAction prototype)
    • toBuilder

      public FirewallAction.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected FirewallAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static FirewallAction getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<FirewallAction> parser()
    • getParserForType

      public com.google.protobuf.Parser<FirewallAction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public FirewallAction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder