Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Event

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 event being assessed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1Event

Returns a new instance of GoogleCloudRecaptchaenterpriseV1Event.



443
444
445
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 443

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

Instance Attribute Details

#expected_action ⇒ String

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. Corresponds to the JSON property expectedAction

Returns:

  • (String) 


366
367
368
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 366

def expected_action
  @expected_action
end

#express ⇒ Boolean Also known as: express?

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference a SCORE key with WAF feature set to EXPRESS. Corresponds to the JSON property express

Returns:

  • (Boolean) 


373
374
375
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 373

def express
  @express
end

#firewall_policy_evaluation ⇒ Boolean Also known as: firewall_policy_evaluation?

Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. Corresponds to the JSON property firewallPolicyEvaluation

Returns:

  • (Boolean) 


381
382
383
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 381

def firewall_policy_evaluation
  @firewall_policy_evaluation
end

#hashed_account_id ⇒ String

Optional. Unique stable hashed user identifier for the request. The identifier must be 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) 


389
390
391
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 389

def 
  @hashed_account_id
end

#headers ⇒ Array<String>

Optional. HTTP header information about the request. Corresponds to the JSON property headers

Returns:

  • (Array<String>) 


394
395
396
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 394

def headers
  @headers
end

#ja3 ⇒ String

Optional. Optional JA3 fingerprint for SSL clients. Corresponds to the JSON property ja3

Returns:

  • (String) 


399
400
401
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 399

def ja3
  @ja3
end

#requested_uri ⇒ String

Optional. The URI resource the user requested that triggered an assessment. Corresponds to the JSON property requestedUri

Returns:

  • (String) 


404
405
406
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 404

def requested_uri
  @requested_uri
end

#site_key ⇒ String

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token. Corresponds to the JSON property siteKey

Returns:

  • (String) 


410
411
412
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 410

def site_key
  @site_key
end

#token ⇒ String

Optional. The user response token provided by the reCAPTCHA Enterprise client- side integration on your site. Corresponds to the JSON property token

Returns:

  • (String) 


416
417
418
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 416

def token
  @token
end

#transaction_data ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionData

Transaction data associated with a payment protected by reCAPTCHA Enterprise. All fields are optional. Corresponds to the JSON property transactionData

Returns:



422
423
424
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 422

def transaction_data
  @transaction_data
end

#user_agent ⇒ String

Optional. The user agent present in the request from the user's device related to this event. Corresponds to the JSON property userAgent

Returns:

  • (String) 


428
429
430
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 428

def user_agent
  @user_agent
end

#user_ip_address ⇒ String

Optional. The IP address in the request from the user's device related to this event. Corresponds to the JSON property userIpAddress

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 434

def user_ip_address
  @user_ip_address
end

#waf_token_assessment ⇒ Boolean Also known as: waf_token_assessment?

Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key. Corresponds to the JSON property wafTokenAssessment

Returns:

  • (Boolean) 


440
441
442
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 440

def waf_token_assessment
  @waf_token_assessment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 448

def update!(**args)
  @expected_action = args[:expected_action] if args.key?(:expected_action)
  @express = args[:express] if args.key?(:express)
  @firewall_policy_evaluation = args[:firewall_policy_evaluation] if args.key?(:firewall_policy_evaluation)
  @hashed_account_id = args[:hashed_account_id] if args.key?(:hashed_account_id)
  @headers = args[:headers] if args.key?(:headers)
  @ja3 = args[:ja3] if args.key?(:ja3)
  @requested_uri = args[:requested_uri] if args.key?(:requested_uri)
  @site_key = args[:site_key] if args.key?(:site_key)
  @token = args[:token] if args.key?(:token)
  @transaction_data = args[:transaction_data] if args.key?(:transaction_data)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
  @user_ip_address = args[:user_ip_address] if args.key?(:user_ip_address)
  @waf_token_assessment = args[:waf_token_assessment] if args.key?(:waf_token_assessment)
end