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.

Dmitry Frenkel

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

[diff] [blame^]

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

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

119

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

120

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

Bu Sun Kim

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

[diff] [blame]

121

},

Dmitry Frenkel

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

[diff] [blame^]

122

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

123

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

124

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

125

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

130

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

131

},

132

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

133

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

134

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

"A String",

],

},

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

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

],

},

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

145

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

146

},

147

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

148

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

149

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

154

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

155

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

156

},

157

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

158

},

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.

Dmitry Frenkel

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

[diff] [blame^]

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

180

},

Dmitry Frenkel

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

[diff] [blame^]

181

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

182

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

183

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

184

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

189

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

190

},

191

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

192

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

193

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

"A String",

],

},

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

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

],

},

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

204

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

205

},

206

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

207

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

208

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

213

"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

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

217

},

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.

Dmitry Frenkel

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

[diff] [blame^]

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

Bu Sun Kim

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

[diff] [blame]

266

},

Dmitry Frenkel

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

[diff] [blame^]

267

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

268

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

269

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

270

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

275

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

276

},

277

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

278

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

279

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

"A String",

],

},

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

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

],

},

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

290

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

291

},

292

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

293

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

294

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

299

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

300

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

301

},

302

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

303

},

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

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.

Dmitry Frenkel

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

[diff] [blame^]

324

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

325

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

Bu Sun Kim

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

[diff] [blame]

326

{ # Definition of the saved query.

Dmitry Frenkel

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

[diff] [blame^]

327

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

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

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

331

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

332

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

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.

Bu Sun Kim

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

[diff] [blame]

337

},

Dmitry Frenkel

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

[diff] [blame^]

338

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

339

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

340

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

341

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

346

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

347

},

348

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

349

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

350

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

"A String",

],

},

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

355

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

356

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

"A String",

],

},

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

361

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

362

},

363

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

364

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

365

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

370

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

371

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

372

},

373

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

Bu Sun Kim

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

[diff] [blame]

374

},

Dmitry Frenkel

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

[diff] [blame^]

375

},

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>

382

<pre>Retrieves the next page of results.

383

384

Args:

385

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

386

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

387

388

Returns:

Bu Sun Kim

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

[diff] [blame]

389

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

Bu Sun Kim