Class: Google::Cloud::RecaptchaEnterprise::V1::FirewallAction

Inherits:

Object

• Object
• Google::Cloud::RecaptchaEnterprise::V1::FirewallAction

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

Overview

An individual action. Each action represents what to do if a policy matches.

Defined Under Namespace

Classes: AllowAction, BlockAction, IncludeRecaptchaScriptAction, RedirectAction, SetHeaderAction, SubstituteAction

Instance Attribute Summary

• #allow ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction

  The user request did not match any policy and should be allowed access to the requested resource.

• #block ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction

  This action denies access to a given page.

• #include_recaptcha_script ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction

  This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.

• #redirect ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction

  This action redirects the request to a reCAPTCHA interstitial to attach a token.

• #set_header ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction

  This action sets a custom header but allow the request to continue to the customer backend.

• #substitute ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction

  This action transparently serves a different page to an offending user.

Instance Attribute Details

#allow ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#block ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#include_recaptcha_script ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::IncludeRecaptchaScriptAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redirect ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#set_header ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#substitute ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1616

class FirewallAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An allow action continues processing a request unimpeded.
  class AllowAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A block action serves an HTTP error code a prevents the request from
  # hitting the backend.
  class BlockAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript
  # code into the HTML returned by the site backend. This reCAPTCHA
  # script is tasked with collecting user signals on the requested web page,
  # issuing tokens as a cookie within the site domain, and enabling their
  # utilization in subsequent page requests.
  class IncludeRecaptchaScriptAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A redirect action returns a 307 (temporary redirect) response, pointing
  # the user to a reCAPTCHA interstitial page to attach a token.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A substitute action transparently serves a different page than the one
  # requested.
  # @!attribute [rw] path
  #   @return [::String]
  #     Optional. The address to redirect to. The target is a relative path in
  #     the current host. Example: "/blog/404.html".
  class SubstituteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A set header action sets a header and forwards the request to the
  # backend. This can be used to trigger custom protection implemented on the
  # backend.
  # @!attribute [rw] key
  #   @return [::String]
  #     Optional. The header key to set in the request to the backend server.
  # @!attribute [rw] value
  #   @return [::String]
  #     Optional. The header value to set in the request to the backend server.
  class SetHeaderAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end