Package Classes (0.5.12)

Summary of entries of Classes for apikeys.

Classes

ApiKeysAsyncClient

Manages the API keys associated with projects.

ApiKeysClient

Manages the API keys associated with projects.

ListKeysAsyncPager

A pager for iterating through list_keys requests.

This class thinly wraps an initial ListKeysResponse object, and provides an __aiter__ method to iterate through its keys field.

If there are more pages, the __aiter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListKeysPager

A pager for iterating through list_keys requests.

This class thinly wraps an initial ListKeysResponse object, and provides an __iter__ method to iterate through its keys field.

If there are more pages, the __iter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AndroidApplication

Identifier of an Android application for key use.

AndroidKeyRestrictions

The Android apps that are allowed to use the key.

ApiTarget

A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.

BrowserKeyRestrictions

The HTTP referrers (websites) that are allowed to use the key.

CreateKeyRequest

Request message for CreateKey method.

DeleteKeyRequest

Request message for DeleteKey method.

GetKeyRequest

Request message for GetKey method.

GetKeyStringRequest

Request message for GetKeyString method.

GetKeyStringResponse

Response message for GetKeyString method.

IosKeyRestrictions

The iOS apps that are allowed to use the key.

Key

The representation of a key managed by the API Keys API.

AnnotationsEntry

The abstract base class for a message.

ListKeysRequest

Request message for ListKeys method.

ListKeysResponse

Response message for ListKeys method.

LookupKeyRequest

Request message for LookupKey method.

LookupKeyResponse

Response message for LookupKey method.

Restrictions

Describes the restrictions on the key.

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

ServerKeyRestrictions

The IP addresses of callers that are allowed to use the key.

UndeleteKeyRequest

Request message for UndeleteKey method.

UpdateKeyRequest

Request message for UpdateKey method.

Modules

pagers

API documentation for api_keys_v2.services.api_keys.pagers module.