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

3d55ac5

2012-02-21 10:11:19 -0500

[diff] [blame]

27

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

Joe Gregorio

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

[diff] [blame]

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>

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

47

</dt><dd>

48

<dl>

49

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

50

</dt></dl>

51

</dd>

52

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

Joe Gregorio

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

[diff] [blame]

53

</dt></dl>

54

</dd>

55

</dl>

Joe Gregorio

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

[diff] [blame]

56

</dd>

57

</dl>

Joe Gregorio

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

[diff] [blame]

58

</dd>

59

</dl>

Joe Gregorio

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

[diff] [blame]

Joe Gregorio

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

[diff] [blame]

64

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

65

66

67

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

68

69

Subclasses should provide implementations for the "serialize" and

70

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

71

72

Attributes:

73

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

74

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

75

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

76

Content" response.

77

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

78

79

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

80

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

81

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

82

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

83

</dl>

84

<hr>

85

Methods defined here:

Joe Gregorio

a845167

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

[diff] [blame]

86

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

87

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

Joe Gregorio

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

[diff] [blame]

88

89

Args:

90

content: string, the body of the HTTP response

91

92

Returns:

93

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

94

95

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

96

97

Args:

98

headers: dict, request headers

99

path_params: dict, parameters that appear in the request path

100

query_params: dict, parameters that appear in the query

101

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

102

serializable by simplejson.

103

Returns:

104

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

105

106

headers: dict, request headers

107

path_params: dict, parameters that appear in the request path

108

query: string, query part of the request URI

109

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

110

111

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

112

113

Args:

114

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

115

content: string, the body of the HTTP response

116

117

Returns:

118

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

119

120

Raises:

121

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

122

123

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

124

125

Args:

126

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

127

128

Returns:

129

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

130

131

<hr>

132

Data and other attributes defined here:

133

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

134

135

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

136

137

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

138

139

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

140

141

<hr>

142

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

143

144

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

145

</dl>

146

<dl><dt>__weakref__</dt>

147

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

154

155

Joe Gregorio

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

[diff] [blame]

156

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

Joe Gregorio

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

[diff] [blame]

157

158

Serializes and de-serializes between JSON and the Python

159

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

160

Joe Gregorio

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

[diff] [blame]

161

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

162

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

Joe Gregorio

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

[diff] [blame]

163

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

Joe Gregorio

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

[diff] [blame]

164

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

165

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

166

</dl>

167

<hr>

168

Methods defined here:

Joe Gregorio

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

[diff] [blame]

169

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

170

171

Args:

172

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

173

Joe Gregorio

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

[diff] [blame]

174

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

175

176

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

177

178

<hr>

179

Data descriptors defined here:

180

<dl><dt>no_content_response</dt>

181

</dl>

182

<hr>

183

Data and other attributes defined here:

184

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

185

186

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

187

188

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

189

190

<hr>

191

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

192

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

193

194

Args:

195

headers: dict, request headers

196

path_params: dict, parameters that appear in the request path

197

query_params: dict, parameters that appear in the query

198

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

199

serializable by simplejson.

200

Returns:

201

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

202

203

headers: dict, request headers

204

path_params: dict, parameters that appear in the request path

205

query: string, query part of the request URI

206

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

207

208

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

209

210

Args:

211

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

212

content: string, the body of the HTTP response

213

214

Returns:

215

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

216

217

Raises:

218

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

219

220

<hr>

Joe Gregorio

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

[diff] [blame]

221

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

222

223

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

224

</dl>

225

<dl><dt>__weakref__</dt>

226

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

233

234

235

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

236

237

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

238

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

239

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

240

241

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

Joe Gregorio

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

[diff] [blame]

242

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

243

244

Args:

245

headers: dict, request headers

246

path_params: dict, parameters that appear in the request path

247

query_params: dict, parameters that appear in the query

248

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

249

serializable.

250

Returns:

251

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

252

253

headers: dict, request headers

254

path_params: dict, parameters that appear in the request path

255

query: string, query part of the request URI

256

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

257

258

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

259

260

Args:

261

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

262

content: string, the body of the HTTP response

263

264

Returns:

265

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

266

267

Raises:

268

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

269

270

<hr>

Joe Gregorio

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

[diff] [blame]

271

Data descriptors defined here:

272

273

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

274

</dl>

275

<dl><dt>__weakref__</dt>

276

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

277

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

283

284

285

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

286

287

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

288

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

289

290

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

291

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

292

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

293

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

294

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

295

</dl>

296

<hr>

297

Methods defined here:

298

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

299

300

The serialzed protocol buffer returned in an HTTP response will be

301

de-serialized using the given protocol buffer class.

302

303

Args:

Joe Gregorio

a845167

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

[diff] [blame]

304

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

305

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

Joe Gregorio

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

[diff] [blame]

306

307

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

308

309

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

310

311

<hr>

312

Data descriptors defined here:

313

<dl><dt>no_content_response</dt>

314

</dl>

315

<hr>

316

Data and other attributes defined here:

317

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

318

319

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

320

321

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

322

323

<hr>

324

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

325

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

326

327

Args:

328

headers: dict, request headers

329

path_params: dict, parameters that appear in the request path

330

query_params: dict, parameters that appear in the query

331

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

332

serializable by simplejson.

333

Returns:

334

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

335

336

headers: dict, request headers

337

path_params: dict, parameters that appear in the request path

338

query: string, query part of the request URI

339

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

340

341

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

342

343

Args:

344

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

345

content: string, the body of the HTTP response

346

347

Returns:

348

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

349

350

Raises:

351

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

352

353

<hr>

354

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

355

356

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

357

</dl>

358

<dl><dt>__weakref__</dt>

359

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

360

</dl>

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

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

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

366

367

368

<td colspan=2><tt><a href="#Model">Model</a> class for requests that don't return JSON.

369

370

Serializes and de-serializes between JSON and the Python

371

<a href="__builtin__.html#object">object</a> representation of HTTP request, and returns the raw bytes

372

of the response body.  </tt></td></tr>

373

374

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

375

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

376

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

377

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

378

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

379

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

380

</dl>

381

<hr>

382

Methods defined here:

383

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

384

385

<hr>

386

Data descriptors defined here:

387

<dl><dt>no_content_response</dt>

388

</dl>

389

<hr>

390

Data and other attributes defined here:

391

<dl><dt>accept = '*/*'</dl>

392

393

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

394

395

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

396

397

<hr>

398

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

399

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

400

401

Args:

402

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

403

404

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

405

406

<hr>

407

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

408

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

409

410

Args:

411

headers: dict, request headers

412

path_params: dict, parameters that appear in the request path

413

query_params: dict, parameters that appear in the query

414

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

415

serializable by simplejson.

416

Returns:

417

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

418

419

headers: dict, request headers

420

path_params: dict, parameters that appear in the request path

421

query: string, query part of the request URI

422

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

423

424

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

425

426

Args:

427

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

428

content: string, the body of the HTTP response

429

430

Returns:

431

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

432

433

Raises:

434

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

435

436

<hr>

437

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

438

439

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

440

</dl>

441

<dl><dt>__weakref__</dt>

442

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

443

</dl>

Joe Gregorio