docs: update generated docs (#981)
diff --git a/docs/dyn/alertcenter_v1beta1.alerts.html b/docs/dyn/alertcenter_v1beta1.alerts.html
index 366fc3b..b41ede4 100644
--- a/docs/dyn/alertcenter_v1beta1.alerts.html
+++ b/docs/dyn/alertcenter_v1beta1.alerts.html
@@ -95,7 +95,7 @@
<code><a href="#getMetadata">getMetadata(alertId, customerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the metadata of an alert. Attempting to get metadata for</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, pageToken=None, orderBy=None, customerId=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(orderBy=None, customerId=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the alerts.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -113,11 +113,11 @@
The object takes the form of:
{ # A request to perform batch delete on alerts.
+ "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the
+ # customer the alerts are associated with.
"alertId": [ # Required. list of alert IDs.
"A String",
],
- "customerId": "A String", # Optional. The unique identifier of the G Suite organization account of the
- # customer the alerts are associated with.
}
x__xgafv: string, V1 error format.
@@ -129,9 +129,6 @@
An object of the form:
{ # Response to batch delete operation on alerts.
- "successAlertIds": [ # The successful list of alert IDs.
- "A String",
- ],
"failedAlertStatus": { # The status details for each failed alert_id.
"a_key": { # The `Status` type defines a logical error model that is suitable for
# different programming environments, including REST APIs and RPC APIs. It is
@@ -140,18 +137,21 @@
#
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
},
+ "successAlertIds": [ # The successful list of alert IDs.
+ "A String",
+ ],
}</pre>
</div>
@@ -188,13 +188,13 @@
#
# 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -258,20 +258,28 @@
An object of the form:
{ # An alert affecting a customer.
- "startTime": "A String", # Required. The time the event that caused this alert was started or
- # detected.
- "createTime": "A String", # Output only. The time this alert was created.
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
"data": { # Optional. The data associated with this alert, for example
# google.apps.alertcenter.type.DeviceCompromised.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "endTime": "A String", # 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.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "etag": "A String", # 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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or
+ # detected.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "securityInvestigationToolLink": "A String", # Output only. An optional
+ # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
+ # query for this alert.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "alertId": "A String", # Output only. The alert identifier.
- "updateTime": "A String", # Output only. The time this metadata was last updated.
"assignee": "A String", # The email address of the user assigned to the alert.
"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
# creation time, default's to an empty string when it could not be
@@ -281,13 +289,7 @@
# * HIGH
# * MEDIUM
# * LOW
- "status": "A String", # The current status of the alert.
- # The supported values are the following:
- #
- # * NOT_STARTED
- # * IN_PROGRESS
- # * CLOSED
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
"etag": "A String", # 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
@@ -299,6 +301,14 @@
#
# If no `etag` is provided in the call to update alert metadata, then the
# existing alert metadata is overwritten blindly.
+ "alertId": "A String", # Output only. The alert identifier.
+ "status": "A String", # The current status of the alert.
+ # The supported values are the following:
+ #
+ # * NOT_STARTED
+ # * IN_PROGRESS
+ # * CLOSED
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
},
"source": "A String", # Required. A unique identifier for the system that reported the alert.
# This is output only after alert is created.
@@ -311,26 +321,16 @@
# * Domain wide takeout
# * State sponsored attack
# * Google identity
- "securityInvestigationToolLink": "A String", # Output only. An optional
- # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
- # query for this alert.
"updateTime": "A String", # Output only. The time this alert was last updated.
- "etag": "A String", # 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.
"deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"type": "A String", # 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).
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "endTime": "A String", # 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.
}</pre>
</div>
@@ -353,8 +353,6 @@
An object of the form:
{ # An alert metadata.
- "alertId": "A String", # Output only. The alert identifier.
- "updateTime": "A String", # Output only. The time this metadata was last updated.
"assignee": "A String", # The email address of the user assigned to the alert.
"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
# creation time, default's to an empty string when it could not be
@@ -364,13 +362,7 @@
# * HIGH
# * MEDIUM
# * LOW
- "status": "A String", # The current status of the alert.
- # The supported values are the following:
- #
- # * NOT_STARTED
- # * IN_PROGRESS
- # * CLOSED
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
"etag": "A String", # 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
@@ -382,20 +374,22 @@
#
# If no `etag` is provided in the call to update alert metadata, then the
# existing alert metadata is overwritten blindly.
+ "alertId": "A String", # Output only. The alert identifier.
+ "status": "A String", # The current status of the alert.
+ # The supported values are the following:
+ #
+ # * NOT_STARTED
+ # * IN_PROGRESS
+ # * CLOSED
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, pageToken=None, orderBy=None, customerId=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(orderBy=None, customerId=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
<pre>Lists the alerts.
Args:
- pageSize: integer, Optional. The requested page size. Server may return fewer items than
-requested. If unspecified, server picks an appropriate default.
- 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's
-next_page_token field.
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
@@ -405,6 +399,12 @@
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.
+ pageSize: integer, Optional. The requested page size. Server may return fewer items than
+requested. If unspecified, server picks an appropriate default.
+ 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's
+next_page_token field.
filter: string, Optional. A query string for filtering alert results.
For more details, see [Query
filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported
@@ -419,26 +419,30 @@
An object of the form:
{ # Response message for an alert listing request.
- "nextPageToken": "A String", # 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.
"alerts": [ # The list of alerts.
{ # An alert affecting a customer.
- "startTime": "A String", # Required. The time the event that caused this alert was started or
- # detected.
- "createTime": "A String", # Output only. The time this alert was created.
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
"data": { # Optional. The data associated with this alert, for example
# google.apps.alertcenter.type.DeviceCompromised.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "endTime": "A String", # 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.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "etag": "A String", # 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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or
+ # detected.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "securityInvestigationToolLink": "A String", # Output only. An optional
+ # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
+ # query for this alert.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "alertId": "A String", # Output only. The alert identifier.
- "updateTime": "A String", # Output only. The time this metadata was last updated.
"assignee": "A String", # The email address of the user assigned to the alert.
"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
# creation time, default's to an empty string when it could not be
@@ -448,13 +452,7 @@
# * HIGH
# * MEDIUM
# * LOW
- "status": "A String", # The current status of the alert.
- # The supported values are the following:
- #
- # * NOT_STARTED
- # * IN_PROGRESS
- # * CLOSED
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
"etag": "A String", # 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
@@ -466,6 +464,14 @@
#
# If no `etag` is provided in the call to update alert metadata, then the
# existing alert metadata is overwritten blindly.
+ "alertId": "A String", # Output only. The alert identifier.
+ "status": "A String", # The current status of the alert.
+ # The supported values are the following:
+ #
+ # * NOT_STARTED
+ # * IN_PROGRESS
+ # * CLOSED
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
},
"source": "A String", # Required. A unique identifier for the system that reported the alert.
# This is output only after alert is created.
@@ -478,28 +484,22 @@
# * Domain wide takeout
# * State sponsored attack
# * Google identity
- "securityInvestigationToolLink": "A String", # Output only. An optional
- # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
- # query for this alert.
"updateTime": "A String", # Output only. The time this alert was last updated.
- "etag": "A String", # 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.
"deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"type": "A String", # 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).
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "endTime": "A String", # 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.
},
],
+ "nextPageToken": "A String", # 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.
}</pre>
</div>
@@ -545,20 +545,28 @@
An object of the form:
{ # An alert affecting a customer.
- "startTime": "A String", # Required. The time the event that caused this alert was started or
- # detected.
- "createTime": "A String", # Output only. The time this alert was created.
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
"data": { # Optional. The data associated with this alert, for example
# google.apps.alertcenter.type.DeviceCompromised.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "endTime": "A String", # 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.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "etag": "A String", # 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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or
+ # detected.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "securityInvestigationToolLink": "A String", # Output only. An optional
+ # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
+ # query for this alert.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "alertId": "A String", # Output only. The alert identifier.
- "updateTime": "A String", # Output only. The time this metadata was last updated.
"assignee": "A String", # The email address of the user assigned to the alert.
"severity": "A String", # The severity value of the alert. Alert Center will set this field at alert
# creation time, default's to an empty string when it could not be
@@ -568,13 +576,7 @@
# * HIGH
# * MEDIUM
# * LOW
- "status": "A String", # The current status of the alert.
- # The supported values are the following:
- #
- # * NOT_STARTED
- # * IN_PROGRESS
- # * CLOSED
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
"etag": "A String", # 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
@@ -586,6 +588,14 @@
#
# If no `etag` is provided in the call to update alert metadata, then the
# existing alert metadata is overwritten blindly.
+ "alertId": "A String", # Output only. The alert identifier.
+ "status": "A String", # The current status of the alert.
+ # The supported values are the following:
+ #
+ # * NOT_STARTED
+ # * IN_PROGRESS
+ # * CLOSED
+ "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
},
"source": "A String", # Required. A unique identifier for the system that reported the alert.
# This is output only after alert is created.
@@ -598,26 +608,16 @@
# * Domain wide takeout
# * State sponsored attack
# * Google identity
- "securityInvestigationToolLink": "A String", # Output only. An optional
- # [Security Investigation Tool](https://support.google.com/a/answer/7575955)
- # query for this alert.
"updateTime": "A String", # Output only. The time this alert was last updated.
- "etag": "A String", # 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.
"deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"type": "A String", # 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).
- "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "endTime": "A String", # 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.
}</pre>
</div>