Class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config

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

Overview

An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned AppCheckToken, such as its ttl.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirebaseAppcheckV1betaRecaptchaV3Config

Returns a new instance of GoogleFirebaseAppcheckV1betaRecaptchaV3Config.



1214
1215
1216
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1214

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

Instance Attribute Details

#name ⇒ String

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: `projects/`project_number`/apps/`app_id`/recaptchaV3Config Corresponds to the JSON propertyname`

Returns:

  • (String) 


1190
1191
1192
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1190

def name
  @name
end

#site_secret ⇒ String

Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. Corresponds to the JSON property siteSecret

Returns:

  • (String) 


1197
1198
1199
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1197

def site_secret
  @site_secret
end

#site_secret_set ⇒ Boolean Also known as: site_secret_set?

Output only. Whether the site_secret field was previously set. Since we will never return the site_secret field, this field is the only way to find out whether it was previously set. Corresponds to the JSON property siteSecretSet

Returns:

  • (Boolean) 


1204
1205
1206
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1204

def site_secret_set
  @site_secret_set
end

#token_ttl ⇒ String

Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive. Corresponds to the JSON property tokenTtl

Returns:

  • (String) 


1212
1213
1214
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1212

def token_ttl
  @token_ttl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1219
1220
1221
1222
1223
1224
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 1219

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @site_secret = args[:site_secret] if args.key?(:site_secret)
  @site_secret_set = args[:site_secret_set] if args.key?(:site_secret_set)
  @token_ttl = args[:token_ttl] if args.key?(:token_ttl)
end