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

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

105

# query.

Bu Sun Kim

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

[diff] [blame]

106

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

107

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

108

# specified. (read-only)

109

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

114

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

115

},

116

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

117

# to be specified.

118

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

119

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

120

# Directory API</a>.

121

},

122

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

123

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

124

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

125

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

126

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

127

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

128

# of this field will be SHARED_DRIVE only.

129

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

130

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

131

},

132

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

133

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

134

# For more information, see

135

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

136

# Zone</a>.

137

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

138

# specified.

139

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

140

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

"A String",

],

},

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

145

# account_info needs to be specified.

146

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

147

"A String",

148

],

149

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

150

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

151

# to be specified.

152

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

153

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

"A String",

],

},

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

158

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

159

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

160

# rounded down to the given date.

161

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

162

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

163

},

164

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

165

# rounded down to the start of the given date.

166

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

167

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

168

# rounded down to the start of the given date.

169

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

Bu Sun Kim

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

[diff] [blame]

170

},

171

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

172

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

173

# id in the URL.

174

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

175

# created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

176

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

177

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

178

}

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.

189

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

190

# query.

191

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

192

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

193

# specified. (read-only)

194

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

199

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

200

},

201

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

202

# to be specified.

203

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

204

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

205

# Directory API</a>.

206

},

207

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

208

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

209

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

210

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

211

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

212

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

213

# of this field will be SHARED_DRIVE only.

214

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

215

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

216

},

217

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

218

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

219

# For more information, see

220

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

221

# Zone</a>.

222

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

223

# specified.

224

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

225

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

"A String",

],

},

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

230

# account_info needs to be specified.

231

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

"A String",

],

},

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

236

# to be specified.

237

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

238

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

"A String",

],

},

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

243

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

244

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

245

# rounded down to the given date.

246

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

247

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

248

},

249

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

250

# rounded down to the start of the given date.

251

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

252

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

253

# rounded down to the start of the given date.

254

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

255

},

256

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

257

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

258

# id in the URL.

259

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

260

# created.

261

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

262

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

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-27 12:20:54 -0700

[diff] [blame]

311

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

312

# query.

313

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

314

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

315

# specified. (read-only)

316

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

321

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

322

},

323

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

324

# to be specified.

325

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

326

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

327

# Directory API</a>.

328

},

329

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

330

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

331

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

332

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

333

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

334

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

335

# of this field will be SHARED_DRIVE only.

336

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

337

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

338

},

339

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

340

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

341

# For more information, see

342

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

343

# Zone</a>.

344

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

345

# specified.

346

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

347

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

"A String",

],

},

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

352

# account_info needs to be specified.

353

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

"A String",

],

},

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

358

# to be specified.

359

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

360

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

"A String",

],

},

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

365

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

366

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

367

# rounded down to the given date.

368

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

369

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

370

},

371

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

372

# rounded down to the start of the given date.

373

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

374

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

375

# rounded down to the start of the given date.

376

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

Bu Sun Kim

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

[diff] [blame]

377

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

378

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

379

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

380

# id in the URL.

381

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

382

# created.

383

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

384

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

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-27 12:20:54 -0700

[diff] [blame]

410

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

411

# query.

412

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

413

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

414

# specified. (read-only)

415

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

420

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

421

},

422

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

423

# to be specified.

424

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

425

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

426

# Directory API</a>.

427

},

428

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

429

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

430

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

431

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

432

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

433

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

434

# of this field will be SHARED_DRIVE only.

435

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

436

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

437

},

438

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

439

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

440

# For more information, see

441

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

442

# Zone</a>.

443

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

444

# specified.

445

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

446

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

"A String",

],

},

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

451

# account_info needs to be specified.

452

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

"A String",

],

},

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

457

# to be specified.

458

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

459

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

"A String",

],

},

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

464

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

465

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

466

# rounded down to the given date.

467

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

468

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

469

},

470

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

471

# rounded down to the start of the given date.

472

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

473

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

474

# rounded down to the start of the given date.

475

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

Bu Sun Kim

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

[diff] [blame]

476

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

477

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

478

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

479

# id in the URL.

480

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

481

# created.

482

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

483

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

Bu Sun Kim

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

[diff] [blame]

484

},

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