Google Cloud Recaptcha Enterprise V1 Client - Class AnnotateAssessmentRequest (1.5.2)

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

The request message to annotate an Assessment.

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

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

↳ annotation int

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

↳ reasons array

Optional. Optional reasons for the annotation that will be assigned to the Event.

↳ hashed_account_id string

Optional. Unique stable hashed user identifier to apply to the assessment. This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.

↳ transaction_event Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

getName

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Returns
TypeDescription
string

setName

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAnnotation

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Returns
TypeDescription
int

setAnnotation

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getReasons

Optional. Optional reasons for the annotation that will be assigned to the Event.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setReasons

Optional. Optional reasons for the annotation that will be assigned to the Event.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getHashedAccountId

Optional. Unique stable hashed user identifier to apply to the assessment.

This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.

Returns
TypeDescription
string

setHashedAccountId

Optional. Unique stable hashed user identifier to apply to the assessment.

This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTransactionEvent

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

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

hasTransactionEvent

clearTransactionEvent

setTransactionEvent

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

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

static::build

Parameters
NameDescription
name string

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}. Please see Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient::assessmentName() for help formatting this field.

annotation int

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. For allowed values, use constants defined on Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest