Class WebKeySettings (0.2.1)

WebKeySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to keys that can be used by websites.

Attributes

NameDescription
allow_all_domains bool
If set to true, it means allowed_domains will not be enforced.
allowed_domains Sequence[str]
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
allow_amp_traffic bool
Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
integration_type .recaptchaenterprise.WebKeySettings.IntegrationType
Required. Describes how this key is integrated with the website.
challenge_security_preference .recaptchaenterprise.WebKeySettings.ChallengeSecurityPreference
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

Classes

ChallengeSecurityPreference

ChallengeSecurityPreference(value)

Enum that represents the possible challenge frequency and difficulty configurations for a web key.

IntegrationType

IntegrationType(value)

Enum that represents the integration types for web keys.

Methods

__delattr__

__delattr__(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

__eq__

__eq__(other)

Return True if the messages are equal, False otherwise.

__ne__

__ne__(other)

Return True if the messages are unequal, False otherwise.

__setattr__

__setattr__(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.