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:

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame^]

81

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

82

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

Joe Gregorio

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

[diff] [blame]

83

84

Args:

85

content: string, the body of the HTTP response

86

87

Returns:

88

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

89

90

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

91

92

Args:

93

headers: dict, request headers

94

path_params: dict, parameters that appear in the request path

95

query_params: dict, parameters that appear in the query

96

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

97

serializable by simplejson.

98

Returns:

99

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

100

101

headers: dict, request headers

102

path_params: dict, parameters that appear in the request path

103

query: string, query part of the request URI

104

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

105

106

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

107

108

Args:

109

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

110

content: string, the body of the HTTP response

111

112

Returns:

113

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

114

115

Raises:

116

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

117

118

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

119

120

Args:

121

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

122

123

Returns:

124

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

125

126

<hr>

127

Data and other attributes defined here:

128

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

129

130

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

131

132

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

133

134

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

135

136

<hr>

137

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

138

139

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

140

</dl>

141

<dl><dt>__weakref__</dt>

142

<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]

149

150

Joe Gregorio

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

[diff] [blame]

151

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

Joe Gregorio

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

[diff] [blame]

152

153

Serializes and de-serializes between JSON and the Python

154

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

155

Joe Gregorio

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

[diff] [blame]

156

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

157

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

Joe Gregorio

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

[diff] [blame]

158

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

Joe Gregorio

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

[diff] [blame]

159

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

160

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

161

</dl>

162

<hr>

163

Methods defined here:

Joe Gregorio

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

[diff] [blame]

164

<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]

165

166

Args:

167

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

168

Joe Gregorio

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

[diff] [blame]

169

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

170

171

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

172

173

<hr>

174

Data descriptors defined here:

175

<dl><dt>no_content_response</dt>

176

</dl>

177

<hr>

178

Data and other attributes defined here:

179

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

180

181

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

182

183

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

184

185

<hr>

186

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

187

<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]

188

189

Args:

190

headers: dict, request headers

191

path_params: dict, parameters that appear in the request path

192

query_params: dict, parameters that appear in the query

193

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

194

serializable by simplejson.

195

Returns:

196

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

197

198

headers: dict, request headers

199

path_params: dict, parameters that appear in the request path

200

query: string, query part of the request URI

201

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

202

203

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

204

205

Args:

206

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

207

content: string, the body of the HTTP response

208

209

Returns:

210

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

211

212

Raises:

213

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

214

215

<hr>

Joe Gregorio

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

[diff] [blame]

216

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

217

218

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

219

</dl>

220

<dl><dt>__weakref__</dt>

221

<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>

228

229

230

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

231

232

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

233

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

234

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

235

236

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

Joe Gregorio

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

[diff] [blame]

237

<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]

238

239

Args:

240

headers: dict, request headers

241

path_params: dict, parameters that appear in the request path

242

query_params: dict, parameters that appear in the query

243

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

244

serializable.

245

Returns:

246

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

247

248

headers: dict, request headers

249

path_params: dict, parameters that appear in the request path

250

query: string, query part of the request URI

251

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

252

253

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

254

255

Args:

256

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

257

content: string, the body of the HTTP response

258

259

Returns:

260

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

261

262

Raises:

263

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

264

265

<hr>

Joe Gregorio

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

[diff] [blame]

266

Data descriptors defined here:

267

268

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

269

</dl>

270

<dl><dt>__weakref__</dt>

271

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

272

</dl>

Joe Gregorio

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

[diff] [blame]

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

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

278

279

280

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

281

282

Serializes and de-serializes the binary protocol buffer sent in the HTTP

283

request and response bodies.  </tt></td></tr>

284

285

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

286

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

287

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

288

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

289

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

290

</dl>

291

<hr>

292

Methods defined here:

293

<dl><dt><a name="ProtocolBufferModel-__init__">__init__</a>(self, protocol_buffer)</dt><dd><tt>Constructs a <a href="#ProtocolBufferModel">ProtocolBufferModel</a>.

294

295

The serialzed protocol buffer returned in an HTTP response will be

296

de-serialized using the given protocol buffer class.

297

298

Args:

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame^]

299

protocol_buffer: The protocol buffer class used to de-serialize a

300

response from the API.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

301

302

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

303

304

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

305

306

<hr>

307

Data descriptors defined here:

308

<dl><dt>no_content_response</dt>

309

</dl>

310

<hr>

311

Data and other attributes defined here:

312

<dl><dt>accept = 'application/x-protobuf'</dl>

313

314

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

315

316

<dl><dt>content_type = 'application/x-protobuf'</dl>

317

318

<hr>

319

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

320

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

321

322

Args:

323

headers: dict, request headers

324

path_params: dict, parameters that appear in the request path

325

query_params: dict, parameters that appear in the query

326

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

327

serializable by simplejson.

328

Returns:

329

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

330

331

headers: dict, request headers

332

path_params: dict, parameters that appear in the request path

333

query: string, query part of the request URI

334

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

335

336

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

337

338

Args:

339

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

340

content: string, the body of the HTTP response

341

342

Returns:

343

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

344

345

Raises:

346

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

347

348

<hr>

349

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

350

351

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

352

</dl>

353

<dl><dt>__weakref__</dt>

354

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

355

</dl>

Joe Gregorio