Class FirewallAction.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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 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.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.GeneratedMessage.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.GeneratedMessage.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
    • 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.GeneratedMessage.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.
    • setAllow

       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;
    • setAllow

       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;
    • mergeAllow

       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;
    • 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;
    • 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;
    • 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.
    • setBlock

       This action denies access to a given page. The user gets an HTTP
       error code.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
    • setBlock

       This action denies access to a given page. The user gets an HTTP
       error code.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
    • mergeBlock

       This action denies access to a given page. The user gets an HTTP
       error code.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
    • clearBlock

      public FirewallAction.Builder clearBlock()
       This action denies access to a given page. The user gets an HTTP
       error code.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
    • getBlockBuilder

      public FirewallAction.BlockAction.Builder getBlockBuilder()
       This action denies access to a given page. The user gets an HTTP
       error code.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
    • 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.
    • setIncludeRecaptchaScript

      public FirewallAction.Builder setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)
       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;
    • setIncludeRecaptchaScript

      public FirewallAction.Builder setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction.Builder builderForValue)
       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;
    • mergeIncludeRecaptchaScript

      public FirewallAction.Builder mergeIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)
       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;
    • clearIncludeRecaptchaScript

      public FirewallAction.Builder clearIncludeRecaptchaScript()
       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;
    • getIncludeRecaptchaScriptBuilder

      public FirewallAction.IncludeRecaptchaScriptAction.Builder getIncludeRecaptchaScriptBuilder()
       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;
    • 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.
    • setRedirect

       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
    • setRedirect

      public FirewallAction.Builder setRedirect(FirewallAction.RedirectAction.Builder builderForValue)
       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
    • mergeRedirect

       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
    • clearRedirect

      public FirewallAction.Builder clearRedirect()
       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
    • getRedirectBuilder

      public FirewallAction.RedirectAction.Builder getRedirectBuilder()
       This action redirects the request to a reCAPTCHA interstitial to
       attach a token.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
    • 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.
    • setSubstitute

       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
    • setSubstitute

      public FirewallAction.Builder setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)
       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
    • mergeSubstitute

       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
    • clearSubstitute

      public FirewallAction.Builder clearSubstitute()
       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
    • getSubstituteBuilder

      public FirewallAction.SubstituteAction.Builder getSubstituteBuilder()
       This action transparently serves a different page to an offending
       user.
       
      .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
    • 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.
    • setSetHeader

       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;
    • setSetHeader

      public FirewallAction.Builder setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)
       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;
    • mergeSetHeader

       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;
    • clearSetHeader

      public FirewallAction.Builder clearSetHeader()
       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;
    • getSetHeaderBuilder

      public FirewallAction.SetHeaderAction.Builder getSetHeaderBuilder()
       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;
    • 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