Reference documentation and code samples for the reCAPTCHA Enterprise V1beta1 API class Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest.
The request message to annotate an Assessment.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotation
def annotation() -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation) — 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.
#annotation=
def annotation=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation) — 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
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation) — 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.
#hashed_account_id
def hashed_account_id() -> ::String
Returns
- (::String) — Optional. 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.
#hashed_account_id=
def hashed_account_id=(value) -> ::String
Parameter
- value (::String) — Optional. 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
- (::String) — Optional. 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.
#name
def name() -> ::String
Returns
- (::String) — Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".
Returns
- (::String) — Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".
#reasons
def reasons() -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>
Returns
- (::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>) — Optional. Optional reasons for the annotation that will be assigned to the Event.
#reasons=
def reasons=(value) -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>
Parameter
- value (::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>) — Optional. Optional reasons for the annotation that will be assigned to the Event.
Returns
- (::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>) — Optional. Optional reasons for the annotation that will be assigned to the Event.
#transaction_event
def transaction_event() -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent) — Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.
#transaction_event=
def transaction_event=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent) — Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent) — Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.