Blame - docs/dyn/keep_v1.notes.html - platform/external/python/google-api-python-client

<p class="firstline">Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.</p>

91

92

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

93

94

95

<code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

96

<p class="firstline">Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.</p>

97

98

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

99

<p class="firstline">Retrieves the next page of results.</p>

100

<h3>Method Details</h3>

101

102

<code class="details" id="close">close()</code>

103

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

108

<pre>Creates a new note.

109

110

Args:

111

body: object, The request body.

112

The object takes the form of:

113

114

{ # A single note.

115

"attachments": [ # Output only. The attachments attached to this note.

116

{ # An attachment to a note.

117

"mimeType": [ # The MIME types (IANA media types) in which the attachment is available.

118

"A String",

119

],

120

"name": "A String", # The resource name;

121

},

122

],

123

"body": { # The content of the note. # The body of the note.

124

"list": { # The list of items for a single list note. # Used if this section's content is a list.

125

"listItems": [ # The items in the list. The number of items must be less than 1,000.

126

{ # A single list item in a note's list.

127

"checked": True or False, # Whether this item has been checked off or not.

128

"childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.

129

# Object with schema name: ListItem

130

],

131

"text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.

132

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

},

},

],

},

"text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.

138

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

139

},

140

},

141

"createTime": "A String", # Output only. When this note was created.

142

"name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.

143

"permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.

144

{ # A single permission on the note. Associates a `member` with a `role`.

145

"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

146

"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

147

"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.

148

},

149

"group": { # Describes a single Group. # Output only. The group to which this role applies.

150

"email": "A String", # The group email.

151

},

152

"name": "A String", # Output only. The resource name.

153

"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.

154

"user": { # Describes a single user. # Output only. The user to whom this role applies.

155

"email": "A String", # The user's email.

},

},

],

"title": "A String", # The title of the note. Length must be less than 1,000 characters.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

160

"trashTime": "A String", # Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`).

161

"trashed": True or False, # Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

162

"updateTime": "A String", # Output only. When this note was last modified.

163

}

164

165

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

172

173

{ # A single note.

174

"attachments": [ # Output only. The attachments attached to this note.

175

{ # An attachment to a note.

176

"mimeType": [ # The MIME types (IANA media types) in which the attachment is available.

177

"A String",

178

],

179

"name": "A String", # The resource name;

180

},

181

],

182

"body": { # The content of the note. # The body of the note.

183

"list": { # The list of items for a single list note. # Used if this section's content is a list.

184

"listItems": [ # The items in the list. The number of items must be less than 1,000.

185

{ # A single list item in a note's list.

186

"checked": True or False, # Whether this item has been checked off or not.

187

"childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.

188

# Object with schema name: ListItem

189

],

190

"text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.

191

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

},

},

],

},

"text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.

197

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

198

},

199

},

200

"createTime": "A String", # Output only. When this note was created.

201

"name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.

202

"permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.

203

{ # A single permission on the note. Associates a `member` with a `role`.

204

"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

205

"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

206

"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.

207

},

208

"group": { # Describes a single Group. # Output only. The group to which this role applies.

209

"email": "A String", # The group email.

210

},

211

"name": "A String", # Output only. The resource name.

212

"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.

213

"user": { # Describes a single user. # Output only. The user to whom this role applies.

214

"email": "A String", # The user's email.

},

},

],

"title": "A String", # The title of the note. Length must be less than 1,000 characters.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

219

"trashTime": "A String", # Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`).

220

"trashed": True or False, # Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

221

"updateTime": "A String", # Output only. When this note was last modified.

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

227

<pre>Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.

228

229

Args:

230

name: string, Required. Name of the note to delete. (required)

231

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

238

239

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

<pre>Gets a note.

Args:

name: string, Required. Name of the resource. (required)

249

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

256

257

{ # A single note.

258

"attachments": [ # Output only. The attachments attached to this note.

259

{ # An attachment to a note.

260

"mimeType": [ # The MIME types (IANA media types) in which the attachment is available.

261

"A String",

262

],

263

"name": "A String", # The resource name;

264

},

265

],

266

"body": { # The content of the note. # The body of the note.

267

"list": { # The list of items for a single list note. # Used if this section's content is a list.

268

"listItems": [ # The items in the list. The number of items must be less than 1,000.

269

{ # A single list item in a note's list.

270

"checked": True or False, # Whether this item has been checked off or not.

271

"childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.

272

# Object with schema name: ListItem

273

],

274

"text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.

275

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

},

},

],

},

"text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.

281

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

282

},

283

},

284

"createTime": "A String", # Output only. When this note was created.

285

"name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.

286

"permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.

287

{ # A single permission on the note. Associates a `member` with a `role`.

288

"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

289

"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

290

"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.

291

},

292

"group": { # Describes a single Group. # Output only. The group to which this role applies.

293

"email": "A String", # The group email.

294

},

295

"name": "A String", # Output only. The resource name.

296

"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.

297

"user": { # Describes a single user. # Output only. The user to whom this role applies.

298

"email": "A String", # The user's email.

},

},

],

"title": "A String", # The title of the note. Length must be less than 1,000 characters.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

303

"trashTime": "A String", # Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`).

304

"trashed": True or False, # Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

305

"updateTime": "A String", # Output only. When this note was last modified.

}</pre>

</div>

<code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

311

<pre>Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.

312

313

Args:

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

314

filter: string, Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160).

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

315

pageSize: integer, The maximum number of results to return.

316

pageToken: string, The previous page's `next_page_token` field.

317

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

324

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

325

{ # The response when listing a page of notes.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

326

"nextPageToken": "A String", # Next page's `page_token` field.

327

"notes": [ # A page of notes.

328

{ # A single note.

329

"attachments": [ # Output only. The attachments attached to this note.

330

{ # An attachment to a note.

331

"mimeType": [ # The MIME types (IANA media types) in which the attachment is available.

332

"A String",

333

],

334

"name": "A String", # The resource name;

335

},

336

],

337

"body": { # The content of the note. # The body of the note.

338

"list": { # The list of items for a single list note. # Used if this section's content is a list.

339

"listItems": [ # The items in the list. The number of items must be less than 1,000.

340

{ # A single list item in a note's list.

341

"checked": True or False, # Whether this item has been checked off or not.

342

"childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.

343

# Object with schema name: ListItem

344

],

345

"text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.

346

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

},

},

],

},

"text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.

352

"text": "A String", # The text of the note. The limits on this vary with the specific field using this type.

353

},

354

},

355

"createTime": "A String", # Output only. When this note was created.

356

"name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.

357

"permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.

358

{ # A single permission on the note. Associates a `member` with a `role`.

359

"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

360

"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

361

"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.

362

},

363

"group": { # Describes a single Group. # Output only. The group to which this role applies.

364

"email": "A String", # The group email.

365

},

366

"name": "A String", # Output only. The resource name.

367

"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.

368

"user": { # Describes a single user. # Output only. The user to whom this role applies.

369

"email": "A String", # The user's email.

},

},

],

"title": "A String", # The title of the note. Length must be less than 1,000 characters.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame^]

374

"trashTime": "A String", # Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`).

375

"trashed": True or False, # Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted.

yoshi-code-bot

cb945f3

2021-06-08 00:36:03 -0700

[diff] [blame]

376

"updateTime": "A String", # Output only. When this note was last modified.

377

},

378

],