Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / alertcenter_v1beta1.alerts.html
blob: 428d78a69047144fa08ac3bb8462aae2304b4202 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="alertcenter_v1beta1.html">G Suite Alert Center API</a> . <a href="alertcenter_v1beta1.alerts.html">alerts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="alertcenter_v1beta1.alerts.feedback.html">feedback()</a></code>
79</p>
80<p class="firstline">Returns the feedback Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Performs batch delete operation on alerts.</p>
85<p class="toc_element">
86 <code><a href="#batchUndelete">batchUndelete(body=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Performs batch undelete operation on alerts.</p>
88<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <code><a href="#delete">delete(alertId, customerId=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Marks the specified alert for deletion. An alert that has been marked for</p>
91<p class="toc_element">
92 <code><a href="#get">get(alertId, customerId=None, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets the specified alert. Attempting to get a nonexistent alert returns</p>
94<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]95 <code><a href="#getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Returns the metadata of an alert. Attempting to get metadata for</p>
97<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <code><a href="#list">list(orderBy=None, pageSize=None, pageToken=None, customerId=None, x__xgafv=None, filter=None)</a></code></p>
99<p class="firstline">Lists the alerts.</p>
100<p class="toc_element">
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<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 <code><a href="#undelete">undelete(alertId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105<p class="firstline">Restores, or "undeletes", an alert that was marked for deletion within the</p>
106<h3>Method Details</h3>
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
109 <pre>Performs batch delete operation on alerts.
110
111Args:
112 body: object, The request body.
113 The object takes the form of:
114
115{ # A request to perform batch delete on alerts.
116 "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the
117 # customer the alerts are associated with.
118 "alertId": [ # Required. list of alert IDs.
119 "A String",
120 ],
121 }
122
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128Returns:
129 An object of the form:
130
131 { # Response to batch delete operation on alerts.
132 "failedAlertStatus": { # The status details for each failed alert_id.
133 "a_key": { # The `Status` type defines a logical error model that is suitable for
134 # different programming environments, including REST APIs and RPC APIs. It is
135 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
136 # three pieces of data: error code, error message, and error details.
137 #
138 # You can find out more about this error model and how to work with it in the
139 # [API Design Guide](https://cloud.google.com/apis/design/errors).
140 "message": "A String", # A developer-facing error message, which should be in English. Any
141 # user-facing error message should be localized and sent in the
142 # google.rpc.Status.details field, or localized by the client.
143 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
144 "details": [ # A list of messages that carry the error details. There is a common set of
145 # message types for APIs to use.
146 {
147 "a_key": "", # Properties of the object. Contains field @type with type URL.
148 },
149 ],
150 },
151 },
152 "successAlertIds": [ # The successful list of alert IDs.
153 "A String",
154 ],
155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="batchUndelete">batchUndelete(body=None, x__xgafv=None)</code>
160 <pre>Performs batch undelete operation on alerts.
161
162Args:
163 body: object, The request body.
164 The object takes the form of:
165
166{ # A request to perform batch undelete on alerts.
167 "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the
168 # customer the alerts are associated with.
169 "alertId": [ # Required. list of alert IDs.
170 "A String",
171 ],
172 }
173
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179Returns:
180 An object of the form:
181
182 { # Response to batch undelete operation on alerts.
183 "failedAlertStatus": { # The status details for each failed alert_id.
184 "a_key": { # The `Status` type defines a logical error model that is suitable for
185 # different programming environments, including REST APIs and RPC APIs. It is
186 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
187 # three pieces of data: error code, error message, and error details.
188 #
189 # You can find out more about this error model and how to work with it in the
190 # [API Design Guide](https://cloud.google.com/apis/design/errors).
191 "message": "A String", # A developer-facing error message, which should be in English. Any
192 # user-facing error message should be localized and sent in the
193 # google.rpc.Status.details field, or localized by the client.
194 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
195 "details": [ # A list of messages that carry the error details. There is a common set of
196 # message types for APIs to use.
197 {
198 "a_key": "", # Properties of the object. Contains field @type with type URL.
199 },
200 ],
201 },
202 },
203 "successAlertIds": [ # The successful list of alert IDs.
204 "A String",
205 ],
206 }</pre>
207</div>
208
209<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 <code class="details" id="delete">delete(alertId, customerId=None, x__xgafv=None)</code>
211 <pre>Marks the specified alert for deletion. An alert that has been marked for
212deletion is removed from Alert Center after 30 days.
213Marking an alert for deletion has no effect on an alert which has
214already been marked for deletion. Attempting to mark a nonexistent alert
215for deletion results in a `NOT_FOUND` error.
216
217Args:
218 alertId: string, Required. The identifier of the alert to delete. (required)
219 customerId: string, Optional. The unique identifier of the G Suite organization account of the
220customer the alert is associated with.
221Inferred from the caller identity if not provided.
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
230 { # A generic empty message that you can re-use to avoid defining duplicated
231 # empty messages in your APIs. A typical example is to use it as the request
232 # or the response type of an API method. For instance:
233 #
234 # service Foo {
235 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
236 # }
237 #
238 # The JSON representation for `Empty` is empty JSON object `{}`.
239 }</pre>
240</div>
241
242<div class="method">
243 <code class="details" id="get">get(alertId, customerId=None, x__xgafv=None)</code>
244 <pre>Gets the specified alert. Attempting to get a nonexistent alert returns
245`NOT_FOUND` error.
246
247Args:
248 alertId: string, Required. The identifier of the alert to retrieve. (required)
249 customerId: string, Optional. The unique identifier of the G Suite organization account of the
250customer the alert is associated with.
251Inferred from the caller identity if not provided.
252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
260 { # An alert affecting a customer.
261 "updateTime": "A String", # Output only. The time this alert was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active.
263 # If provided, the end time must not be earlier than the start time.
264 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "alertId": "A String", # Output only. The unique identifier for the alert.
266 "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 "data": { # Optional. The data associated with this alert, for example
268 # google.apps.alertcenter.type.DeviceCompromised.
269 "a_key": "", # Properties of the object. Contains field @type with type URL.
270 },
271 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 "source": "A String", # Required. A unique identifier for the system that reported the alert.
273 # This is output only after alert is created.
274 #
275 # Supported sources are any of the following:
276 #
277 # * Google Operations
278 # * Mobile device management
279 # * Gmail phishing
280 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 # * Google identity
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]283 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help
284 # prevent simultaneous updates of an alert from overwriting each other.
285 # It is strongly suggested that systems make use of the `etag` in the
286 # read-modify-write cycle to perform alert updates in order to avoid race
287 # conditions: An `etag` is returned in the response which contains alerts,
288 # and systems are expected to put that etag in the request to update alert to
289 # ensure that their change will be applied to the same version of the alert.
290 #
291 # If no `etag` is provided in the call to update alert, then the existing
292 # alert is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "startTime": "A String", # Required. The time the event that caused this alert was started or
294 # detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]295 "metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
296 "status": "A String", # The current status of the alert.
297 # The supported values are the following:
298 #
299 # * NOT_STARTED
300 # * IN_PROGRESS
301 # * CLOSED
302 "updateTime": "A String", # Output only. The time this metadata was last updated.
303 "severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
304 # creation time, default's to an empty string when it could not be
305 # determined.
306 # The supported values for update actions on this field are the following:
307 #
308 # * HIGH
309 # * MEDIUM
310 # * LOW
311 "alertId": "A String", # Output only. The alert identifier.
312 "assignee": "A String", # The email address of the user assigned to the alert.
313 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to
314 # help prevent simultaneous updates of an alert metadata from overwriting
315 # each other. It is strongly suggested that systems make use of the `etag` in
316 # the read-modify-write cycle to perform metatdata updates in order to avoid
317 # race conditions: An `etag` is returned in the response which contains alert
318 # metadata, and systems are expected to put that etag in the request to
319 # update alert metadata to ensure that their change will be applied to the
320 # same version of the alert metadata.
321 #
322 # If no `etag` is provided in the call to update alert metadata, then the
323 # existing alert metadata is overwritten blindly.
324 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]326 "type": "A String", # Required. The type of the alert.
327 # This is output only after alert is created.
328 # For a list of available alert types see
329 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
330 "createTime": "A String", # Output only. The time this alert was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 "securityInvestigationToolLink": "A String", # Output only. An optional
332 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
333 # query for this alert.
334 }</pre>
335</div>
336
337<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 <code class="details" id="getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</code>
339 <pre>Returns the metadata of an alert. Attempting to get metadata for
340a non-existent alert returns `NOT_FOUND` error.
341
342Args:
343 alertId: string, Required. The identifier of the alert this metadata belongs to. (required)
344 customerId: string, Optional. The unique identifier of the G Suite organization account of the
345customer the alert metadata is associated with.
346Inferred from the caller identity if not provided.
347 x__xgafv: string, V1 error format.
348 Allowed values
349 1 - v1 error format
350 2 - v2 error format
351
352Returns:
353 An object of the form:
354
355 { # An alert metadata.
356 "status": "A String", # The current status of the alert.
357 # The supported values are the following:
358 #
359 # * NOT_STARTED
360 # * IN_PROGRESS
361 # * CLOSED
362 "updateTime": "A String", # Output only. The time this metadata was last updated.
363 "severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
364 # creation time, default's to an empty string when it could not be
365 # determined.
366 # The supported values for update actions on this field are the following:
367 #
368 # * HIGH
369 # * MEDIUM
370 # * LOW
371 "alertId": "A String", # Output only. The alert identifier.
372 "assignee": "A String", # The email address of the user assigned to the alert.
373 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to
374 # help prevent simultaneous updates of an alert metadata from overwriting
375 # each other. It is strongly suggested that systems make use of the `etag` in
376 # the read-modify-write cycle to perform metatdata updates in order to avoid
377 # race conditions: An `etag` is returned in the response which contains alert
378 # metadata, and systems are expected to put that etag in the request to
379 # update alert metadata to ensure that their change will be applied to the
380 # same version of the alert metadata.
381 #
382 # If no `etag` is provided in the call to update alert metadata, then the
383 # existing alert metadata is overwritten blindly.
384 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
385 }</pre>
386</div>
387
388<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 <code class="details" id="list">list(orderBy=None, pageSize=None, pageToken=None, customerId=None, x__xgafv=None, filter=None)</code>
390 <pre>Lists the alerts.
391
392Args:
393 orderBy: string, Optional. The sort order of the list results.
394If not specified results may be returned in arbitrary order.
395You can sort the results in descending order based on the creation
396timestamp using `order_by="create_time desc"`.
397Currently, supported sorting are `create_time asc`, `create_time desc`,
398`update_time desc`
399 pageSize: integer, Optional. The requested page size. Server may return fewer items than
400requested. If unspecified, server picks an appropriate default.
401 pageToken: string, Optional. A token identifying a page of results the server should return.
402If empty, a new iteration is started. To continue an iteration, pass in
403the value from the previous ListAlertsResponse's
404next_page_token field.
405 customerId: string, Optional. The unique identifier of the G Suite organization account of the
406customer the alerts are associated with.
407Inferred from the caller identity if not provided.
408 x__xgafv: string, V1 error format.
409 Allowed values
410 1 - v1 error format
411 2 - v2 error format
412 filter: string, Optional. A query string for filtering alert results.
413For more details, see [Query
414filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported
415query filter
416fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
417
418Returns:
419 An object of the form:
420
421 { # Response message for an alert listing request.
422 "nextPageToken": "A String", # The token for the next page. If not empty, indicates that there may be more
423 # alerts that match the listing request; this value can be used in a
424 # subsequent ListAlertsRequest to get alerts continuing from last result
425 # of the current list call.
426 "alerts": [ # The list of alerts.
427 { # An alert affecting a customer.
428 "updateTime": "A String", # Output only. The time this alert was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]429 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active.
430 # If provided, the end time must not be earlier than the start time.
431 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 "alertId": "A String", # Output only. The unique identifier for the alert.
433 "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "data": { # Optional. The data associated with this alert, for example
435 # google.apps.alertcenter.type.DeviceCompromised.
436 "a_key": "", # Properties of the object. Contains field @type with type URL.
437 },
438 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]439 "source": "A String", # Required. A unique identifier for the system that reported the alert.
440 # This is output only after alert is created.
441 #
442 # Supported sources are any of the following:
443 #
444 # * Google Operations
445 # * Mobile device management
446 # * Gmail phishing
447 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 # * Google identity
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help
451 # prevent simultaneous updates of an alert from overwriting each other.
452 # It is strongly suggested that systems make use of the `etag` in the
453 # read-modify-write cycle to perform alert updates in order to avoid race
454 # conditions: An `etag` is returned in the response which contains alerts,
455 # and systems are expected to put that etag in the request to update alert to
456 # ensure that their change will be applied to the same version of the alert.
457 #
458 # If no `etag` is provided in the call to update alert, then the existing
459 # alert is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 "startTime": "A String", # Required. The time the event that caused this alert was started or
461 # detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 "metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
463 "status": "A String", # The current status of the alert.
464 # The supported values are the following:
465 #
466 # * NOT_STARTED
467 # * IN_PROGRESS
468 # * CLOSED
469 "updateTime": "A String", # Output only. The time this metadata was last updated.
470 "severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
471 # creation time, default's to an empty string when it could not be
472 # determined.
473 # The supported values for update actions on this field are the following:
474 #
475 # * HIGH
476 # * MEDIUM
477 # * LOW
478 "alertId": "A String", # Output only. The alert identifier.
479 "assignee": "A String", # The email address of the user assigned to the alert.
480 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to
481 # help prevent simultaneous updates of an alert metadata from overwriting
482 # each other. It is strongly suggested that systems make use of the `etag` in
483 # the read-modify-write cycle to perform metatdata updates in order to avoid
484 # race conditions: An `etag` is returned in the response which contains alert
485 # metadata, and systems are expected to put that etag in the request to
486 # update alert metadata to ensure that their change will be applied to the
487 # same version of the alert metadata.
488 #
489 # If no `etag` is provided in the call to update alert metadata, then the
490 # existing alert metadata is overwritten blindly.
491 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]493 "type": "A String", # Required. The type of the alert.
494 # This is output only after alert is created.
495 # For a list of available alert types see
496 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
497 "createTime": "A String", # Output only. The time this alert was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 "securityInvestigationToolLink": "A String", # Output only. An optional
499 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
500 # query for this alert.
501 },
502 ],
503 }</pre>
504</div>
505
506<div class="method">
507 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
508 <pre>Retrieves the next page of results.
509
510Args:
511 previous_request: The request for the previous page. (required)
512 previous_response: The response from the request for the previous page. (required)
513
514Returns:
515 A request object that you can call 'execute()' on to request the next
516 page. Returns None if there are no more items in the collection.
517 </pre>
518</div>
519
520<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 <code class="details" id="undelete">undelete(alertId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]522 <pre>Restores, or "undeletes", an alert that was marked for deletion within the
523past 30 days. Attempting to undelete an alert which was marked for deletion
524over 30 days ago (which has been removed from the Alert Center database) or
525a nonexistent alert returns a `NOT_FOUND` error. Attempting to
526undelete an alert which has not been marked for deletion has no effect.
527
528Args:
529 alertId: string, Required. The identifier of the alert to undelete. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]530 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531 The object takes the form of:
532
533{ # A request to undelete a specific alert that was marked for deletion.
534 "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the
535 # customer the alert is associated with.
536 # Inferred from the caller identity if not provided.
537 }
538
539 x__xgafv: string, V1 error format.
540 Allowed values
541 1 - v1 error format
542 2 - v2 error format
543
544Returns:
545 An object of the form:
546
547 { # An alert affecting a customer.
548 "updateTime": "A String", # Output only. The time this alert was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]549 "endTime": "A String", # Optional. The time the event that caused this alert ceased being active.
550 # If provided, the end time must not be earlier than the start time.
551 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 "alertId": "A String", # Output only. The unique identifier for the alert.
553 "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]554 "data": { # Optional. The data associated with this alert, for example
555 # google.apps.alertcenter.type.DeviceCompromised.
556 "a_key": "", # Properties of the object. Contains field @type with type URL.
557 },
558 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]559 "source": "A String", # Required. A unique identifier for the system that reported the alert.
560 # This is output only after alert is created.
561 #
562 # Supported sources are any of the following:
563 #
564 # * Google Operations
565 # * Mobile device management
566 # * Gmail phishing
567 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]568 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 # * Google identity
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]570 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to help
571 # prevent simultaneous updates of an alert from overwriting each other.
572 # It is strongly suggested that systems make use of the `etag` in the
573 # read-modify-write cycle to perform alert updates in order to avoid race
574 # conditions: An `etag` is returned in the response which contains alerts,
575 # and systems are expected to put that etag in the request to update alert to
576 # ensure that their change will be applied to the same version of the alert.
577 #
578 # If no `etag` is provided in the call to update alert, then the existing
579 # alert is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 "startTime": "A String", # Required. The time the event that caused this alert was started or
581 # detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]582 "metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
583 "status": "A String", # The current status of the alert.
584 # The supported values are the following:
585 #
586 # * NOT_STARTED
587 # * IN_PROGRESS
588 # * CLOSED
589 "updateTime": "A String", # Output only. The time this metadata was last updated.
590 "severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
591 # creation time, default's to an empty string when it could not be
592 # determined.
593 # The supported values for update actions on this field are the following:
594 #
595 # * HIGH
596 # * MEDIUM
597 # * LOW
598 "alertId": "A String", # Output only. The alert identifier.
599 "assignee": "A String", # The email address of the user assigned to the alert.
600 "etag": "A String", # Optional. `etag` is used for optimistic concurrency control as a way to
601 # help prevent simultaneous updates of an alert metadata from overwriting
602 # each other. It is strongly suggested that systems make use of the `etag` in
603 # the read-modify-write cycle to perform metatdata updates in order to avoid
604 # race conditions: An `etag` is returned in the response which contains alert
605 # metadata, and systems are expected to put that etag in the request to
606 # update alert metadata to ensure that their change will be applied to the
607 # same version of the alert metadata.
608 #
609 # If no `etag` is provided in the call to update alert metadata, then the
610 # existing alert metadata is overwritten blindly.
611 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]613 "type": "A String", # Required. The type of the alert.
614 # This is output only after alert is created.
615 # For a list of available alert types see
616 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
617 "createTime": "A String", # Output only. The time this alert was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 "securityInvestigationToolLink": "A String", # Output only. An optional
619 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
620 # query for this alert.
621 }</pre>
622</div>
623
624</body></html>