| | |
-- build(serviceName, version, http=None, discoveryServiceUrl='https://www.googleapis.com/discovery/v0.2beta1/describe/{api}/{apiVersion}', developerKey=None, model=<apiclient.model.JsonModel object>, requestBuilder=<class 'apiclient.http.HttpRequest'>)
- - build_from_document(service, base, future=None, http=None, developerKey=None, model=<apiclient.model.JsonModel object>, requestBuilder=<class 'apiclient.http.HttpRequest'>)
- Args:
+- build(serviceName, version, http=None, discoveryServiceUrl='https://www.googleapis.com/discovery/v0.2beta1/describe/{api}/{apiVersion}', developerKey=None, model=<apiclient.model.JsonModel object>, requestBuilder=<class 'apiclient.http.HttpRequest'>)
- Construct a Resource for interacting with an API.
+
+Construct a Resource object for interacting with
+an API. The serviceName and version are the
+names from the Discovery service.
+
+Args:
+ serviceName: string, name of the service
+ version: string, the version of the service
+ discoveryServiceUrl: string, a URI Template that points to
+ the location of the discovery service. It should have two
+ parameters {api} and {apiVersion} that when filled in
+ produce an absolute URI to the discovery document for
+ that service.
+ developerKey: string, key obtained from https://code.google.com/apis/console
+ model: apiclient.Model, converts to and from the wire format
+ requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP request
+
+Returns:
+ A Resource object with methods for interacting with
+ the service.
+ - build_from_document(service, base, future=None, http=None, developerKey=None, model=<apiclient.model.JsonModel object>, requestBuilder=<class 'apiclient.http.HttpRequest'>)
- Create a Resource for interacting with an API.
+
+Same as `build()`, but constructs the Resource object
+from a discovery document that is it given, as opposed to
+retrieving one over HTTP.
+
+Args:
service: string, discovery document
base: string, base URI for all HTTP requests, usually the discovery URI
future: string, discovery document with future capabilities
@@ -47,9 +73,11 @@ based APIs.
from the API Console.
model: Model class instance that serializes and
de-serializes requests and responses.
- requestBuilder: Takes an http request and packages it up to be executed.
- - createResource(http, baseUrl, model, requestBuilder, developerKey, resourceDesc, futureDesc)
- - key2param(key)
- max-results -> max_results
+ requestBuilder: Takes an http request and packages it up to be executed.
+
+Returns:
+ A Resource object with methods for interacting with
+ the service.
|
|
diff --git a/docs/apiclient.http.html b/docs/apiclient.http.html
index 368a1dc..a378677 100644
--- a/docs/apiclient.http.html
+++ b/docs/apiclient.http.html
@@ -48,19 +48,17 @@ actuall HTTP request.
Encapsulates a single HTTP request.
|
| |
Methods defined here:
-- __init__(self, http, uri, method='GET', body=None, headers=None, postproc=None, methodId=None)
- Constructor for an HttpRequest.
-
-Only http and uri are required.
+- __init__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None)
- Constructor for an HttpRequest.
Args:
http: httplib2.Http, the transport object to use to make a request
+ postproc: callable, called on the HTTP response and content to transform
+ it into a data object before returning, or raising an exception
+ on an error.
uri: string, the absolute URI to send the request to
method: string, the HTTP method to use
body: string, the request body of the HTTP request
headers: dict, the HTTP request headers
- postproc: callable, called on the HTTP response and content to transform
- it into a data object before returning, or raising an exception
- on an error.
methodId: string, a unique identifier for the API method being called.
- execute(self, http=None)
- Execute the request.
@@ -115,7 +113,7 @@ is taken from the rpcName in the discovery&nb
For more details see the project wiki.
|
| |
Methods defined here:
-- __call__(self, http, uri, method='GET', body=None, headers=None, postproc=None, methodId=None)
- Implements the callable interface that discovery.build() expects
+- __call__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None)
- Implements the callable interface that discovery.build() expects
of requestBuilder, which is to build an object compatible with
HttpRequest.execute(). See that method for the description of the
parameters and the expected response.
diff --git a/docs/apiclient.model.html b/docs/apiclient.model.html
index acb9471..0df4c8f 100644
--- a/docs/apiclient.model.html
+++ b/docs/apiclient.model.html
@@ -9,7 +9,7 @@
apiclient.model
| index
/home/jcgregorio/projects/apiary/apiclient/model.py |
-
+
+
+class Model(__builtin__.object) |
+
+| |
+Model base class.
+
+All Model classes should implement this interface.
+The Model serializes and de-serializes between a wire
+format such as JSON and a Python object representation.
|
+| |
+Methods defined here:
+- request(self, headers, path_params, query_params, body_value)
- Updates outgoing requests with a deserialized body.
+
+Args:
+ headers: dict, request headers
+ path_params: dict, parameters that appear in the request path
+ query_params: dict, parameters that appear in the query
+ body_value: object, the request body as a Python object, which must be
+ serializable.
+Returns:
+ A tuple of (headers, path_params, query, body)
+
+ headers: dict, request headers
+ path_params: dict, parameters that appear in the request path
+ query: string, query part of the request URI
+ body: string, the body serialized in the desired wire format.
+
+- response(self, resp, content)
- Convert the response wire format into a Python object.
+
+Args:
+ resp: httplib2.Response, the HTTP response headers and status
+ content: string, the body of the HTTP response
+
+Returns:
+ The body de-serialized as a Python object.
+
+Raises:
+ apiclient.errors.HttpError if a non 2xx response is received.
+
Data descriptors defined here:
- __dict__
|