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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReasons
Optional. Optional reasons for the annotation that will be assigned to the Event.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReasons
Optional. Optional reasons for the annotation that will be assigned to the Event.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransactionEvent
Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest |
|