App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.api.capabilities.CapabilitySet Class Reference
Inheritance diagram for google.appengine.api.capabilities.CapabilitySet:

Public Member Functions

def __init__
 
def is_enabled
 
def will_remain_enabled_for
 
def admin_message
 

Detailed Description

Encapsulates one or more capabilities.

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.

Constructor & Destructor Documentation

def google.appengine.api.capabilities.CapabilitySet.__init__ (   self,
  package,
  capabilities = None,
  methods = None,
  stub_map = apiproxy_stub_map 
)
Constructor.

Args:
  capabilities: list of strings
  methods: list of strings

Member Function Documentation

def google.appengine.api.capabilities.CapabilitySet.admin_message (   self)
Get any administrator notice messages for these capabilities.

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

Raises:
  UnknownCapabilityError, if a specified capability was not recognized.
def google.appengine.api.capabilities.CapabilitySet.is_enabled (   self)
Tests whether the capabilities is currently enabled.

Returns:
  True if API calls that require these capabillities will succeed.

Raises:
  UnknownCapabilityError, if a specified capability was not recognized.
def google.appengine.api.capabilities.CapabilitySet.will_remain_enabled_for (   self,
  time = 60 
)
Returns true if it will remain enabled for the specified amount of time.

DEPRECATED: this method was never fully implemented and is
considered deprecated.  Use is_enabled() instead.

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.

The documentation for this class was generated from the following file: