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.



155
156
157
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 155

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

Instance Attribute Details

#account_idString

Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request. Corresponds to the JSON property accountId

Returns:

  • (String)


127
128
129
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 127

def 
  @account_id
end

#annotationString

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)


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

def annotation
  @annotation
end

#hashed_account_idString

Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request. Corresponds to the JSON property hashedAccountId NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


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

def 
  @hashed_account_id
end

#reasonsArray<String>

Optional. Reasons for the annotation that are assigned to the event. Corresponds to the JSON property reasons

Returns:

  • (Array<String>)


148
149
150
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 148

def reasons
  @reasons
end

#transaction_eventGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionEvent

Describes an event in the lifecycle of a payment transaction. Corresponds to the JSON property transactionEvent



153
154
155
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 153

def transaction_event
  @transaction_event
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



160
161
162
163
164
165
166
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 160

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @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)
  @transaction_event = args[:transaction_event] if args.key?(:transaction_event)
end