l.s.d.c.CloudFilesConnection(OpenStackBaseConnection) : class documentation

Part of libcloud.storage.drivers.cloudfiles View Source View In Hierarchy

Known subclasses: libcloud.storage.drivers.cloudfiles.CloudFilesSwiftConnection, libcloud.storage.drivers.cloudfiles.CloudFilesUKConnection, libcloud.storage.drivers.cloudfiles.CloudFilesUSConnection

Base connection class for the Cloudfiles driver.
Method __init__ Initialize `user_id` and `key`; set `secure` to an C{int} based on passed value.
Method get_endpoint Selects the endpoint to use based on provider specific values, or overrides passed in by the user when setting up the driver.
Method request Request a given `action`.

Inherited from OpenStackBaseConnection:

Method get_service_catalog Undocumented
Method get_auth_connection_instance Return an OpenStackAuthConnection instance for this connection.
Method add_default_headers Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`
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 Connection (via OpenStackBaseConnection, ConnectionUserAndKey, ConnectionKey):

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 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 encode_data Encode body data.
Method _tuple_from_url Undocumented
Method _user_agent Undocumented
def __init__(self, user_id, key, secure=True, **kwargs): (source)
Initialize `user_id` and `key`; set `secure` to an C{int} based on
passed value.
def get_endpoint(self): (source)
Selects the endpoint to use based on provider specific values,
or overrides passed in by the user when setting up the driver.

@returns: url of the relevant endpoint for the driver
def request(self, action, params=None, data='', headers=None, method='GET', raw=False, cdn_request=False): (source)
Request a given `action`.

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

@type action: C{str}
@param action: A path. This can include arguments. If included,
    any extra parameters are appended to the existing ones.

@type params: C{dict}
@param params: Optional mapping of additional parameters to send. If
    None, leave as an empty C{dict}.

@type data: C{unicode}
@param data: A body of data to send with the request.

@type headers: C{dict}
@param headers: Extra headers to add to the request
    None, leave as an empty C{dict}.

@type method: C{str}
@param method: An HTTP method such as "GET" or "POST".

@type raw: C{bool}
@param raw: True 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.

@return: An instance of type I{responseCls}
API Documentation for libcloud, generated by pydoctor at 2013-09-18 15:42:48.