Package googleapiclient :: Module model :: Class Model

Class Model

object --+
         |
        Model

Known Subclasses:

BaseModel

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.

Instance Methods

[hide private]

request(self, headers, path_params, query_params, body_value)
Updates outgoing requests with a serialized body.

source code

response(self, resp, content)
Convert the response wire format into a Python object.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

request(self, headers, path_params, query_params, body_value)

source code

Updates outgoing requests with a serialized 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)

source code

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:
  googleapiclient.errors.HttpError if a non 2xx response is received.