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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

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

119

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

120

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

121

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

122

},

123

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

124

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

129

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

130

},

131

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

132

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

"A String",

],

},

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

137

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

138

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

139

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

140

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

145

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

146

},

147

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

148

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

149

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

150

},

151

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

152

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

153

"sharedDriveIds": [ # List of Shared 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.

Bu Sun Kim

6502091

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

[diff] [blame]

158

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

159

}

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

160

161

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

168

169

{ # Definition of the saved query.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

},

182

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

183

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

188

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

189

},

190

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

191

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

"A String",

],

},

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

196

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

197

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

198

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

199

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

204

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

205

},

206

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

207

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

208

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

209

},

210

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

211

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

212

"sharedDriveIds": [ # List of Shared 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.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

217

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

218

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

223

<pre>Deletes a saved query by Id.

224

225

Args:

Dmitry Frenkel

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

[diff] [blame]

226

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]

227

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

Bu Sun Kim

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

[diff] [blame]

228

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

235

Dmitry Frenkel

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

[diff] [blame]

236

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

242

<pre>Retrieves a saved query by Id.

243

244

Args:

Dmitry Frenkel

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

[diff] [blame]

245

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]

246

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

Bu Sun Kim

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

[diff] [blame]

247

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

254

255

{ # Definition of the saved query.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

},

268

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

269

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

274

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

275

},

276

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

277

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

"A String",

],

},

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

282

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

283

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

284

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

285

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

290

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

291

},

292

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

293

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

294

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

295

},

296

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

297

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

298

"sharedDriveIds": [ # List of Shared 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.

Bu Sun Kim

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

[diff] [blame]

303

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

304

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

308

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

309

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

310

311

Args:

Dmitry Frenkel

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

[diff] [blame]

312

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

Bu Sun Kim

6502091

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

[diff] [blame]

313

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

Dmitry Frenkel

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

[diff] [blame]

314

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]

315

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

322

323

{ # Definition of the response for method ListSaveQuery.

Bu Sun Kim

6502091

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

[diff] [blame]

324

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

Bu Sun Kim

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

[diff] [blame]

325

{ # Definition of the saved query.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

},

338

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

339

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

344

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

345

},

346

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

347

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

"A String",

],

},

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

352

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

353

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

354

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

355

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

360

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

361

},

362

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

363

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

364

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

365

},

366

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

367

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

368

"sharedDriveIds": [ # List of Shared 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.

Bu Sun Kim

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

[diff] [blame]

373

},

Bu Sun Kim

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

[diff] [blame]

374

},

375

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

376

"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