Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recaptchaenterprise_v1/classes.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb

Overview

The request message to annotate an Assessment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest

Returns a new instance of GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.



137
138
139
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 137

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotation ⇒ String

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. Corresponds to the JSON property annotation

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 119

def annotation
  @annotation
end

#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. Corresponds to the JSON property hashedAccountId NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


129
130
131
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 129

def 
  @hashed_account_id
end

#reasons ⇒ Array<String>

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

Returns:

  • (Array<String>) 


135
136
137
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 135

def reasons
  @reasons
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



142
143
144
145
146
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 142

def update!(**args)
  @annotation = args[:annotation] if args.key?(:annotation)
  @hashed_account_id = args[:hashed_account_id] if args.key?(:hashed_account_id)
  @reasons = args[:reasons] if args.key?(:reasons)
end