Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest.
The request message to annotate an Assessment.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#account_id
def account_id() -> ::String
Returns
-
(::String) — Optional. A stable account identifier to apply to the assessment. This is
an alternative to setting
account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
#account_id=
def account_id=(value) -> ::String
Parameter
-
value (::String) — Optional. A stable account identifier to apply to the assessment. This is
an alternative to setting
account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
Returns
-
(::String) — Optional. A stable account identifier to apply to the assessment. This is
an alternative to setting
account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
#annotation
def annotation() -> ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation) — Optional. The annotation that is 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::V1::AnnotateAssessmentRequest::Annotation
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation) — Optional. The annotation that is 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::V1::AnnotateAssessmentRequest::Annotation) — Optional. The annotation that is 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. A stable hashed account identifier to apply to the assessment.
This is an alternative to setting
hashed_account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
#hashed_account_id=
def hashed_account_id=(value) -> ::String
Parameter
-
value (::String) — Optional. A stable hashed account identifier to apply to the assessment.
This is an alternative to setting
hashed_account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
Returns
-
(::String) — Optional. A stable hashed account identifier to apply to the assessment.
This is an alternative to setting
hashed_account_idinCreateAssessment, for example when a stable account identifier is not yet known in the initial request.
#name
def name() -> ::String
Returns
-
(::String) — Required. The resource name of the Assessment, in the format
projects/{project}/assessments/{assessment}.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. The resource name of the Assessment, in the format
projects/{project}/assessments/{assessment}.
Returns
-
(::String) — Required. The resource name of the Assessment, in the format
projects/{project}/assessments/{assessment}.
#reasons
def reasons() -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>
Returns
- (::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>) — Optional. Reasons for the annotation that are assigned to the event.
#reasons=
def reasons=(value) -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>
Parameter
- value (::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>) — Optional. Reasons for the annotation that are assigned to the event.
Returns
- (::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>) — Optional. Reasons for the annotation that are assigned to the event.
#transaction_event
def transaction_event() -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent
Returns
- (::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.
#transaction_event=
def transaction_event=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent
Parameter
- value (::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.
Returns
- (::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.