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

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

[diff] [blame]

83

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

Dmitry Frenkel

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

[diff] [blame]

84

<p class="firstline">Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.</p>

85

86

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

87

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

Bu Sun Kim

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

[diff] [blame]

88

Dan O'Meara

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

[diff] [blame]

89

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

90

<p class="firstline">Creates a hold in the given matter.</p>

91

92

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

93

<p class="firstline">Removes a hold by ID. This will release any HeldAccounts on this Hold.</p>

94

Bu Sun Kim

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

[diff] [blame]

95

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

Bu Sun Kim

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

[diff] [blame]

96

97

Yoshi Automation Bot

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

[diff] [blame]

98

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

Dmitry Frenkel

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

101

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

102

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

103

Dan O'Meara

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

[diff] [blame]

104

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

Dmitry Frenkel

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

[diff] [blame]

105

<p class="firstline">Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.</p>

Bu Sun Kim

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

[diff] [blame]

106

Dan O'Meara

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

[diff] [blame]

107

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

Dmitry Frenkel

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

[diff] [blame]

108

<p class="firstline">Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.</p>

Bu Sun Kim

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

[diff] [blame]

109

<h3>Method Details</h3>

110

Dan O'Meara

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

[diff] [blame]

111

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

Dmitry Frenkel

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

[diff] [blame]

112

<pre>Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.

Bu Sun Kim

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

[diff] [blame]

113

114

Args:

115

matterId: string, The matter ID. (required)

116

holdId: string, The hold ID. (required)

Dan O'Meara

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

[diff] [blame]

117

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

118

The object takes the form of:

119

120

{ # Add a list of accounts to a hold.

Yoshi Automation Bot

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

[diff] [blame]

121

"emails": [ # Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.

Bu Sun Kim

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

[diff] [blame]

122

"A String",

123

],

Yoshi Automation Bot

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

[diff] [blame]

124

"accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.

Bu Sun Kim

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

[diff] [blame]

125

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

136

137

{ # Response for batch create held accounts.

Bu Sun Kim

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

[diff] [blame]

138

"responses": [ # The list of responses, in the same order as the batch request.

Dmitry Frenkel

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

[diff] [blame]

139

{ # A status detailing the status of each account creation, and the HeldAccount, if successful.

Yoshi Automation Bot

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

[diff] [blame]

140

"account": { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. # If present, this account was successfully created.

141

"firstName": "A String", # Output only. The first name of the account holder.

142

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

143

"holdTime": "A String", # Output only. When the account was put on hold.

144

"lastName": "A String", # Output only. The last name of the account holder.

145

"accountId": "A String", # The account's ID as provided by the Admin SDK.

146

},

Dmitry Frenkel

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

[diff] [blame]

147

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # This represents the success status. If failed, check message.

Yoshi Automation Bot

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

[diff] [blame]

148

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

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

[diff] [blame]

149

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

150

{

Bu Sun Kim

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

[diff] [blame]

151

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

152

},

153

],

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

154

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

155

},

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

162

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

163

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

167

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

168

<pre>Creates a hold in the given matter.

169

170

Args:

171

matterId: string, The matter ID. (required)

Dan O'Meara

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

[diff] [blame]

172

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

173

The object takes the form of:

174

Dmitry Frenkel

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

[diff] [blame]

175

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

176

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

177

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

178

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

179

},

Yoshi Automation Bot

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

[diff] [blame]

180

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

181

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

182

"firstName": "A String", # Output only. The first name of the account holder.

183

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

184

"holdTime": "A String", # Output only. When the account was put on hold.

185

"lastName": "A String", # Output only. The last name of the account holder.

186

"accountId": "A String", # The account's ID as provided by the Admin SDK.

187

},

188

],

189

"name": "A String", # The name of the hold.

190

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

191

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

192

"terms": "A String", # The search terms for the hold.

193

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

194

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

195

},

196

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

197

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

198

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

199

},

200

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

201

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

206

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

207

"terms": "A String", # The search terms for the hold.

208

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

209

},

210

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

211

"includeRooms": True or False, # If true, include rooms the user has participated in.

212

},

Bu Sun Kim

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

[diff] [blame]

213

},

Yoshi Automation Bot

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

[diff] [blame]

214

"corpus": "A String", # The corpus to be searched.

215

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

216

"updateTime": "A String", # The last time this hold was modified.

217

}

Bu Sun Kim

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

[diff] [blame]

218

219

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

226

Dmitry Frenkel

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

[diff] [blame]

227

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

228

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

229

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

230

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

231

},

Yoshi Automation Bot

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

[diff] [blame]

232

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

233

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

234

"firstName": "A String", # Output only. The first name of the account holder.

235

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

236

"holdTime": "A String", # Output only. When the account was put on hold.

237

"lastName": "A String", # Output only. The last name of the account holder.

238

"accountId": "A String", # The account's ID as provided by the Admin SDK.

239

},

240

],

241

"name": "A String", # The name of the hold.

242

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

243

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

244

"terms": "A String", # The search terms for the hold.

245

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

246

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

247

},

248

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

249

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

250

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

251

},

252

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

253

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

258

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

259

"terms": "A String", # The search terms for the hold.

260

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

261

},

262

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

263

"includeRooms": True or False, # If true, include rooms the user has participated in.

264

},

Bu Sun Kim

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

[diff] [blame]

265

},

Yoshi Automation Bot

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

[diff] [blame]

266

"corpus": "A String", # The corpus to be searched.

267

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

268

"updateTime": "A String", # The last time this hold was modified.

269

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

274

<pre>Removes a hold by ID. This will release any HeldAccounts on this Hold.

275

276

Args:

277

matterId: string, The matter ID. (required)

278

holdId: string, The hold ID. (required)

279

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

286

Dmitry Frenkel

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

[diff] [blame]

287

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

Bu Sun Kim

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

[diff] [blame]

292

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

Bu Sun Kim

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

[diff] [blame]

293

<pre>Gets a hold by ID.

294

295

Args:

296

matterId: string, The matter ID. (required)

297

holdId: string, The hold ID. (required)

Bu Sun Kim

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

[diff] [blame]

298

view: string, Specifies which parts of the Hold to return.

Dmitry Frenkel

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

[diff] [blame]

299

Allowed values

300

HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.

301

BASIC_HOLD - Response includes the id, name, update time, corpus, and query.

302

FULL_HOLD - Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.

Bu Sun Kim

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

[diff] [blame]

303

x__xgafv: string, V1 error format.

304

Allowed values

305

1 - v1 error format

306

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

307

308

Returns:

309

An object of the form:

310

Dmitry Frenkel

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

[diff] [blame]

311

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

312

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

313

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

314

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

315

},

Yoshi Automation Bot

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

[diff] [blame]

316

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

317

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

318

"firstName": "A String", # Output only. The first name of the account holder.

319

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

320

"holdTime": "A String", # Output only. When the account was put on hold.

321

"lastName": "A String", # Output only. The last name of the account holder.

322

"accountId": "A String", # The account's ID as provided by the Admin SDK.

323

},

324

],

325

"name": "A String", # The name of the hold.

326

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

327

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

328

"terms": "A String", # The search terms for the hold.

329

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

330

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

331

},

332

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

333

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

334

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

335

},

336

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

337

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

342

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

343

"terms": "A String", # The search terms for the hold.

344

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

345

},

346

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

347

"includeRooms": True or False, # If true, include rooms the user has participated in.

348

},

Bu Sun Kim

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

[diff] [blame]

349

},

Yoshi Automation Bot

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

[diff] [blame]

350

"corpus": "A String", # The corpus to be searched.

351

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

352

"updateTime": "A String", # The last time this hold was modified.

353

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

357

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

Dmitry Frenkel

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

[diff] [blame]

358

<pre>Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

Bu Sun Kim

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

[diff] [blame]

359

360

Args:

361

matterId: string, The matter ID. (required)

Yoshi Automation Bot

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

[diff] [blame]

362

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

363

pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

364

view: string, Specifies which parts of the Hold to return.

Dmitry Frenkel

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

[diff] [blame]

365

Allowed values

366

HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.

367

BASIC_HOLD - Response includes the id, name, update time, corpus, and query.

368

FULL_HOLD - Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.

Bu Sun Kim

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

[diff] [blame]

369

x__xgafv: string, V1 error format.

370

Allowed values

371

1 - v1 error format

372

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

373

374

Returns:

375

An object of the form:

376

377

{ # The holds for a matter.

Dmitry Frenkel

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

[diff] [blame]

378

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

Bu Sun Kim

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

[diff] [blame]

379

"holds": [ # The list of holds.

Dmitry Frenkel

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

[diff] [blame]

380

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

381

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

382

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

383

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

384

},

Yoshi Automation Bot

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

[diff] [blame]

385

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

386

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

387

"firstName": "A String", # Output only. The first name of the account holder.

388

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

389

"holdTime": "A String", # Output only. When the account was put on hold.

390

"lastName": "A String", # Output only. The last name of the account holder.

391

"accountId": "A String", # The account's ID as provided by the Admin SDK.

392

},

393

],

394

"name": "A String", # The name of the hold.

395

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

396

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

397

"terms": "A String", # The search terms for the hold.

398

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

399

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

400

},

401

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

402

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

403

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

404

},

405

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

406

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

411

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

412

"terms": "A String", # The search terms for the hold.

413

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

414

},

415

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

416

"includeRooms": True or False, # If true, include rooms the user has participated in.

417

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

418

},

Yoshi Automation Bot

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

[diff] [blame]

419

"corpus": "A String", # The corpus to be searched.

420

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

421

"updateTime": "A String", # The last time this hold was modified.

Bu Sun Kim

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

[diff] [blame]

422

},

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>

429

<pre>Retrieves the next page of results.

430

431

Args:

432

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

433

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

434

435

Returns:

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

442

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

Dmitry Frenkel

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

[diff] [blame]

443

<pre>Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

Bu Sun Kim

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

[diff] [blame]

444

445

Args:

446

matterId: string, The matter ID. (required)

447

holdId: string, The hold ID. (required)

Dan O'Meara

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

[diff] [blame]

448

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

449

The object takes the form of:

450

451

{ # Remove a list of accounts from a hold.

Bu Sun Kim

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

[diff] [blame]

452

"accountIds": [ # Account IDs to identify HeldAccounts to remove.

453

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

464

465

{ # Response for batch delete held accounts.

Dmitry Frenkel

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

[diff] [blame]

466

"statuses": [ # A list of statuses for deleted accounts. Results have the same order as the request.

467

{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Yoshi Automation Bot

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

[diff] [blame]

468

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Dmitry Frenkel

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

[diff] [blame]

469

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

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

[diff] [blame]

470

{

Bu Sun Kim

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

[diff] [blame]

471

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

472

},

473

],

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

474

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

481

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

Dmitry Frenkel

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

[diff] [blame]

482

<pre>Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.

Bu Sun Kim

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

[diff] [blame]

483

484

Args:

485

matterId: string, The matter ID. (required)

486

holdId: string, The ID of the hold. (required)

Dan O'Meara

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

[diff] [blame]

487

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

488

The object takes the form of:

489

Dmitry Frenkel

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

[diff] [blame]

490

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

491

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

492

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

493

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

494

},

Yoshi Automation Bot

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

[diff] [blame]

495

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

496

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

497

"firstName": "A String", # Output only. The first name of the account holder.

498

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

499

"holdTime": "A String", # Output only. When the account was put on hold.

500

"lastName": "A String", # Output only. The last name of the account holder.

501

"accountId": "A String", # The account's ID as provided by the Admin SDK.

502

},

503

],

504

"name": "A String", # The name of the hold.

505

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

506

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

507

"terms": "A String", # The search terms for the hold.

508

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

509

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

510

},

511

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

512

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

513

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

514

},

515

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

516

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

521

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

522

"terms": "A String", # The search terms for the hold.

523

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

524

},

525

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

526

"includeRooms": True or False, # If true, include rooms the user has participated in.

527

},

Bu Sun Kim

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

[diff] [blame]

528

},

Yoshi Automation Bot

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

[diff] [blame]

529

"corpus": "A String", # The corpus to be searched.

530

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

531

"updateTime": "A String", # The last time this hold was modified.

532

}

Bu Sun Kim

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

[diff] [blame]

533

534

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

541

Dmitry Frenkel

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

[diff] [blame]

542

{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Yoshi Automation Bot

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

[diff] [blame]

543

"orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.

544

"holdTime": "A String", # When the org unit was put on hold. This property is immutable.

545

"orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.

Bu Sun Kim

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

[diff] [blame]

546

},

Yoshi Automation Bot

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

[diff] [blame]

547

"accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.

548

{ # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.

549

"firstName": "A String", # Output only. The first name of the account holder.

550

"email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.

551

"holdTime": "A String", # Output only. When the account was put on hold.

552

"lastName": "A String", # Output only. The last name of the account holder.

553

"accountId": "A String", # The account's ID as provided by the Admin SDK.

554

},

555

],

556

"name": "A String", # The name of the hold.

557

"query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.

558

"groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.

559

"terms": "A String", # The search terms for the hold.

560

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

561

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

562

},

563

"driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.

564

"includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.

565

"includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.

566

},

567

"voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.

568

"coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.

"A String",

],

},

"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.

573

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

574

"terms": "A String", # The search terms for the hold.

575

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

576

},

577

"hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

578

"includeRooms": True or False, # If true, include rooms the user has participated in.

579

},

Bu Sun Kim

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

[diff] [blame]

580

},

Yoshi Automation Bot

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

[diff] [blame]

581

"corpus": "A String", # The corpus to be searched.

582

"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.

583

"updateTime": "A String", # The last time this hold was modified.

584

}</pre>

Bu Sun Kim