google.appengine.api.capabilities.CapabilitySet

Encapsulates one or more capabilities.

Inherits From: expected_type

google.appengine.api.capabilities.CapabilitySet(
    package,
    capabilities=None,
    methods=None,
    stub_map=google.appengine.api.apiproxy_stub_map
)

Capabilities can either be named explicitly, or inferred from the list of methods provided. If no capabilities or methods are provided, this will check whether the entire package is enabled.

capabilities List of strings
methods List of strings

Methods

admin_message

View source

admin_message()

Retrieves any administrator notice messages for these capabilities.

Returns
A string containing one or more administrator messages, or an empty string.

Raises
UnknownCapabilityError If a specified capability was not recognized.

is_enabled

View source

is_enabled()

Tests whether the capabilities are currently enabled.

Returns
True if API calls that require these capabilities will succeed.

Raises
UnknownCapabilityError If a specified capability was not recognized.

will_remain_enabled_for

View source

will_remain_enabled_for(
    time=60
)

Returns whether a capability will remain enabled.

DEPRECATED: Use is_enabled() instead. This method was never fully implemented.

Args
time Number of seconds in the future to look when checking for scheduled downtime.

Returns
True if there is no scheduled downtime for the specified capability within the amount of time specified.

Raises
UnknownCapabilityError If a specified capability was not recognized.