Class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaConfig

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 ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned App Check token, such as its ttl.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirebaseAppcheckV1betaRecaptchaConfig

Returns a new instance of GoogleFirebaseAppcheckV1betaRecaptchaConfig.



963
964
965
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 963

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`/recaptchaConfig Corresponds to the JSON property name

Returns:

  • (String) 


939
940
941
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 939

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) 


946
947
948
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 946

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) 


953
954
955
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 953

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) 


961
962
963
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 961

def token_ttl
  @token_ttl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



968
969
970
971
972
973
 
# File 'lib/google/apis/firebaseappcheck_v1beta/classes.rb', line 968

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