| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.holds.html">holds</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="vault_v1.matters.holds.accounts.html">accounts()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the accounts Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Adds HeldAccounts to a hold. Returns a list of accounts that have been</p> |
| 85 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 87 | <p class="firstline">Creates a hold in the given matter.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Removes a hold by ID. This will release any HeldAccounts on this Hold.</p> |
| 91 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | <code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | <p class="firstline">Gets a hold by ID.</p> |
| 94 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | <code><a href="#list">list(matterId, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 96 | <p class="firstline">Lists holds within a matter. An empty page token in ListHoldsResponse</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 99 | <p class="firstline">Retrieves the next page of results.</p> |
| 100 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | <p class="firstline">Removes HeldAccounts from a hold. Returns a list of statuses in the same</p> |
| 103 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | <code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | <p class="firstline">Updates the OU and/or query parameters of a hold. You cannot add accounts</p> |
| 106 | <h3>Method Details</h3> |
| 107 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <pre>Adds HeldAccounts to a hold. Returns a list of accounts that have been |
| 110 | successfully added. Accounts can only be added to an existing account-based |
| 111 | hold. |
| 112 | |
| 113 | Args: |
| 114 | matterId: string, The matter ID. (required) |
| 115 | holdId: string, The hold ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | The object takes the form of: |
| 118 | |
| 119 | { # Add a list of accounts to a hold. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 121 | # should be specified, but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "A String", |
| 123 | ], |
| 124 | "accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only |
| 125 | # emails should be specified, but not both. |
| 126 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | ], |
| 128 | } |
| 129 | |
| 130 | x__xgafv: string, V1 error format. |
| 131 | Allowed values |
| 132 | 1 - v1 error format |
| 133 | 2 - v2 error format |
| 134 | |
| 135 | Returns: |
| 136 | An object of the form: |
| 137 | |
| 138 | { # Response for batch create held accounts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 139 | "responses": [ # The list of responses, in the same order as the batch request. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 140 | { # A status detailing the status of each account creation, and the |
| 141 | # HeldAccount, if successful. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 142 | "account": { # An account being held in a particular hold. This structure is immutable. # If present, this account was successfully created. |
| 143 | # This can be either a single user or a google group, depending on the corpus. |
| 144 | "firstName": "A String", # Output only. The first name of the account holder. |
| 145 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 146 | "lastName": "A String", # Output only. The last name of the account holder. |
| 147 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 148 | # precedence over account ID. |
| 149 | "accountId": "A String", # The account's ID as provided by the |
| 150 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 151 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "status": { # The `Status` type defines a logical error model that is suitable for # This represents the success status. If failed, check message. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 153 | # different programming environments, including REST APIs and RPC APIs. It is |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 154 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 155 | # three pieces of data: error code, error message, and error details. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 157 | # You can find out more about this error model and how to work with it in the |
| 158 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 159 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 160 | # message types for APIs to use. |
| 161 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 163 | }, |
| 164 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 166 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 167 | # user-facing error message should be localized and sent in the |
| 168 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 170 | }, |
| 171 | ], |
| 172 | }</pre> |
| 173 | </div> |
| 174 | |
| 175 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 176 | <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 177 | <pre>Creates a hold in the given matter. |
| 178 | |
| 179 | Args: |
| 180 | matterId: string, The matter ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 181 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 182 | The object takes the form of: |
| 183 | |
| 184 | { # Represents a hold within Vault. A hold restricts purging of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | # artifacts based on the combination of the query and accounts restrictions. |
| 186 | # A hold can be configured to either apply to an explicitly configured set |
| 187 | # of accounts, or can be applied to all members of an organizational unit. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 188 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 189 | # accounts must be empty. This property is mutable. For groups holds, |
| 190 | # set the accounts field. |
| 191 | # This structure is immutable. |
| 192 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 193 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| 194 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 196 | # type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 197 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 198 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 199 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 200 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 202 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 203 | # rounded down to the start of the given date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 204 | "terms": "A String", # The search terms for the hold. |
| 205 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 206 | # rounded down to the start of the given date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | }, |
| 208 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 209 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 210 | # rounded down to the start of the given date. |
| 211 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 212 | # rounded down to the start of the given date. |
| 213 | "terms": "A String", # The search terms for the hold. |
| 214 | }, |
| 215 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 216 | # Hangouts Chat. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 217 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 218 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 219 | }, |
| 220 | "corpus": "A String", # The corpus to be searched. |
| 221 | "updateTime": "A String", # The last time this hold was modified. |
| 222 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 223 | "name": "A String", # The name of the hold. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 224 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 225 | # empty. |
| 226 | { # An account being held in a particular hold. This structure is immutable. |
| 227 | # This can be either a single user or a google group, depending on the corpus. |
| 228 | "firstName": "A String", # Output only. The first name of the account holder. |
| 229 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 230 | "lastName": "A String", # Output only. The last name of the account holder. |
| 231 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 232 | # precedence over account ID. |
| 233 | "accountId": "A String", # The account's ID as provided by the |
| 234 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 235 | }, |
| 236 | ], |
| 237 | } |
| 238 | |
| 239 | x__xgafv: string, V1 error format. |
| 240 | Allowed values |
| 241 | 1 - v1 error format |
| 242 | 2 - v2 error format |
| 243 | |
| 244 | Returns: |
| 245 | An object of the form: |
| 246 | |
| 247 | { # Represents a hold within Vault. A hold restricts purging of |
| 248 | # artifacts based on the combination of the query and accounts restrictions. |
| 249 | # A hold can be configured to either apply to an explicitly configured set |
| 250 | # of accounts, or can be applied to all members of an organizational unit. |
| 251 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 252 | # accounts must be empty. This property is mutable. For groups holds, |
| 253 | # set the accounts field. |
| 254 | # This structure is immutable. |
| 255 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 256 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| 257 | }, |
| 258 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| 259 | # type. |
| 260 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 261 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 262 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 263 | }, |
| 264 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| 265 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 266 | # rounded down to the start of the given date. |
| 267 | "terms": "A String", # The search terms for the hold. |
| 268 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 269 | # rounded down to the start of the given date. |
| 270 | }, |
| 271 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 272 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 273 | # rounded down to the start of the given date. |
| 274 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 275 | # rounded down to the start of the given date. |
| 276 | "terms": "A String", # The search terms for the hold. |
| 277 | }, |
| 278 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| 279 | # Hangouts Chat. |
| 280 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| 281 | }, |
| 282 | }, |
| 283 | "corpus": "A String", # The corpus to be searched. |
| 284 | "updateTime": "A String", # The last time this hold was modified. |
| 285 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 286 | "name": "A String", # The name of the hold. |
| 287 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 288 | # empty. |
| 289 | { # An account being held in a particular hold. This structure is immutable. |
| 290 | # This can be either a single user or a google group, depending on the corpus. |
| 291 | "firstName": "A String", # Output only. The first name of the account holder. |
| 292 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 293 | "lastName": "A String", # Output only. The last name of the account holder. |
| 294 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 295 | # precedence over account ID. |
| 296 | "accountId": "A String", # The account's ID as provided by the |
| 297 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 298 | }, |
| 299 | ], |
| 300 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 301 | </div> |
| 302 | |
| 303 | <div class="method"> |
| 304 | <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code> |
| 305 | <pre>Removes a hold by ID. This will release any HeldAccounts on this Hold. |
| 306 | |
| 307 | Args: |
| 308 | matterId: string, The matter ID. (required) |
| 309 | holdId: string, The hold ID. (required) |
| 310 | x__xgafv: string, V1 error format. |
| 311 | Allowed values |
| 312 | 1 - v1 error format |
| 313 | 2 - v2 error format |
| 314 | |
| 315 | Returns: |
| 316 | An object of the form: |
| 317 | |
| 318 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 319 | # empty messages in your APIs. A typical example is to use it as the request |
| 320 | # or the response type of an API method. For instance: |
| 321 | # |
| 322 | # service Foo { |
| 323 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 324 | # } |
| 325 | # |
| 326 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 327 | }</pre> |
| 328 | </div> |
| 329 | |
| 330 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 331 | <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 332 | <pre>Gets a hold by ID. |
| 333 | |
| 334 | Args: |
| 335 | matterId: string, The matter ID. (required) |
| 336 | holdId: string, The hold ID. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | view: string, Specifies which parts of the Hold to return. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 338 | x__xgafv: string, V1 error format. |
| 339 | Allowed values |
| 340 | 1 - v1 error format |
| 341 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 342 | |
| 343 | Returns: |
| 344 | An object of the form: |
| 345 | |
| 346 | { # Represents a hold within Vault. A hold restricts purging of |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 347 | # artifacts based on the combination of the query and accounts restrictions. |
| 348 | # A hold can be configured to either apply to an explicitly configured set |
| 349 | # of accounts, or can be applied to all members of an organizational unit. |
| 350 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 351 | # accounts must be empty. This property is mutable. For groups holds, |
| 352 | # set the accounts field. |
| 353 | # This structure is immutable. |
| 354 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 355 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 356 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 357 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| 358 | # type. |
| 359 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 360 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 361 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 362 | }, |
| 363 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| 364 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 365 | # rounded down to the start of the given date. |
| 366 | "terms": "A String", # The search terms for the hold. |
| 367 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 368 | # rounded down to the start of the given date. |
| 369 | }, |
| 370 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 371 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 372 | # rounded down to the start of the given date. |
| 373 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 374 | # rounded down to the start of the given date. |
| 375 | "terms": "A String", # The search terms for the hold. |
| 376 | }, |
| 377 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| 378 | # Hangouts Chat. |
| 379 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| 380 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 381 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 382 | "corpus": "A String", # The corpus to be searched. |
| 383 | "updateTime": "A String", # The last time this hold was modified. |
| 384 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 385 | "name": "A String", # The name of the hold. |
| 386 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 387 | # empty. |
| 388 | { # An account being held in a particular hold. This structure is immutable. |
| 389 | # This can be either a single user or a google group, depending on the corpus. |
| 390 | "firstName": "A String", # Output only. The first name of the account holder. |
| 391 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 392 | "lastName": "A String", # Output only. The last name of the account holder. |
| 393 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 394 | # precedence over account ID. |
| 395 | "accountId": "A String", # The account's ID as provided by the |
| 396 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 397 | }, |
| 398 | ], |
| 399 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 400 | </div> |
| 401 | |
| 402 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 403 | <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 404 | <pre>Lists holds within a matter. An empty page token in ListHoldsResponse |
| 405 | denotes no more holds to list. |
| 406 | |
| 407 | Args: |
| 408 | matterId: string, The matter ID. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 409 | pageToken: string, The pagination token as returned in the response. |
| 410 | An empty token means start from the beginning. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 411 | pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive. |
| 412 | Leaving this empty, or as 0, is the same as page_size = 100. |
| 413 | view: string, Specifies which parts of the Hold to return. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | x__xgafv: string, V1 error format. |
| 415 | Allowed values |
| 416 | 1 - v1 error format |
| 417 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 418 | |
| 419 | Returns: |
| 420 | An object of the form: |
| 421 | |
| 422 | { # The holds for a matter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 423 | "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 424 | # If this is empty, then there are no more holds to list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | "holds": [ # The list of holds. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 426 | { # Represents a hold within Vault. A hold restricts purging of |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 427 | # artifacts based on the combination of the query and accounts restrictions. |
| 428 | # A hold can be configured to either apply to an explicitly configured set |
| 429 | # of accounts, or can be applied to all members of an organizational unit. |
| 430 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 431 | # accounts must be empty. This property is mutable. For groups holds, |
| 432 | # set the accounts field. |
| 433 | # This structure is immutable. |
| 434 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 435 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 436 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 437 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| 438 | # type. |
| 439 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 440 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 441 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 442 | }, |
| 443 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| 444 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 445 | # rounded down to the start of the given date. |
| 446 | "terms": "A String", # The search terms for the hold. |
| 447 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 448 | # rounded down to the start of the given date. |
| 449 | }, |
| 450 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 451 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 452 | # rounded down to the start of the given date. |
| 453 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 454 | # rounded down to the start of the given date. |
| 455 | "terms": "A String", # The search terms for the hold. |
| 456 | }, |
| 457 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| 458 | # Hangouts Chat. |
| 459 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| 460 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 462 | "corpus": "A String", # The corpus to be searched. |
| 463 | "updateTime": "A String", # The last time this hold was modified. |
| 464 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 465 | "name": "A String", # The name of the hold. |
| 466 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 467 | # empty. |
| 468 | { # An account being held in a particular hold. This structure is immutable. |
| 469 | # This can be either a single user or a google group, depending on the corpus. |
| 470 | "firstName": "A String", # Output only. The first name of the account holder. |
| 471 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 472 | "lastName": "A String", # Output only. The last name of the account holder. |
| 473 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 474 | # precedence over account ID. |
| 475 | "accountId": "A String", # The account's ID as provided by the |
| 476 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 477 | }, |
| 478 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 479 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 480 | ], |
| 481 | }</pre> |
| 482 | </div> |
| 483 | |
| 484 | <div class="method"> |
| 485 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 486 | <pre>Retrieves the next page of results. |
| 487 | |
| 488 | Args: |
| 489 | previous_request: The request for the previous page. (required) |
| 490 | previous_response: The response from the request for the previous page. (required) |
| 491 | |
| 492 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 493 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 494 | page. Returns None if there are no more items in the collection. |
| 495 | </pre> |
| 496 | </div> |
| 497 | |
| 498 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 499 | <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 500 | <pre>Removes HeldAccounts from a hold. Returns a list of statuses in the same |
| 501 | order as the request. If this request leaves the hold with no held |
| 502 | accounts, the hold will not apply to any accounts. |
| 503 | |
| 504 | Args: |
| 505 | matterId: string, The matter ID. (required) |
| 506 | holdId: string, The hold ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 507 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 508 | The object takes the form of: |
| 509 | |
| 510 | { # Remove a list of accounts from a hold. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 511 | "accountIds": [ # Account IDs to identify HeldAccounts to remove. |
| 512 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 513 | ], |
| 514 | } |
| 515 | |
| 516 | x__xgafv: string, V1 error format. |
| 517 | Allowed values |
| 518 | 1 - v1 error format |
| 519 | 2 - v2 error format |
| 520 | |
| 521 | Returns: |
| 522 | An object of the form: |
| 523 | |
| 524 | { # Response for batch delete held accounts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | "statuses": [ # A list of statuses for deleted accounts. Results have the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 526 | # same order as the request. |
| 527 | { # The `Status` type defines a logical error model that is suitable for |
| 528 | # different programming environments, including REST APIs and RPC APIs. It is |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 529 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 530 | # three pieces of data: error code, error message, and error details. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 531 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 532 | # You can find out more about this error model and how to work with it in the |
| 533 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 534 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 535 | # message types for APIs to use. |
| 536 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 537 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 538 | }, |
| 539 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 540 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 541 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 542 | # user-facing error message should be localized and sent in the |
| 543 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 544 | }, |
| 545 | ], |
| 546 | }</pre> |
| 547 | </div> |
| 548 | |
| 549 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 550 | <code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 551 | <pre>Updates the OU and/or query parameters of a hold. You cannot add accounts |
| 552 | to a hold that covers an OU, nor can you add OUs to a hold that covers |
| 553 | individual accounts. Accounts listed in the hold will be ignored. |
| 554 | |
| 555 | Args: |
| 556 | matterId: string, The matter ID. (required) |
| 557 | holdId: string, The ID of the hold. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 558 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 559 | The object takes the form of: |
| 560 | |
| 561 | { # Represents a hold within Vault. A hold restricts purging of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 562 | # artifacts based on the combination of the query and accounts restrictions. |
| 563 | # A hold can be configured to either apply to an explicitly configured set |
| 564 | # of accounts, or can be applied to all members of an organizational unit. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 565 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 566 | # accounts must be empty. This property is mutable. For groups holds, |
| 567 | # set the accounts field. |
| 568 | # This structure is immutable. |
| 569 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 570 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| 571 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 572 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | # type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 574 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 575 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 576 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 577 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 579 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 580 | # rounded down to the start of the given date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "terms": "A String", # The search terms for the hold. |
| 582 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 583 | # rounded down to the start of the given date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | }, |
| 585 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 586 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 587 | # rounded down to the start of the given date. |
| 588 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 589 | # rounded down to the start of the given date. |
| 590 | "terms": "A String", # The search terms for the hold. |
| 591 | }, |
| 592 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 593 | # Hangouts Chat. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 594 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 595 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 596 | }, |
| 597 | "corpus": "A String", # The corpus to be searched. |
| 598 | "updateTime": "A String", # The last time this hold was modified. |
| 599 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 600 | "name": "A String", # The name of the hold. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 601 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 602 | # empty. |
| 603 | { # An account being held in a particular hold. This structure is immutable. |
| 604 | # This can be either a single user or a google group, depending on the corpus. |
| 605 | "firstName": "A String", # Output only. The first name of the account holder. |
| 606 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 607 | "lastName": "A String", # Output only. The last name of the account holder. |
| 608 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 609 | # precedence over account ID. |
| 610 | "accountId": "A String", # The account's ID as provided by the |
| 611 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 612 | }, |
| 613 | ], |
| 614 | } |
| 615 | |
| 616 | x__xgafv: string, V1 error format. |
| 617 | Allowed values |
| 618 | 1 - v1 error format |
| 619 | 2 - v2 error format |
| 620 | |
| 621 | Returns: |
| 622 | An object of the form: |
| 623 | |
| 624 | { # Represents a hold within Vault. A hold restricts purging of |
| 625 | # artifacts based on the combination of the query and accounts restrictions. |
| 626 | # A hold can be configured to either apply to an explicitly configured set |
| 627 | # of accounts, or can be applied to all members of an organizational unit. |
| 628 | "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and |
| 629 | # accounts must be empty. This property is mutable. For groups holds, |
| 630 | # set the accounts field. |
| 631 | # This structure is immutable. |
| 632 | "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. |
| 633 | "holdTime": "A String", # When the org unit was put on hold. This property is immutable. |
| 634 | }, |
| 635 | "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus |
| 636 | # type. |
| 637 | "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. |
| 638 | "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. |
| 639 | "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. |
| 640 | }, |
| 641 | "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. |
| 642 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 643 | # rounded down to the start of the given date. |
| 644 | "terms": "A String", # The search terms for the hold. |
| 645 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 646 | # rounded down to the start of the given date. |
| 647 | }, |
| 648 | "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. |
| 649 | "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and |
| 650 | # rounded down to the start of the given date. |
| 651 | "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and |
| 652 | # rounded down to the start of the given date. |
| 653 | "terms": "A String", # The search terms for the hold. |
| 654 | }, |
| 655 | "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be |
| 656 | # Hangouts Chat. |
| 657 | "includeRooms": True or False, # If true, include rooms the user has participated in. |
| 658 | }, |
| 659 | }, |
| 660 | "corpus": "A String", # The corpus to be searched. |
| 661 | "updateTime": "A String", # The last time this hold was modified. |
| 662 | "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. |
| 663 | "name": "A String", # The name of the hold. |
| 664 | "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be |
| 665 | # empty. |
| 666 | { # An account being held in a particular hold. This structure is immutable. |
| 667 | # This can be either a single user or a google group, depending on the corpus. |
| 668 | "firstName": "A String", # Output only. The first name of the account holder. |
| 669 | "holdTime": "A String", # Output only. When the account was put on hold. |
| 670 | "lastName": "A String", # Output only. The last name of the account holder. |
| 671 | "email": "A String", # The primary email address of the account. If used as an input, this takes |
| 672 | # precedence over account ID. |
| 673 | "accountId": "A String", # The account's ID as provided by the |
| 674 | # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. |
| 675 | }, |
| 676 | ], |
| 677 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 678 | </div> |
| 679 | |
| 680 | </body></html> |