docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/alertcenter_v1beta1.alerts.html b/docs/dyn/alertcenter_v1beta1.alerts.html
index 90143a1..415ac69 100644
--- a/docs/dyn/alertcenter_v1beta1.alerts.html
+++ b/docs/dyn/alertcenter_v1beta1.alerts.html
@@ -98,7 +98,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 a non-existent alert returns `NOT_FOUND` error.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, pageSize=None, customerId=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(filter=None, pageToken=None, orderBy=None, pageSize=None, customerId=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>
@@ -116,10 +116,10 @@
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.
@@ -131,20 +131,20 @@
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 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).
- "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.
"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.
},
],
+ "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>
@@ -157,10 +157,10 @@
The object takes the form of:
{ # A request to perform batch undelete 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.
@@ -172,20 +172,20 @@
An object of the form:
{ # Response to batch undelete 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 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).
- "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.
"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.
},
],
+ "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>
@@ -229,28 +229,28 @@
An object of the form:
{ # An alert affecting a customer.
- "createTime": "A String", # Output only. The time this alert was created.
+ "source": "A String", # 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
"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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "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.
"alertId": "A String", # Output only. The alert identifier.
+ "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
+ "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
"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 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.
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
- "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
},
"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.
},
- "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
- "securityInvestigationToolLink": "A String", # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"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.
"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).
- "source": "A String", # 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
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "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.
}</pre>
</div>
@@ -271,26 +271,26 @@
An object of the form:
{ # An alert metadata.
- "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.
"alertId": "A String", # Output only. The alert identifier.
+ "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
+ "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
"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 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.
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
- "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, pageSize=None, customerId=None, filter=None, orderBy=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(filter=None, pageToken=None, orderBy=None, pageSize=None, customerId=None, x__xgafv=None)</code>
<pre>Lists the alerts.
Args:
+ 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).
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 timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
pageSize: integer, Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
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.
- 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).
- 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="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -302,28 +302,28 @@
{ # Response message for an alert listing request.
"alerts": [ # The list of alerts.
{ # An alert affecting a customer.
- "createTime": "A String", # Output only. The time this alert was created.
+ "source": "A String", # 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
"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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "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.
"alertId": "A String", # Output only. The alert identifier.
+ "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
+ "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
"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 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.
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
- "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
},
"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.
},
- "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
- "securityInvestigationToolLink": "A String", # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"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.
"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).
- "source": "A String", # 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
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "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.
},
],
@@ -367,28 +367,28 @@
An object of the form:
{ # An alert affecting a customer.
- "createTime": "A String", # Output only. The time this alert was created.
+ "source": "A String", # 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
"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.
+ "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
"metadata": { # An alert metadata. # Output only. The metadata associated with this alert.
- "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.
"alertId": "A String", # Output only. The alert identifier.
+ "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
+ "updateTime": "A String", # Output only. The time this metadata was last updated.
+ "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
"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 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.
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "status": "A String", # The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
- "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 determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
},
"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.
},
- "startTime": "A String", # Required. The time the event that caused this alert was started or detected.
- "securityInvestigationToolLink": "A String", # Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
- "alertId": "A String", # Output only. The unique identifier for the alert.
+ "createTime": "A String", # Output only. The time this alert was created.
+ "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
"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.
"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).
- "source": "A String", # 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
"customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
- "deleted": True or False, # Output only. `True` if this alert is marked for deletion.
+ "alertId": "A String", # Output only. The unique identifier for the alert.
+ "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.
}</pre>
</div>