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

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

82

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

83

84

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

85

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

86

87

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

88

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

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

90

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

91

<p class="firstline">Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.</p>

Bu Sun Kim

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

[diff] [blame]

92

93

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

94

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

95

<h3>Method Details</h3>

96

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

102

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

103

<pre>Creates a saved query.

104

105

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

106

matterId: string, The matter ID of the parent matter for which the saved query is to be created. (required)

Dan O'Meara

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

[diff] [blame]

107

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

108

The object takes the form of:

109

110

{ # Definition of the saved query.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

111

"matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.

112

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

113

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

114

"method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.

115

"voiceOptions": { # Voice search options # For voice search, specify more options in this field.

116

"coveredData": [ # Datatypes to search

117

"A String",

118

],

Bu Sun Kim

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

[diff] [blame]

119

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

120

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

121

"teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.

"A String",

],

},

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

126

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

127

"sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.

"A String",

],

},

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

132

"versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.

133

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

134

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

135

},

136

"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.

137

"terms": "A String", # The corpus-specific search operators used to generate search results.

138

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

139

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)

140

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

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.

145

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

"A String",

],

},

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

150

"orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.

151

},

152

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

153

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

154

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

155

},

156

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

157

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

158

},

159

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

160

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

161

},

162

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

163

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

164

}

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

165

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

174

{ # Definition of the saved query.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

175

"matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.

176

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

177

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

178

"method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.

179

"voiceOptions": { # Voice search options # For voice search, specify more options in this field.

180

"coveredData": [ # Datatypes to search

181

"A String",

182

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

183

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

184

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

185

"teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.

"A String",

],

},

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

190

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

191

"sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.

"A String",

],

},

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

196

"versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.

197

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

198

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

199

},

200

"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.

201

"terms": "A String", # The corpus-specific search operators used to generate search results.

202

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

203

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)

204

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

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.

209

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

"A String",

],

},

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

214

"orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.

215

},

216

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

217

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

218

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

219

},

220

"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

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

224

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

225

},

226

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

227

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

228

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

233

<pre>Deletes a saved query by Id.

234

235

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

236

matterId: string, The matter ID of the parent matter for which the saved query is to be deleted. (required)

Dan O'Meara

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

[diff] [blame]

237

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

Bu Sun Kim

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

[diff] [blame]

238

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

245

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

246

{ # 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 `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

252

<pre>Retrieves a saved query by Id.

253

254

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

matterId: string, The matter ID of the parent matter for which the saved query is to be retrieved. (required)

Dan O'Meara

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

[diff] [blame]

256

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

Bu Sun Kim

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

[diff] [blame]

257

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

264

265

{ # Definition of the saved query.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

266

"matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.

267

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

268

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

269

"method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.

270

"voiceOptions": { # Voice search options # For voice search, specify more options in this field.

271

"coveredData": [ # Datatypes to search

272

"A String",

273

],

Bu Sun Kim

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

[diff] [blame]

274

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

275

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

276

"teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.

"A String",

],

},

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

281

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

282

"sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.

"A String",

],

},

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

287

"versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.

288

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

289

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

290

},

291

"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.

292

"terms": "A String", # The corpus-specific search operators used to generate search results.

293

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

294

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)

295

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

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.

300

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

"A String",

],

},

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

305

"orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.

306

},

307

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

308

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

309

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

310

},

311

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

312

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

313

},

314

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

315

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

316

},

317

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

318

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

319

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

323

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

324

<pre>Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

Bu Sun Kim

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

[diff] [blame]

325

326

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

327

matterId: string, The matter ID of the parent matter for which the saved queries are to be retrieved. (required)

Bu Sun Kim

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

[diff] [blame]

328

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

329

pageToken: string, The pagination token as returned in the previous response. An empty token means start from the beginning.

Bu Sun Kim

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

[diff] [blame]

330

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

337

338

{ # Definition of the response for method ListSaveQuery.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

339

"nextPageToken": "A String", # Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.

Bu Sun Kim

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

[diff] [blame]

340

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

Bu Sun Kim

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

[diff] [blame]

341

{ # Definition of the saved query.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

342

"matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.

343

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

344

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

345

"method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.

346

"voiceOptions": { # Voice search options # For voice search, specify more options in this field.

347

"coveredData": [ # Datatypes to search

348

"A String",

349

],

Bu Sun Kim

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

[diff] [blame]

350

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

351

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

352

"teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.

"A String",

],

},

"endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

357

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

358

"sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.

"A String",

],

},

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

363

"versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.

364

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

365

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

366

},

367

"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.

368

"terms": "A String", # The corpus-specific search operators used to generate search results.

369

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

370

"hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)

371

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

"A String",

],

},

"accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.

376

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

"A String",

],

},

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

381

"orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.

382

},

383

"startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

384

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

385

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

386

},

387

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

388

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

389

},

390

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

391

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

Bu Sun Kim

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

[diff] [blame]

392

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

393

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

394

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

395

},

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>

402

<pre>Retrieves the next page of results.

403

404

Args:

405

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

406

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

407

408

Returns:

Bu Sun Kim

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

[diff] [blame]

409

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

Bu Sun Kim