Google Cloud Recaptcha Enterprise V1 Client - Class Assessment (1.3.2)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class Assessment.

A reCAPTCHA Enterprise assessment resource.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".

↳ event Google\Cloud\RecaptchaEnterprise\V1\Event

The event being assessed.

↳ risk_analysis Google\Cloud\RecaptchaEnterprise\V1\RiskAnalysis

Output only. The risk analysis result for the event being assessed.

↳ token_properties Google\Cloud\RecaptchaEnterprise\V1\TokenProperties

Output only. Properties of the provided event token.

↳ account_verification Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo

Account verification information for identity verification. The assessment event must include a token and site key to use this feature.

↳ account_defender_assessment Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment

Assessment returned by account defender when a hashed_account_id is provided.

↳ private_password_leak_verification Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification

The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.

↳ fraud_prevention_assessment Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment

Assessment returned by Fraud Prevention when TransactionData is provided.

getName

Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".

Returns
TypeDescription
string

setName

Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEvent

The event being assessed.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Event|null

hasEvent

clearEvent

setEvent

The event being assessed.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\Event
Returns
TypeDescription
$this

getRiskAnalysis

Output only. The risk analysis result for the event being assessed.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\RiskAnalysis|null

hasRiskAnalysis

clearRiskAnalysis

setRiskAnalysis

Output only. The risk analysis result for the event being assessed.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\RiskAnalysis
Returns
TypeDescription
$this

getTokenProperties

Output only. Properties of the provided event token.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\TokenProperties|null

hasTokenProperties

clearTokenProperties

setTokenProperties

Output only. Properties of the provided event token.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\TokenProperties
Returns
TypeDescription
$this

getAccountVerification

Account verification information for identity verification. The assessment event must include a token and site key to use this feature.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo|null

hasAccountVerification

clearAccountVerification

setAccountVerification

Account verification information for identity verification. The assessment event must include a token and site key to use this feature.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\AccountVerificationInfo
Returns
TypeDescription
$this

getAccountDefenderAssessment

Assessment returned by account defender when a hashed_account_id is provided.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment|null

hasAccountDefenderAssessment

clearAccountDefenderAssessment

setAccountDefenderAssessment

Assessment returned by account defender when a hashed_account_id is provided.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\AccountDefenderAssessment
Returns
TypeDescription
$this

getPrivatePasswordLeakVerification

The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification|null

hasPrivatePasswordLeakVerification

clearPrivatePasswordLeakVerification

setPrivatePasswordLeakVerification

The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification
Returns
TypeDescription
$this

getFraudPreventionAssessment

Assessment returned by Fraud Prevention when TransactionData is provided.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment|null

hasFraudPreventionAssessment

clearFraudPreventionAssessment

setFraudPreventionAssessment

Assessment returned by Fraud Prevention when TransactionData is provided.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment
Returns
TypeDescription
$this