PHPFUI/InstaDoc
 
Copied!

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

Generated from protobuf message google.cloud.recaptchaenterprise.v1.FirewallAction

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction $allow
      The user request did not match any policy and should be allowed
      access to the requested resource.
@type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction $block
      This action denies access to a given page. The user gets an HTTP
      error code.
@type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction $include_recaptcha_script
      This action injects reCAPTCHA JavaScript code into the HTML page
      returned by the site backend.
@type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction $redirect
      This action redirects the request to a reCAPTCHA interstitial to
      attach a token.
@type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction $substitute
      This action transparently serves a different page to an offending
      user.
@type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction $set_header
      This action sets a custom header but allow the request to continue
      to the customer backend.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAllow()
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction|null
public getBlock()
 

This action denies access to a given page. The user gets an HTTP error code.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction|null
public getFirewallActionOneof()
 
  • return string
public getIncludeRecaptchaScript()
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction|null
public getRedirect()
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction|null
public getSetHeader()
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction|null
public getSubstitute()
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;

  • return \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction|null
public hasAllow()
public hasBlock()
public hasIncludeRecaptchaScript()
public hasRedirect()
public hasSetHeader()
public hasSubstitute()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setAllow( $var)
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction $var
  • return $this
public setBlock( $var)
 

This action denies access to a given page. The user gets an HTTP error code.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction $var
  • return $this
public setIncludeRecaptchaScript( $var)
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction $var
  • return $this
public setRedirect( $var)
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction $var
  • return $this
public setSetHeader( $var)
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction $var
  • return $this
public setSubstitute( $var)
 

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction $var
  • return $this
Properties
protected $firewall_action_oneof = NULL
Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration