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, RedirectAction, SetHeaderAction, SubstituteAction
Instance Attribute Summary collapse
-
#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 will deny access to a given page.
-
#redirect ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction
This action will redirect the request to a ReCaptcha interstitial to attach a token.
-
#set_header ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction
This action will set a custom header but allow the request to continue to the customer backend.
-
#substitute ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction
This action will transparently serve a different page to an offending user.
Instance Attribute Details
#allow ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction
Returns The user request did not match any policy and should be allowed access to the requested resource.
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1494 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 # 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
Returns This action will deny access to a given page. The user will get an HTTP error code.
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1494 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 # 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
Returns This action will redirect the request to a ReCaptcha interstitial to attach a token.
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1494 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 # 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
Returns This action will set a custom header but allow the request to continue to the customer backend.
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1494 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 # 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
Returns This action will transparently serve a different page to an offending user.
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1494 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 # 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 |