Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::FirewallAction.
An individual action. Each action represents what to do if a policy matches.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow
def allow() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction) — The user request did not match any policy and should be allowed access to the requested resource.
#allow=
def allow=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction) — The user request did not match any policy and should be allowed access to the requested resource.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction) — The user request did not match any policy and should be allowed access to the requested resource.
#block
def block() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction) — This action denies access to a given page. The user gets an HTTP error code.
#block=
def block=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction) — This action denies access to a given page. The user gets an HTTP error code.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction) — This action denies access to a given page. The user gets an HTTP error code.
#include_recaptcha_script
def include_recaptcha_script() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction) — This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
#include_recaptcha_script=
def include_recaptcha_script=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction) — This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction) — This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
#redirect
def redirect() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction) — This action redirects the request to a reCAPTCHA interstitial to attach a token.
#redirect=
def redirect=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction) — This action redirects the request to a reCAPTCHA interstitial to attach a token.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction) — This action redirects the request to a reCAPTCHA interstitial to attach a token.
#set_header
def set_header() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction) — This action sets a custom header but allow the request to continue to the customer backend.
#set_header=
def set_header=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction) — This action sets a custom header but allow the request to continue to the customer backend.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction) — This action sets a custom header but allow the request to continue to the customer backend.
#substitute
def substitute() -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction) — This action transparently serves a different page to an offending user.
#substitute=
def substitute=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction) — This action transparently serves a different page to an offending user.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction) — This action transparently serves a different page to an offending user.