Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / alertcenter_v1beta1.alerts.html
blob: a889dfb8a53cec8564746b60aed7985870089262 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 <code><a href="#list">list(orderBy=None, pageToken=None, pageSize=None, customerId=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 # customer the alerts are associated with.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;alertId&quot;: [ # Required. list of alert IDs.
119 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;failedAlertStatus&quot;: { # The status details for each failed alert_id.
133 &quot;a_key&quot;: { # The `Status` type defines a logical error model that is suitable for
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]141 # message types for APIs to use.
142 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 },
145 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
147 # user-facing error message should be localized and sent in the
148 # google.rpc.Status.details field, or localized by the client.
149 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]150 },
151 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;successAlertIds&quot;: [ # The successful list of alert IDs.
153 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]168 # customer the alerts are associated with.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;alertId&quot;: [ # Required. list of alert IDs.
170 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;failedAlertStatus&quot;: { # The status details for each failed alert_id.
184 &quot;a_key&quot;: { # The `Status` type defines a logical error model that is suitable for
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192 # message types for APIs to use.
193 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 },
196 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
198 # user-facing error message should be localized and sent in the
199 # google.rpc.Status.details field, or localized by the client.
200 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]201 },
202 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;successAlertIds&quot;: [ # The successful list of alert IDs.
204 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
262 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or
263 # detected.
264 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 # This is output only after alert is created.
266 #
267 # Supported sources are any of the following:
268 #
269 # * Google Operations
270 # * Mobile device management
271 # * Gmail phishing
272 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]273 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 # * Google identity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
276 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert.
277 # This is output only after alert is created.
278 # For a list of available alert types see
279 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
280 &quot;data&quot;: { # Optional. The data associated with this alert, for example
281 # google.apps.alertcenter.type.DeviceCompromised.
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]285 # prevent simultaneous updates of an alert from overwriting each other.
286 # It is strongly suggested that systems make use of the `etag` in the
287 # read-modify-write cycle to perform alert updates in order to avoid race
288 # conditions: An `etag` is returned in the response which contains alerts,
289 # and systems are expected to put that etag in the request to update alert to
290 # ensure that their change will be applied to the same version of the alert.
291 #
292 # If no `etag` is provided in the call to update alert, then the existing
293 # alert is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
295 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert
296 # creation time, default&#x27;s to an empty string when it could not be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 # determined.
298 # The supported values for update actions on this field are the following:
299 #
300 # * HIGH
301 # * MEDIUM
302 # * LOW
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
304 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]305 # help prevent simultaneous updates of an alert metadata from overwriting
306 # each other. It is strongly suggested that systems make use of the `etag` in
307 # the read-modify-write cycle to perform metatdata updates in order to avoid
308 # race conditions: An `etag` is returned in the response which contains alert
309 # metadata, and systems are expected to put that etag in the request to
310 # update alert metadata to ensure that their change will be applied to the
311 # same version of the alert metadata.
312 #
313 # If no `etag` is provided in the call to update alert metadata, then the
314 # existing alert metadata is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
316 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
317 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert.
318 # The supported values are the following:
319 #
320 # * NOT_STARTED
321 # * IN_PROGRESS
322 # * CLOSED
323 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]325 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
326 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
327 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
329 # query for this alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]330 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
331 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active.
332 # If provided, the end time must not be earlier than the start time.
333 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]356 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert
357 # creation time, default&#x27;s to an empty string when it could not be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]358 # determined.
359 # The supported values for update actions on this field are the following:
360 #
361 # * HIGH
362 # * MEDIUM
363 # * LOW
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
365 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]366 # help prevent simultaneous updates of an alert metadata from overwriting
367 # each other. It is strongly suggested that systems make use of the `etag` in
368 # the read-modify-write cycle to perform metatdata updates in order to avoid
369 # race conditions: An `etag` is returned in the response which contains alert
370 # metadata, and systems are expected to put that etag in the request to
371 # update alert metadata to ensure that their change will be applied to the
372 # same version of the alert metadata.
373 #
374 # If no `etag` is provided in the call to update alert metadata, then the
375 # existing alert metadata is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]376 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
377 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
378 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert.
379 # The supported values are the following:
380 #
381 # * NOT_STARTED
382 # * IN_PROGRESS
383 # * CLOSED
384 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]385 }</pre>
386</div>
387
388<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]389 <code class="details" id="list">list(orderBy=None, pageToken=None, pageSize=None, customerId=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]396timestamp using `order_by=&quot;create_time desc&quot;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]397Currently, supported sorting are `create_time asc`, `create_time desc`,
398`update_time desc`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 pageToken: string, Optional. A token identifying a page of results the server should return.
400If empty, a new iteration is started. To continue an iteration, pass in
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]401the value from the previous ListAlertsResponse&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402next_page_token field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]403 pageSize: integer, Optional. The requested page size. Server may return fewer items than
404requested. If unspecified, server picks an appropriate default.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 filter: string, Optional. A query string for filtering alert results.
409For more details, see [Query
410filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported
411query filter
412fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]413 x__xgafv: string, V1 error format.
414 Allowed values
415 1 - v1 error format
416 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417
418Returns:
419 An object of the form:
420
421 { # Response message for an alert listing request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 &quot;alerts&quot;: [ # The list of alerts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 { # An alert affecting a customer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]424 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
425 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or
426 # detected.
427 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 # This is output only after alert is created.
429 #
430 # Supported sources are any of the following:
431 #
432 # * Google Operations
433 # * Mobile device management
434 # * Gmail phishing
435 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 # * Google identity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
439 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert.
440 # This is output only after alert is created.
441 # For a list of available alert types see
442 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
443 &quot;data&quot;: { # Optional. The data associated with this alert, for example
444 # google.apps.alertcenter.type.DeviceCompromised.
445 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
446 },
447 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]448 # prevent simultaneous updates of an alert from overwriting each other.
449 # It is strongly suggested that systems make use of the `etag` in the
450 # read-modify-write cycle to perform alert updates in order to avoid race
451 # conditions: An `etag` is returned in the response which contains alerts,
452 # and systems are expected to put that etag in the request to update alert to
453 # ensure that their change will be applied to the same version of the alert.
454 #
455 # If no `etag` is provided in the call to update alert, then the existing
456 # alert is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]457 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
458 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert
459 # creation time, default&#x27;s to an empty string when it could not be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]460 # determined.
461 # The supported values for update actions on this field are the following:
462 #
463 # * HIGH
464 # * MEDIUM
465 # * LOW
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]466 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
467 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]468 # help prevent simultaneous updates of an alert metadata from overwriting
469 # each other. It is strongly suggested that systems make use of the `etag` in
470 # the read-modify-write cycle to perform metatdata updates in order to avoid
471 # race conditions: An `etag` is returned in the response which contains alert
472 # metadata, and systems are expected to put that etag in the request to
473 # update alert metadata to ensure that their change will be applied to the
474 # same version of the alert metadata.
475 #
476 # If no `etag` is provided in the call to update alert metadata, then the
477 # existing alert metadata is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]478 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
479 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
480 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert.
481 # The supported values are the following:
482 #
483 # * NOT_STARTED
484 # * IN_PROGRESS
485 # * CLOSED
486 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]488 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
489 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
490 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
492 # query for this alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]493 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
494 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active.
495 # If provided, the end time must not be earlier than the start time.
496 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 },
498 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]499 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the next page. If not empty, indicates that there may be more
500 # alerts that match the listing request; this value can be used in a
501 # subsequent ListAlertsRequest to get alerts continuing from last result
502 # of the current list call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]515 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]522 <pre>Restores, or &quot;undeletes&quot;, an alert that was marked for deletion within the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]534 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]548 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
549 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or
550 # detected.
551 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 # This is output only after alert is created.
553 #
554 # Supported sources are any of the following:
555 #
556 # * Google Operations
557 # * Mobile device management
558 # * Gmail phishing
559 # * Domain wide takeout
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]560 # * State sponsored attack
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561 # * Google identity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]562 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
563 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert.
564 # This is output only after alert is created.
565 # For a list of available alert types see
566 # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
567 &quot;data&quot;: { # Optional. The data associated with this alert, for example
568 # google.apps.alertcenter.type.DeviceCompromised.
569 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
570 },
571 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]572 # prevent simultaneous updates of an alert from overwriting each other.
573 # It is strongly suggested that systems make use of the `etag` in the
574 # read-modify-write cycle to perform alert updates in order to avoid race
575 # conditions: An `etag` is returned in the response which contains alerts,
576 # and systems are expected to put that etag in the request to update alert to
577 # ensure that their change will be applied to the same version of the alert.
578 #
579 # If no `etag` is provided in the call to update alert, then the existing
580 # alert is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]581 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
582 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert
583 # creation time, default&#x27;s to an empty string when it could not be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]584 # determined.
585 # The supported values for update actions on this field are the following:
586 #
587 # * HIGH
588 # * MEDIUM
589 # * LOW
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]590 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
591 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]592 # help prevent simultaneous updates of an alert metadata from overwriting
593 # each other. It is strongly suggested that systems make use of the `etag` in
594 # the read-modify-write cycle to perform metatdata updates in order to avoid
595 # race conditions: An `etag` is returned in the response which contains alert
596 # metadata, and systems are expected to put that etag in the request to
597 # update alert metadata to ensure that their change will be applied to the
598 # same version of the alert metadata.
599 #
600 # If no `etag` is provided in the call to update alert metadata, then the
601 # existing alert metadata is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]602 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
603 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
604 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert.
605 # The supported values are the following:
606 #
607 # * NOT_STARTED
608 # * IN_PROGRESS
609 # * CLOSED
610 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]612 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
613 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
614 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]615 # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
616 # query for this alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]617 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
618 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active.
619 # If provided, the end time must not be earlier than the start time.
620 # If not provided, it indicates an ongoing alert.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]621 }</pre>
622</div>
623
624</body></html>