Blame - docs/dyn/vault_v1.matters.savedQueries.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a saved query.</p>

80

81

<code><a href="#delete">delete(matterId, savedQueryId, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a saved query by Id.</p>

83

84

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

85

<p class="firstline">Retrieves a saved query by Id.</p>

86

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

87

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Lists saved queries within a matter. An empty page token in</p>

89

90

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

91

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

92

<h3>Method Details</h3>

93

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

<pre>Creates a saved query.

96

97

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

98

matterId: string, The matter ID of the parent matter for which the saved query is to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

99

created. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

The object takes the form of:

102

103

{ # Definition of the saved query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

104

"savedQueryId": "A String", # A unique identifier for the saved query.

105

"displayName": "A String", # Name of the saved query.

106

"query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved

107

# query.

108

"sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs

109

# to be specified.

110

"sharedDriveIds": [ # List of Shared drive IDs, as provided by <a

111

# href="https://developers.google.com/drive">Drive API</a>.

112

"A String",

113

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

115

"driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.

116

"versionDate": "A String", # Search the versions of the Drive file

117

# as of the reference date. These timestamps are in GMT and

118

# rounded down to the given date.

119

"includeTeamDrives": True or False, # Set to true to include Team Drive.

120

"includeSharedDrives": True or False, # Set to true to include shared drive.

121

},

122

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and

123

# rounded down to the start of the given date.

124

"dataScope": "A String", # The data source to search from.

125

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and

126

# rounded down to the start of the given date.

127

"searchMethod": "A String", # The search method to use.

128

"corpus": "A String", # The corpus to search.

129

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be

130

# specified. (read-only)

131

"roomId": [ # A set of rooms to search.

"A String",

],

},

"hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)

136

"includeRooms": True or False, # Set to true to include rooms.

137

},

138

"orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs

139

# to be specified.

140

"orgUnitId": "A String", # Org unit to search, as provided by the

141

# <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK

142

# Directory API</a>.

143

},

144

"terms": "A String", # The corpus-specific

145

# <a href="https://support.google.com/vault/answer/2474474">search

146

# operators</a> used to generate search results.

147

"method": "A String", # The search method to use. This field is similar to the search_method field

148

# but is introduced to support shared drives. It supports all

149

# search method types. In case the search_method is TEAM_DRIVE the response

150

# of this field will be SHARED_DRIVE only.

151

"mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.

152

"excludeDrafts": True or False, # Set to true to exclude drafts.

153

},

154

"timeZone": "A String", # The time zone name.

155

# It should be an IANA TZ name, such as "America/Los_Angeles".

156

# For more information, see

157

# <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time

158

# Zone</a>.

159

"teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be

160

# specified.

161

"teamDriveIds": [ # List of Team Drive IDs, as provided by <a

162

# href="https://developers.google.com/drive">Drive API</a>.

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,

167

# account_info needs to be specified.

168

"emails": [ # A set of accounts to search.

"A String",

],

},

},

"matterId": "A String", # Output only. The matter ID of the associated matter.

174

# The server does not look at this field during create and always uses matter

175

# id in the URL.

176

"createTime": "A String", # Output only. The server generated timestamp at which saved query was

177

# created.

178

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

179

180

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

187

188

{ # Definition of the saved query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

189

"savedQueryId": "A String", # A unique identifier for the saved query.

190

"displayName": "A String", # Name of the saved query.

191

"query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved

192

# query.

193

"sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs

194

# to be specified.

195

"sharedDriveIds": [ # List of Shared drive IDs, as provided by <a

196

# href="https://developers.google.com/drive">Drive API</a>.

197

"A String",

198

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

199

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.

201

"versionDate": "A String", # Search the versions of the Drive file

202

# as of the reference date. These timestamps are in GMT and

203

# rounded down to the given date.

204

"includeTeamDrives": True or False, # Set to true to include Team Drive.

205

"includeSharedDrives": True or False, # Set to true to include shared drive.

206

},

207

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and

208

# rounded down to the start of the given date.

209

"dataScope": "A String", # The data source to search from.

210

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and

211

# rounded down to the start of the given date.

212

"searchMethod": "A String", # The search method to use.

213

"corpus": "A String", # The corpus to search.

214

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be

215

# specified. (read-only)

216

"roomId": [ # A set of rooms to search.

"A String",

],

},

"hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)

221

"includeRooms": True or False, # Set to true to include rooms.

222

},

223

"orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs

224

# to be specified.

225

"orgUnitId": "A String", # Org unit to search, as provided by the

226

# <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK

227

# Directory API</a>.

228

},

229

"terms": "A String", # The corpus-specific

230

# <a href="https://support.google.com/vault/answer/2474474">search

231

# operators</a> used to generate search results.

232

"method": "A String", # The search method to use. This field is similar to the search_method field

233

# but is introduced to support shared drives. It supports all

234

# search method types. In case the search_method is TEAM_DRIVE the response

235

# of this field will be SHARED_DRIVE only.

236

"mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.

237

"excludeDrafts": True or False, # Set to true to exclude drafts.

238

},

239

"timeZone": "A String", # The time zone name.

240

# It should be an IANA TZ name, such as "America/Los_Angeles".

241

# For more information, see

242

# <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time

243

# Zone</a>.

244

"teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be

245

# specified.

246

"teamDriveIds": [ # List of Team Drive IDs, as provided by <a

247

# href="https://developers.google.com/drive">Drive API</a>.

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,

252

# account_info needs to be specified.

253

"emails": [ # A set of accounts to search.

"A String",

],

},

},

"matterId": "A String", # Output only. The matter ID of the associated matter.

259

# The server does not look at this field during create and always uses matter

260

# id in the URL.

261

"createTime": "A String", # Output only. The server generated timestamp at which saved query was

262

# created.

263

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

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

268

<pre>Deletes a saved query by Id.

269

270

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

271

matterId: string, The matter ID of the parent matter for which the saved query is to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

272

deleted. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

273

savedQueryId: string, ID of the saved query to be deleted. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

274

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

281

282

{ # A generic empty message that you can re-use to avoid defining duplicated

283

# empty messages in your APIs. A typical example is to use it as the request

284

# or the response type of an API method. For instance:

285

#

286

# service Foo {

287

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

288

# }

289

#

290

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

296

<pre>Retrieves a saved query by Id.

297

298

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

299

matterId: string, The matter ID of the parent matter for which the saved query is to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

300

retrieved. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

301

savedQueryId: string, ID of the saved query to be retrieved. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

302

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

309

310

{ # Definition of the saved query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

311

"savedQueryId": "A String", # A unique identifier for the saved query.

312

"displayName": "A String", # Name of the saved query.

313

"query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved

314

# query.

315

"sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs

316

# to be specified.

317

"sharedDriveIds": [ # List of Shared drive IDs, as provided by <a

318

# href="https://developers.google.com/drive">Drive API</a>.

319

"A String",

320

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

321

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

322

"driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.

323

"versionDate": "A String", # Search the versions of the Drive file

324

# as of the reference date. These timestamps are in GMT and

325

# rounded down to the given date.

326

"includeTeamDrives": True or False, # Set to true to include Team Drive.

327

"includeSharedDrives": True or False, # Set to true to include shared drive.

328

},

329

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and

330

# rounded down to the start of the given date.

331

"dataScope": "A String", # The data source to search from.

332

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and

333

# rounded down to the start of the given date.

334

"searchMethod": "A String", # The search method to use.

335

"corpus": "A String", # The corpus to search.

336

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be

337

# specified. (read-only)

338

"roomId": [ # A set of rooms to search.

"A String",

],

},

"hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)

343

"includeRooms": True or False, # Set to true to include rooms.

344

},

345

"orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs

346

# to be specified.

347

"orgUnitId": "A String", # Org unit to search, as provided by the

348

# <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK

349

# Directory API</a>.

350

},

351

"terms": "A String", # The corpus-specific

352

# <a href="https://support.google.com/vault/answer/2474474">search

353

# operators</a> used to generate search results.

354

"method": "A String", # The search method to use. This field is similar to the search_method field

355

# but is introduced to support shared drives. It supports all

356

# search method types. In case the search_method is TEAM_DRIVE the response

357

# of this field will be SHARED_DRIVE only.

358

"mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.

359

"excludeDrafts": True or False, # Set to true to exclude drafts.

360

},

361

"timeZone": "A String", # The time zone name.

362

# It should be an IANA TZ name, such as "America/Los_Angeles".

363

# For more information, see

364

# <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time

365

# Zone</a>.

366

"teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be

367

# specified.

368

"teamDriveIds": [ # List of Team Drive IDs, as provided by <a

369

# href="https://developers.google.com/drive">Drive API</a>.

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,

374

# account_info needs to be specified.

375

"emails": [ # A set of accounts to search.

"A String",

],

},

},

"matterId": "A String", # Output only. The matter ID of the associated matter.

381

# The server does not look at this field during create and always uses matter

382

# id in the URL.

383

"createTime": "A String", # Output only. The server generated timestamp at which saved query was

384

# created.

385

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

389

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

390

<pre>Lists saved queries within a matter. An empty page token in

391

ListSavedQueriesResponse denotes no more saved queries to list.

392

393

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

394

matterId: string, The matter ID of the parent matter for which the saved queries are to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

395

retrieved. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

pageToken: string, The pagination token as returned in the previous response.

397

An empty token means start from the beginning.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

398

pageSize: integer, The maximum number of saved queries to return.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

399

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

406

407

{ # Definition of the response for method ListSaveQuery.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

408

"savedQueries": [ # List of output saved queries.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

409

{ # Definition of the saved query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

410

"savedQueryId": "A String", # A unique identifier for the saved query.

411

"displayName": "A String", # Name of the saved query.

412

"query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved

413

# query.

414

"sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs

415

# to be specified.

416

"sharedDriveIds": [ # List of Shared drive IDs, as provided by <a

417

# href="https://developers.google.com/drive">Drive API</a>.

418

"A String",

419

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

420

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

421

"driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.

422

"versionDate": "A String", # Search the versions of the Drive file

423

# as of the reference date. These timestamps are in GMT and

424

# rounded down to the given date.

425

"includeTeamDrives": True or False, # Set to true to include Team Drive.

426

"includeSharedDrives": True or False, # Set to true to include shared drive.

427

},

428

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and

429

# rounded down to the start of the given date.

430

"dataScope": "A String", # The data source to search from.

431

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and

432

# rounded down to the start of the given date.

433

"searchMethod": "A String", # The search method to use.

434

"corpus": "A String", # The corpus to search.

435

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be

436

# specified. (read-only)

437

"roomId": [ # A set of rooms to search.

"A String",

],

},

"hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)

442

"includeRooms": True or False, # Set to true to include rooms.

443

},

444

"orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs

445

# to be specified.

446

"orgUnitId": "A String", # Org unit to search, as provided by the

447

# <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK

448

# Directory API</a>.

449

},

450

"terms": "A String", # The corpus-specific

451

# <a href="https://support.google.com/vault/answer/2474474">search

452

# operators</a> used to generate search results.

453

"method": "A String", # The search method to use. This field is similar to the search_method field

454

# but is introduced to support shared drives. It supports all

455

# search method types. In case the search_method is TEAM_DRIVE the response

456

# of this field will be SHARED_DRIVE only.

457

"mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.

458

"excludeDrafts": True or False, # Set to true to exclude drafts.

459

},

460

"timeZone": "A String", # The time zone name.

461

# It should be an IANA TZ name, such as "America/Los_Angeles".

462

# For more information, see

463

# <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time

464

# Zone</a>.

465

"teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be

466

# specified.

467

"teamDriveIds": [ # List of Team Drive IDs, as provided by <a

468

# href="https://developers.google.com/drive">Drive API</a>.

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,

473

# account_info needs to be specified.

474

"emails": [ # A set of accounts to search.

475

"A String",

476

],

477

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

478

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

479

"matterId": "A String", # Output only. The matter ID of the associated matter.

480

# The server does not look at this field during create and always uses matter

481

# id in the URL.

482

"createTime": "A String", # Output only. The server generated timestamp at which saved query was

483

# created.

484

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.

487

# If this is empty, then there are no more saved queries to list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

493

<pre>Retrieves the next page of results.

494

495

Args:

496

previous_request: The request for the previous page. (required)

497

previous_response: The response from the request for the previous page. (required)

498

499

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

500

A request object that you can call 'execute()' on to request the next

Bu Sun Kim