Blame - docs/apiclient.model.html - platform/external/python/google-api-python-client

2010-12-09 16:34:22 -0500

[diff] [blame]

13

14

Each API may support one or more serializations, such

15

as JSON, Atom, etc. The model classes are responsible

16

for converting between the wire format and the Python

17

<a href="__builtin__.html#object">object</a> representation.</tt>

<big>Modules</big></td></tr>

23

24

Joe Gregorio

2011-03-08 10:39:00 -0500

[diff] [blame]

25

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gflags.html">gflags</a>

26

</td><td width="25%" valign=top><a href="logging.html">logging</a>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

27

</td><td width="25%" valign=top><a href="simplejson.html">simplejson</a>

28

</td><td width="25%" valign=top><a href="urllib.html">urllib</a>

Joe Gregorio

2011-03-08 10:39:00 -0500

[diff] [blame]

29

</td></tr></table></td></tr></table>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

<big>Classes</big></td></tr>

<dt><a href="__builtin__.html#object">__builtin__.object</a>

38

</dt><dd>

39

<dl>

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

40

<dt><a href="apiclient.model.html#Model">Model</a>

41

</dt><dd>

42

<dl>

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

43

<dt><a href="apiclient.model.html#BaseModel">BaseModel</a>

Joe Gregorio

2011-03-08 10:39:00 -0500

[diff] [blame]

44

</dt><dd>

45

<dl>

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

46

<dt><a href="apiclient.model.html#JsonModel">JsonModel</a>

47

</dt><dt><a href="apiclient.model.html#ProtocolBufferModel">ProtocolBufferModel</a>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

48

</dt></dl>

49

</dd>

50

</dl>

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

51

</dd>

52

</dl>

Joe Gregorio

2011-03-08 10:39:00 -0500

[diff] [blame]

53

</dd>

54

</dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

59

<a name="BaseModel">class BaseModel</a>(<a href="apiclient.model.html#Model">Model</a>)</td></tr>

60

61

62

<td colspan=2><tt>Base model class.

63

64

Subclasses should provide implementations for the "serialize" and

65

"deserialize" methods, as well as values for the following class attributes.

66

67

Attributes:

68

accept: The value to use for the HTTP Accept header.

69

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

70

no_content_response: The value to return when deserializing a 204 "No

71

Content" response.

72

alt_param: The value to supply as the "alt" query parameter for requests.  </tt></td></tr>

73

74

<td width="100%"><dl><dt>Method resolution order:</dt>

75

<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>

76

<dd><a href="apiclient.model.html#Model">Model</a></dd>

77

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

78

</dl>

79

<hr>

80

Methods defined here:

81

<dl><dt><a name="BaseModel-deserialize">deserialize</a>(self, content)</dt><dd><tt>Perform the actual deserialization from response string to Python <a href="__builtin__.html#object">object</a>.

82

83

Args:

84

content: string, the body of the HTTP response

85

86

Returns:

87

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

88

89

<dl><dt><a name="BaseModel-request">request</a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates outgoing requests with a serialized body.

90

91

Args:

92

headers: dict, request headers

93

path_params: dict, parameters that appear in the request path

94

query_params: dict, parameters that appear in the query

95

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>, which must be

96

serializable by simplejson.

97

Returns:

98

A tuple of (headers, path_params, query, body)

99

100

headers: dict, request headers

101

path_params: dict, parameters that appear in the request path

102

query: string, query part of the request URI

103

body: string, the body serialized as JSON</tt></dd></dl>

104

105

<dl><dt><a name="BaseModel-response">response</a>(self, resp, content)</dt><dd><tt>Convert the response wire format into a Python <a href="__builtin__.html#object">object</a>.

106

107

Args:

108

resp: httplib2.Response, the HTTP response headers and status

109

content: string, the body of the HTTP response

110

111

Returns:

112

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.

113

114

Raises:

115

apiclient.errors.HttpError if a non 2xx response is received.</tt></dd></dl>

116

117

<dl><dt><a name="BaseModel-serialize">serialize</a>(self, body_value)</dt><dd><tt>Perform the actual Python <a href="__builtin__.html#object">object</a> serialization.

118

119

Args:

120

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>.

121

122

Returns:

123

string, the body in serialized form.</tt></dd></dl>

124

125

<hr>

126

Data and other attributes defined here:

127

<dl><dt>accept = None</dl>

128

129

<dl><dt>alt_param = None</dl>

130

131

<dl><dt>content_type = None</dl>

132

133

<dl><dt>no_content_response = None</dl>

134

135

<hr>

136

Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:

137

138

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

139

</dl>

140

<dl><dt>__weakref__</dt>

141

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

<a name="JsonModel">class JsonModel</a>(<a href="apiclient.model.html#BaseModel">BaseModel</a>)</td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

148

149

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

150

<td colspan=2><tt><a href="#Model">Model</a> class for JSON.

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

151

152

Serializes and de-serializes between JSON and the Python

153

<a href="__builtin__.html#object">object</a> representation of HTTP request and response bodies.  </tt></td></tr>

154

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

155

<td width="100%"><dl><dt>Method resolution order:</dt>

156

<dd><a href="apiclient.model.html#JsonModel">JsonModel</a></dd>

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

157

<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

158

<dd><a href="apiclient.model.html#Model">Model</a></dd>

159

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

160

</dl>

161

<hr>

162

Methods defined here:

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

163

<dl><dt><a name="JsonModel-__init__">__init__</a>(self, data_wrapper=False)</dt><dd><tt>Construct a <a href="#JsonModel">JsonModel</a>.

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame]

164

165

Args:

166

data_wrapper: boolean, wrap requests and responses in a data wrapper</tt></dd></dl>

167

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

168

<dl><dt><a name="JsonModel-deserialize">deserialize</a>(self, content)</dt></dl>

169

170

<dl><dt><a name="JsonModel-serialize">serialize</a>(self, body_value)</dt></dl>

171

172

<hr>

173

Data descriptors defined here:

174

<dl><dt>no_content_response</dt>

175

</dl>

176

<hr>

177

Data and other attributes defined here:

178

<dl><dt>accept = 'application/json'</dl>

179

180

<dl><dt>alt_param = 'json'</dl>

181

182

<dl><dt>content_type = 'application/json'</dl>

183

184

<hr>

185

Methods inherited from <a href="apiclient.model.html#BaseModel">BaseModel</a>:

186

<dl><dt><a name="JsonModel-request">request</a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates outgoing requests with a serialized body.

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

187

188

Args:

189

headers: dict, request headers

190

path_params: dict, parameters that appear in the request path

191

query_params: dict, parameters that appear in the query

192

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>, which must be

193

serializable by simplejson.

194

Returns:

195

A tuple of (headers, path_params, query, body)

196

197

headers: dict, request headers

198

path_params: dict, parameters that appear in the request path

199

query: string, query part of the request URI

200

body: string, the body serialized as JSON</tt></dd></dl>

201

202

<dl><dt><a name="JsonModel-response">response</a>(self, resp, content)</dt><dd><tt>Convert the response wire format into a Python <a href="__builtin__.html#object">object</a>.

203

204

Args:

205

resp: httplib2.Response, the HTTP response headers and status

206

content: string, the body of the HTTP response

207

208

Returns:

209

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.

210

211

Raises:

212

apiclient.errors.HttpError if a non 2xx response is received.</tt></dd></dl>

213

214

<hr>

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

215

Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:

216

217

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

218

</dl>

219

<dl><dt>__weakref__</dt>

220

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

<a name="Model">class Model</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

227

228

229

<td colspan=2><tt><a href="#Model">Model</a> base class.

230

231

All <a href="#Model">Model</a> classes should implement this interface.

232

The <a href="#Model">Model</a> serializes and de-serializes between a wire

233

format such as JSON and a Python <a href="__builtin__.html#object">object</a> representation.  </tt></td></tr>

234

235

<td width="100%">Methods defined here:

Joe Gregorio

2011-05-08 23:32:46 -0700

[diff] [blame^]

236

<dl><dt><a name="Model-request">request</a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates outgoing requests with a serialized body.

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

237

238

Args:

239

headers: dict, request headers

240

path_params: dict, parameters that appear in the request path

241

query_params: dict, parameters that appear in the query

242

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>, which must be

243

serializable.

244

Returns:

245

A tuple of (headers, path_params, query, body)

246

247

headers: dict, request headers

248

path_params: dict, parameters that appear in the request path

249

query: string, query part of the request URI

250

body: string, the body serialized in the desired wire format.</tt></dd></dl>

251

252

<dl><dt><a name="Model-response">response</a>(self, resp, content)</dt><dd><tt>Convert the response wire format into a Python <a href="__builtin__.html#object">object</a>.

253

254

Args:

255

resp: httplib2.Response, the HTTP response headers and status

256

content: string, the body of the HTTP response

257

258

Returns:

259

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.

260

261

Raises:

262

apiclient.errors.HttpError if a non 2xx response is received.</tt></dd></dl>

263

264

<hr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

265

Data descriptors defined here:

266

267

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

268

</dl>

269

<dl><dt>__weakref__</dt>

270

<dd><tt>list of weak references to the object (if defined)</tt></dd>

271

</dl>

Joe Gregorio