PHPFUI/InstaDoc
 
Copied!

A FirewallPolicy represents a single matching pattern and resulting actions to take.

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
      Identifier. The resource name for the FirewallPolicy in the format
      `projects/{project}/firewallpolicies/{firewallpolicy}`.
@type string $description
      Optional. A description of what this policy aims to achieve, for
      convenience purposes. The description can at most include 256 UTF-8
      characters.
@type string $path
      Optional. The path for which this policy applies, specified as a glob
      pattern. For more information on glob, see the [manual
      page](https://man7.org/linux/man-pages/man7/glob.7.html).
      A path has a max length of 200 characters.
@type string $condition
      Optional. A CEL (Common Expression Language) conditional expression that
      specifies if this policy applies to an incoming user request. If this
      condition evaluates to true and the requested path matched the path
      pattern, the associated actions should be executed by the caller. The
      condition string is checked for CEL syntax correctness on creation. For
      more information, see the [CEL spec](https://github.com/google/cel-spec)
      and its [language
      definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
      A condition has a max length of 500 characters.
@type array<\Google\Cloud\RecaptchaEnterprise\V1\FirewallAction>|\Google\Protobuf\Internal\RepeatedField $actions
      Optional. The actions that the caller should take regarding user access.
      There should be at most one terminal action. A terminal action is any
      action that forces a response, such as `AllowAction`,
      `BlockAction` or `SubstituteAction`.
      Zero or more non-terminal actions such as `SetHeader` might be
      specified. A single policy can contain up to 16 actions.
    }
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 getActions()
 

Optional. The actions that the caller should take regarding user access.

There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

  • return \Google\Protobuf\Internal\RepeatedField
public getCondition()
 

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition.

A condition has a max length of 500 characters.

Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getDescription()
 

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getName()
 

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

  • return string
public getPath()
 

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page.

A path has a max length of 200 characters.

Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL];

  • return string
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 setActions( $var)
 

Optional. The actions that the caller should take regarding user access.

There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

  • param \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setCondition( $var)
 

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition.

A condition has a max length of 500 characters.

Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setDescription( $var)
 

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setName( $var)
 

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

  • param string $var
  • return $this
public setPath( $var)
 

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page.

A path has a max length of 200 characters.

Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
Properties
protected $condition = ''
 

Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition.

A condition has a max length of 500 characters.

Generated from protobuf field string condition = 5 [(.google.api.field_behavior) = OPTIONAL];

protected $description = ''
 

Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $name = ''
 

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

protected $path = ''
 

Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page.

A path has a max length of 200 characters.

Generated from protobuf field string path = 4 [(.google.api.field_behavior) = OPTIONAL];

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)
Properties
private $actions = NULL
 

Optional. The actions that the caller should take regarding user access.

There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration