l.l.d.r.RackspaceConnection(OpenStackBaseConnection, PollingConnection) : class documentation

Part of libcloud.loadbalancer.drivers.rackspace View Source View In Hierarchy

Known subclasses: libcloud.loadbalancer.drivers.rackspace.RackspaceUKConnection

No class docstring
Method __init__ Undocumented
Method request Request a given `action`.
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 get_endpoint FIXME: Dirty, dirty hack. Loadbalancers so not show up in the auth 1.1 service catalog, so we build it from the servers url.
Method _construct_loadbalancer_endpoint_from_servers_endpoint Undocumented

Inherited from OpenStackBaseConnection:

Method add_default_headers Undocumented
Method morph_action_hook Undocumented
Method _populate_hosts_and_request_paths OpenStack uses a separate host for API calls which is only provided after an initial authentication request.
Method _add_cache_busting_to_params Undocumented

Inherited from PollingConnection:

Method async_request No summary
Method get_request_kwargs Arguments which are passed to the initial request() call inside async_request.

Inherited from Connection (via PollingConnection):

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 morph_action_hook Undocumented
Method add_default_params Adds default parameters (such as API key, version, etc.) to the passed `params`
Method add_default_headers Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`
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 encode_data Encode body data.
Method _tuple_from_url Undocumented
Method _user_agent Undocumented
def __init__(self, user_id, key, secure=True, ex_force_region='ord', **kwargs): (source)
Undocumented
def request(self, action, params=None, data='', headers=None, method='GET'): (source)
Request a given `action`.

Basically a wrapper around the connection object's `request` that does some helpful pre-processing.

ParametersactionA path (type: str)
paramsOptional mapping of additional parameters to send. If None, leave as an empty dict. (type: dict)
dataA body of data to send with the request. (type: unicode)
headersExtra headers to add to the request None, leave as an empty dict. (type: dict)
methodAn HTTP method such as "GET" or "POST". (type: str)
rawTrue to perform a "raw" request aka only send the headers and use the rawResponseCls class. This is used with storage API when uploading a file. (type: bool)
ReturnsAn instance of type responseCls
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 get_endpoint(self): (source)
FIXME: Dirty, dirty hack. Loadbalancers so not show up in the auth 1.1 service catalog, so we build it from the servers url.
def _construct_loadbalancer_endpoint_from_servers_endpoint(self, ep): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:49:10.