PHPFUI/InstaDoc

Risk analysis result for an event.

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type float $score
      Output only. Legitimate event score from 0.0 to 1.0.
      (1.0 means very likely legitimate traffic while 0.0 means very likely
      non-legitimate traffic).
@type array<int>|\Google\Protobuf\Internal\RepeatedField $reasons
      Output only. Reasons contributing to the risk analysis verdict.
@type array<string>|\Google\Protobuf\Internal\RepeatedField $extended_verdict_reasons
      Output only. Extended verdict reasons to be used for experimentation only.
      The set of possible reasons is subject to change.
@type int $challenge
      Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE
      keys.
@type array<\Google\Cloud\RecaptchaEnterprise\V1\Bot>|\Google\Protobuf\Internal\RepeatedField $verified_bots
      Output only. Bots with identities that have been verified by reCAPTCHA and
      detected in the event.

}

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 getChallenge()

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.RiskAnalysis.Challenge challenge = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

return int

public getExtendedVerdictReasons()

Output only. Extended verdict reasons to be used for experimentation only.

The set of possible reasons is subject to change.

Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

return \Google\Protobuf\Internal\RepeatedField

public getReasons()

Output only. Reasons contributing to the risk analysis verdict.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

return \Google\Protobuf\Internal\RepeatedField

public getScore()

Output only. Legitimate event score from 0.0 to 1.0.

(1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

return float

public getVerifiedBots()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

return \Google\Protobuf\Internal\RepeatedField

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 setChallenge( $var)

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.RiskAnalysis.Challenge challenge = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

param int $var
return $this

public setExtendedVerdictReasons( $var)

Output only. Extended verdict reasons to be used for experimentation only.

The set of possible reasons is subject to change.

Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

param string[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setReasons( $var)

Output only. Reasons contributing to the risk analysis verdict.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

param int[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setScore( $var)

Output only. Legitimate event score from 0.0 to 1.0.

(1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

param float $var
return $this

public setVerifiedBots( $var)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

param \Google\Cloud\RecaptchaEnterprise\V1\Bot[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

Properties

protected $challenge = 0

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.RiskAnalysis.Challenge challenge = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $score = 0

Output only. Legitimate event score from 0.0 to 1.0.

(1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

Generated from protobuf field float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 $extended_verdict_reasons = NULL

Output only. Extended verdict reasons to be used for experimentation only.

The set of possible reasons is subject to change.

Generated from protobuf field repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

private $reasons = NULL

Output only. Reasons contributing to the risk analysis verdict.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

private $verified_bots = NULL

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];