Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / alertcenter_v1beta1.alerts.html
blob: 90143a1c955f6703b2bb3c579120e26fc27dd4cb [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]89 <code><a href="#close">close()</a></code></p>
90<p class="firstline">Close httplib2 connections.</p>
91<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <code><a href="#delete">delete(alertId, customerId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93<p class="firstline">Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="toc_element">
95 <code><a href="#get">get(alertId, customerId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96<p class="firstline">Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 <code><a href="#getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99<p class="firstline">Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]101 <code><a href="#list">list(pageToken=None, pageSize=None, customerId=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102<p class="firstline">Lists the alerts.</p>
103<p class="toc_element">
104 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
105<p class="firstline">Retrieves the next page of results.</p>
106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 <code><a href="#undelete">undelete(alertId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108<p class="firstline">Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<h3>Method Details</h3>
110<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
112 <pre>Performs batch delete operation on alerts.
113
114Args:
115 body: object, The request body.
116 The object takes the form of:
117
118{ # A request to perform batch delete on alerts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;alertId&quot;: [ # Required. list of alert IDs.
120 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]122 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 }
124
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # Response to batch delete operation on alerts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;failedAlertStatus&quot;: { # The status details for each failed alert_id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 &quot;a_key&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &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]141 },
142 ],
143 },
144 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]145 &quot;successAlertIds&quot;: [ # The successful list of alert IDs.
146 &quot;A String&quot;,
147 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="batchUndelete">batchUndelete(body=None, x__xgafv=None)</code>
153 <pre>Performs batch undelete operation on alerts.
154
155Args:
156 body: object, The request body.
157 The object takes the form of:
158
159{ # A request to perform batch undelete on alerts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 &quot;alertId&quot;: [ # Required. list of alert IDs.
161 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]162 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]164 }
165
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
174 { # Response to batch undelete operation on alerts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;failedAlertStatus&quot;: { # The status details for each failed alert_id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 &quot;a_key&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]179 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]180 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 &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]182 },
183 ],
184 },
185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;successAlertIds&quot;: [ # The successful list of alert IDs.
187 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]188 ],
189 }</pre>
190</div>
191
192<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 <code class="details" id="close">close()</code>
194 <pre>Close httplib2 connections.</pre>
195</div>
196
197<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 <code class="details" id="delete">delete(alertId, customerId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 <pre>Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200
201Args:
202 alertId: string, Required. The identifier of the alert to delete. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203 customerId: string, Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]212 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 }</pre>
214</div>
215
216<div class="method">
217 <code class="details" id="get">get(alertId, customerId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]218 <pre>Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219
220Args:
221 alertId: string, Required. The identifier of the alert to retrieve. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]222 customerId: string, Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228Returns:
229 An object of the form:
230
231 { # An alert affecting a customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]232 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
233 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]234 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]235 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]236 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]237 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]238 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]239 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]240 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
241 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert creation time, default&#x27;s to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]243 &quot;data&quot;: { # Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
245 },
246 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or detected.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]247 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
248 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
249 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.
250 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
251 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity
252 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
253 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
254 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 }</pre>
256</div>
257
258<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]259 <code class="details" id="getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]260 <pre>Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]261
262Args:
263 alertId: string, Required. The identifier of the alert this metadata belongs to. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]264 customerId: string, Optional. The unique identifier of the G Suite organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]265 x__xgafv: string, V1 error format.
266 Allowed values
267 1 - v1 error format
268 2 - v2 error format
269
270Returns:
271 An object of the form:
272
273 { # An alert metadata.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]274 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]275 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]276 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]277 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]278 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]279 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
280 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert creation time, default&#x27;s to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]281 }</pre>
282</div>
283
284<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]285 <code class="details" id="list">list(pageToken=None, pageSize=None, customerId=None, filter=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]286 <pre>Lists the alerts.
287
288Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]289 pageToken: string, Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse&#x27;s next_page_token field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]290 pageSize: integer, Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]291 customerId: string, Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]292 filter: string, Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
293 orderBy: string, Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by=&quot;create_time desc&quot;`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298
299Returns:
300 An object of the form:
301
302 { # Response message for an alert listing request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;alerts&quot;: [ # The list of alerts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 { # An alert affecting a customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]305 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
306 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]308 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]309 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]310 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]311 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]312 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]313 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
314 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert creation time, default&#x27;s to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]316 &quot;data&quot;: { # Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
317 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
318 },
319 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or detected.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]320 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
321 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
322 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.
323 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
324 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity
325 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
326 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
327 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 },
329 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]330 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
336 <pre>Retrieves the next page of results.
337
338Args:
339 previous_request: The request for the previous page. (required)
340 previous_response: The response from the request for the previous page. (required)
341
342Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]343 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]344 page. Returns None if there are no more items in the collection.
345 </pre>
346</div>
347
348<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349 <code class="details" id="undelete">undelete(alertId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 <pre>Restores, or &quot;undeletes&quot;, an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351
352Args:
353 alertId: string, Required. The identifier of the alert to undelete. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]354 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 The object takes the form of:
356
357{ # A request to undelete a specific alert that was marked for deletion.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]358 &quot;customerId&quot;: &quot;A String&quot;, # Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 }
360
361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
365
366Returns:
367 An object of the form:
368
369 { # An alert affecting a customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]370 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this alert was created.
371 &quot;endTime&quot;: &quot;A String&quot;, # Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]372 &quot;metadata&quot;: { # An alert metadata. # Output only. The metadata associated with this alert.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]373 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this metadata was last updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]374 &quot;assignee&quot;: &quot;A String&quot;, # The email address of the user assigned to the alert.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]375 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]376 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]377 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]378 &quot;status&quot;: &quot;A String&quot;, # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
379 &quot;severity&quot;: &quot;A String&quot;, # The severity value of the alert. Alert Center will set this field at alert creation time, default&#x27;s to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]381 &quot;data&quot;: { # Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
382 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
383 },
384 &quot;startTime&quot;: &quot;A String&quot;, # Required. The time the event that caused this alert was started or detected.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]385 &quot;securityInvestigationToolLink&quot;: &quot;A String&quot;, # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
386 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the alert.
387 &quot;etag&quot;: &quot;A String&quot;, # Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.
388 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
389 &quot;source&quot;: &quot;A String&quot;, # Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity
390 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
391 &quot;deleted&quot;: True or False, # Output only. `True` if this alert is marked for deletion.
392 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this alert was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 }</pre>
394</div>
395
396</body></html>