Class Key (1.25.0)

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

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
display_name str
Required. Human-readable display name of this key. Modifiable by user.
web_settings google.cloud.recaptchaenterprise_v1.types.WebKeySettings
Settings for keys that can be used by websites. This field is a member of oneof_ platform_settings.
android_settings google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings
Settings for keys that can be used by Android apps. This field is a member of oneof_ platform_settings.
ios_settings google.cloud.recaptchaenterprise_v1.types.IOSKeySettings
Settings for keys that can be used by iOS apps. This field is a member of oneof_ platform_settings.
express_settings google.cloud.recaptchaenterprise_v1.types.ExpressKeySettings
Settings for keys that can be used by reCAPTCHA Express. This field is a member of oneof_ platform_settings.
labels MutableMapping[str, str]
Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp corresponding to the creation of this key.
testing_options google.cloud.recaptchaenterprise_v1.types.TestingOptions
Optional. Options for user acceptance testing.
waf_settings google.cloud.recaptchaenterprise_v1.types.WafSettings
Optional. Settings for WAF

Classes

LabelsEntry

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

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.