PHPFUI/InstaDoc
 
Copied!

Metrics related to challenges.

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type int|string $pageload_count
      Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent
      to a count of pageloads for pages that include reCAPTCHA.
@type int|string $nocaptcha_count
      Count of nocaptchas (successful verification without a challenge) issued.
@type int|string $failed_count
      Count of submitted challenge solutions that were incorrect or otherwise
      deemed suspicious such that a subsequent challenge was triggered.
@type int|string $passed_count
      Count of nocaptchas (successful verification without a challenge) plus
      submitted challenge solutions that were correct and resulted in
      verification.
    }
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 getFailedCount()
 

Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.

Generated from protobuf field int64 failed_count = 3;

  • return int|string
public getNocaptchaCount()
 

Count of nocaptchas (successful verification without a challenge) issued.

Generated from protobuf field int64 nocaptcha_count = 2;

  • return int|string
public getPageloadCount()
 

Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.

Generated from protobuf field int64 pageload_count = 1;

  • return int|string
public getPassedCount()
 

Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.

Generated from protobuf field int64 passed_count = 4;

  • return int|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 setFailedCount( $var)
 

Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.

Generated from protobuf field int64 failed_count = 3;

  • param int|string $var
  • return $this
public setNocaptchaCount( $var)
 

Count of nocaptchas (successful verification without a challenge) issued.

Generated from protobuf field int64 nocaptcha_count = 2;

  • param int|string $var
  • return $this
public setPageloadCount( $var)
 

Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.

Generated from protobuf field int64 pageload_count = 1;

  • param int|string $var
  • return $this
public setPassedCount( $var)
 

Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.

Generated from protobuf field int64 passed_count = 4;

  • param int|string $var
  • return $this
Properties
protected $failed_count = 0
 

Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.

Generated from protobuf field int64 failed_count = 3;

protected $nocaptcha_count = 0
 

Count of nocaptchas (successful verification without a challenge) issued.

Generated from protobuf field int64 nocaptcha_count = 2;

protected $pageload_count = 0
 

Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.

Generated from protobuf field int64 pageload_count = 1;

protected $passed_count = 0
 

Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.

Generated from protobuf field int64 passed_count = 4;

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)
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration