googleapiclient.model.BaseModel

class documentation

class BaseModel(Model):

Base model class.

Subclasses should provide implementations for the "serialize" and "deserialize" methods, as well as values for the following class attributes.

Method	`deserialize`	Perform the actual deserialization from response string to Python object.
Method	`request`	Updates outgoing requests with a serialized body.
Method	`response`	Convert the response wire format into a Python object.
Method	`serialize`	Perform the actual Python object serialization.
Instance Variable	`accept`	The value to use for the HTTP Accept header.
Instance Variable	`alt_param`	The value to supply as the "alt" query parameter for requests.
Instance Variable	`content_type`	The value to use for the HTTP Content-type header.
Instance Variable	`no_content_response`	The value to return when deserializing a 204 "No Content" response.
Method	`_build_query`	Builds a query string.
Method	`_log_request`	Logs debugging information about the request if requested.
Method	`_log_response`	Logs debugging information about the response if requested.

def deserialize(self, content): ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

Perform the actual deserialization from response string to Python object.

Parameters
content	string, the body of the HTTP response
Returns
The body de-serialized as a Python object.

def request(self, headers, path_params, query_params, body_value): ¶

overrides googleapiclient.model.Model.request

Updates outgoing requests with a serialized body.

Parameters
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 by json.
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 as JSON

def response(self, resp, content): ¶

overrides googleapiclient.model.Model.response

Convert the response wire format into a Python object.

Parameters
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.`

def serialize(self, body_value): ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

Perform the actual Python object serialization.

Parameters
body_value	object, the request body as a Python object.
Returns
string, the body in serialized form.

accept = ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

The value to use for the HTTP Accept header.

alt_param = ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

The value to supply as the "alt" query parameter for requests.

content_type = ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

The value to use for the HTTP Content-type header.

no_content_response = ¶

overridden in googleapiclient.model.JsonModel, googleapiclient.model.ProtocolBufferModel

The value to return when deserializing a 204 "No Content" response.

def _build_query(self, params): ¶

Builds a query string.

Parameters
params	dict, the query parameters
Returns
The query parameters properly encoded into an HTTP URI query string.

def _log_request(self, headers, path_params, query, body): ¶

Logs debugging information about the request if requested.

def _log_response(self, resp, content): ¶

Logs debugging information about the response if requested.