GoogleApi.AlertCenter.V1beta1.Model.Alert (google_api_alert_center v0.11.2) View Source

An alert affecting a customer.

Attributes

  • alertId (type: String.t, default: nil) - Output only. The unique identifier for the alert.
  • createTime (type: DateTime.t, default: nil) - Output only. The time this alert was created.
  • customerId (type: String.t, default: nil) - Output only. The unique identifier of the Google account of the customer.
  • data (type: map(), default: nil) - Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
  • deleted (type: boolean(), default: nil) - Output only. True if this alert is marked for deletion.
  • endTime (type: DateTime.t, default: nil) - 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.
  • etag (type: String.t, default: nil) - 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.
  • metadata (type: GoogleApi.AlertCenter.V1beta1.Model.AlertMetadata.t, default: nil) - Output only. The metadata associated with this alert.
  • securityInvestigationToolLink (type: String.t, default: nil) - Output only. An optional Security Investigation Tool query for this alert.
  • source (type: String.t, default: nil) - 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
  • startTime (type: DateTime.t, default: nil) - Required. The time the event that caused this alert was started or detected.
  • type (type: String.t, default: nil) - Required. The type of the alert. This is output only after alert is created. For a list of available alert types see Google Workspace Alert types.
  • updateTime (type: DateTime.t, default: nil) - Output only. The time this alert was last updated.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.AlertCenter.V1beta1.Model.Alert{
  alertId: String.t(),
  createTime: DateTime.t(),
  customerId: String.t(),
  data: map(),
  deleted: boolean(),
  endTime: DateTime.t(),
  etag: String.t(),
  metadata: GoogleApi.AlertCenter.V1beta1.Model.AlertMetadata.t(),
  securityInvestigationToolLink: String.t(),
  source: String.t(),
  startTime: DateTime.t(),
  type: String.t(),
  updateTime: DateTime.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.