l.c.c.CloudStackConnection(ConnectionUserAndKey, PollingConnection) : class documentation

Part of libcloud.common.cloudstack View Source View In Hierarchy

No class docstring
Method add_default_params Adds default parameters (such as API key, version, etc.) to the passed `params`
Method pre_connect_hook A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.
Method get_request_kwargs Arguments which are passed to the initial request() call inside async_request.
Method get_poll_request_kwargs Return keyword arguments which are passed to the request() method when polling for the job status.
Method has_completed Return job completion status.
Method _make_signature Undocumented
Method _async_request Undocumented
Method _sync_request This method handles synchronous calls which are generally fast information retrieval requests and thus return 'quickly'.

Inherited from PollingConnection:

Method async_request No summary

Inherited from Connection (via PollingConnection):

Method __init__ Undocumented
Method set_context Undocumented
Method connect Establish a connection with the API server.
Method user_agent_append Append a token to a user agent string.
Method request Request a given `action`.
Method morph_action_hook Undocumented
Method add_default_headers Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`
Method encode_data Encode body data.
Method _tuple_from_url Undocumented
Method _user_agent Undocumented
def _make_signature(self, params): (source)
Undocumented
def add_default_params(self, params): (source)
Adds default parameters (such as API key, version, etc.)
to the passed `params`

Should return a dictionary.
def pre_connect_hook(self, params, headers): (source)
A hook which is called before connecting to the remote server.
This hook can perform a final manipulation on the params, headers and
url parameters.

@type params: C{dict}
@param params: Request parameters.

@type headers: C{dict}
@param headers: Request headers.
def _async_request(self, command, **kwargs): (source)
Undocumented
def get_request_kwargs(self, action, params=None, data='', headers=None, method='GET', context=None): (source)
Arguments which are passed to the initial request() call inside
async_request.
def get_poll_request_kwargs(self, response, context, request_kwargs): (source)
Return keyword arguments which are passed to the request() method when
polling for the job status.

@param response: Response object returned by poll request.
@type response: C{HTTPResponse}

@param request_kwargs: Kwargs previously used to initiate the
                          poll request.
@type response: C{dict}

@return C{dict} Keyword arguments
def has_completed(self, response): (source)
Return job completion status.

@param response: Response object returned by poll request.
@type response: C{HTTPResponse}

@return C{bool} True if the job has completed, False otherwise.
def _sync_request(self, command, **kwargs): (source)
This method handles synchronous calls which are generally fast
information retrieval requests and thus return 'quickly'.
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.