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

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

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ event
Google\Cloud\RecaptchaEnterprise\V1\Event

Optional. 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

Optional. 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

Output only. Assessment returned by account defender when an account identifier is provided.

↳ private_password_leak_verification
Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification

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

↳ firewall_policy_assessment
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicyAssessment

Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation.

↳ fraud_prevention_assessment
Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment

Output only. Assessment returned by Fraud Prevention when TransactionData is provided.

↳ fraud_signals
Google\Cloud\RecaptchaEnterprise\V1\FraudSignals

Output only. Fraud Signals specific to the users involved in a payment transaction.

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEvent

Optional. The event being assessed.

Returns
Type
Description

hasEvent

clearEvent

setEvent

Optional. The event being assessed.

Parameter
Name
Description
Returns
Type
Description
$this

getRiskAnalysis

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

Returns
Type
Description

hasRiskAnalysis

clearRiskAnalysis

setRiskAnalysis

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

Parameter
Name
Description
Returns
Type
Description
$this

getTokenProperties

Output only. Properties of the provided event token.

hasTokenProperties

clearTokenProperties

setTokenProperties

Output only. Properties of the provided event token.

Returns
Type
Description
$this

getAccountVerification

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

hasAccountVerification

clearAccountVerification

setAccountVerification

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

Returns
Type
Description
$this

getAccountDefenderAssessment

Output only. Assessment returned by account defender when an account identifier is provided.

hasAccountDefenderAssessment

clearAccountDefenderAssessment

setAccountDefenderAssessment

Output only. Assessment returned by account defender when an account identifier is provided.

Returns
Type
Description
$this

getPrivatePasswordLeakVerification

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

hasPrivatePasswordLeakVerification

clearPrivatePasswordLeakVerification

setPrivatePasswordLeakVerification

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

Returns
Type
Description
$this

getFirewallPolicyAssessment

Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation.

hasFirewallPolicyAssessment

clearFirewallPolicyAssessment

setFirewallPolicyAssessment

Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation.

Returns
Type
Description
$this

getFraudPreventionAssessment

Output only. Assessment returned by Fraud Prevention when TransactionData is provided.

hasFraudPreventionAssessment

clearFraudPreventionAssessment

setFraudPreventionAssessment

Output only. Assessment returned by Fraud Prevention when TransactionData is provided.

Returns
Type
Description
$this

getFraudSignals

Output only. Fraud Signals specific to the users involved in a payment transaction.

Returns
Type
Description

hasFraudSignals

clearFraudSignals

setFraudSignals

Output only. Fraud Signals specific to the users involved in a payment transaction.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: