Alert (Google Workspace Alert Center API v1beta1-rev20241028-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.alertcenter.v1beta1.model.Alert

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Alert
extends com.google.api.client.json.GenericJson
```
An alert affecting a customer.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Workspace Alert Center API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Alert()

Constructors
Constructor and Description
`Alert()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alert`	`clone()`
`String`	`getAlertId()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getCustomerId()` Output only.
`Map<String,Object>`	`getData()` Optional.
`Boolean`	`getDeleted()` Output only.
`String`	`getEndTime()` Optional.
`String`	`getEtag()` Optional.
`AlertMetadata`	`getMetadata()` Output only.
`String`	`getSecurityInvestigationToolLink()` Output only.
`String`	`getSource()` Required.
`String`	`getStartTime()` Required.
`String`	`getType()` Required.
`String`	`getUpdateTime()` Output only.
`Alert`	`set(String fieldName, Object value)`
`Alert`	`setAlertId(String alertId)` Output only.
`Alert`	`setCreateTime(String createTime)` Output only.
`Alert`	`setCustomerId(String customerId)` Output only.
`Alert`	`setData(Map<String,Object> data)` Optional.
`Alert`	`setDeleted(Boolean deleted)` Output only.
`Alert`	`setEndTime(String endTime)` Optional.
`Alert`	`setEtag(String etag)` Optional.
`Alert`	`setMetadata(AlertMetadata metadata)` Output only.
`Alert`	`setSecurityInvestigationToolLink(String securityInvestigationToolLink)` Output only.
`Alert`	`setSource(String source)` Required.
`Alert`	`setStartTime(String startTime)` Required.
`Alert`	`setType(String type)` Required.
`Alert`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Alert
```
public Alert()
```
- Method Detail
  - getAlertId
```
public String getAlertId()
```
    Output only. The unique identifier for the alert.
    
    Returns:
    
    value or null for none
  - setAlertId
```
public Alert setAlertId(String alertId)
```
    Output only. The unique identifier for the alert.
    
    Parameters:
    
    alertId - alertId or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time this alert was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Alert setCreateTime(String createTime)
```
    Output only. The time this alert was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCustomerId
```
public String getCustomerId()
```
    Output only. The unique identifier of the Google Workspace account of the customer.
    
    Returns:
    
    value or null for none
  - setCustomerId
```
public Alert setCustomerId(String customerId)
```
    Output only. The unique identifier of the Google Workspace account of the customer.
    
    Parameters:
    
    customerId - customerId or null for none
  - getData
```
public Map<String,Object> getData()
```
    Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
    
    Returns:
    
    value or null for none
  - setData
```
public Alert setData(Map<String,Object> data)
```
    Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
    
    Parameters:
    
    data - data or null for none
  - getDeleted
```
public Boolean getDeleted()
```
    Output only. `True` if this alert is marked for deletion.
    
    Returns:
    
    value or null for none
  - setDeleted
```
public Alert setDeleted(Boolean deleted)
```
    Output only. `True` if this alert is marked for deletion.
    
    Parameters:
    
    deleted - deleted or null for none
  - getEndTime
```
public String getEndTime()
```
    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.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public Alert setEndTime(String endTime)
```
    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.
    
    Parameters:
    
    endTime - endTime or null for none
  - getEtag
```
public String getEtag()
```
    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.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Alert setEtag(String etag)
```
    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.
    
    Parameters:
    
    etag - etag or null for none
  - getMetadata
```
public AlertMetadata getMetadata()
```
    Output only. The metadata associated with this alert.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Alert setMetadata(AlertMetadata metadata)
```
    Output only. The metadata associated with this alert.
    
    Parameters:
    
    metadata - metadata or null for none
  - getSecurityInvestigationToolLink
```
public String getSecurityInvestigationToolLink()
```
    Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
    
    Returns:
    
    value or null for none
  - setSecurityInvestigationToolLink
```
public Alert setSecurityInvestigationToolLink(String securityInvestigationToolLink)
```
    Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
    
    Parameters:
    
    securityInvestigationToolLink - securityInvestigationToolLink or null for none
  - getSource
```
public String getSource()
```
    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 * Data Loss Prevention * Domain wide takeout * State sponsored attack * Google identity * Apps outage
    
    Returns:
    
    value or null for none
  - setSource
```
public Alert setSource(String source)
```
    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 * Data Loss Prevention * Domain wide takeout * State sponsored attack * Google identity * Apps outage
    
    Parameters:
    
    source - source or null for none
  - getStartTime
```
public String getStartTime()
```
    Required. The time the event that caused this alert was started or detected.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public Alert setStartTime(String startTime)
```
    Required. The time the event that caused this alert was started or detected.
    
    Parameters:
    
    startTime - startTime or null for none
  - getType
```
public String getType()
```
    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](https://developers.google.com/admin- sdk/alertcenter/reference/alert-types).
    
    Returns:
    
    value or null for none
  - setType
```
public Alert setType(String type)
```
    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](https://developers.google.com/admin- sdk/alertcenter/reference/alert-types).
    
    Parameters:
    
    type - type or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time this alert was last updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Alert setUpdateTime(String updateTime)
```
    Output only. The time this alert was last updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Alert set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Alert clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Alert

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Alert

Method Detail

getAlertId

setAlertId

getCreateTime

setCreateTime

getCustomerId

setCustomerId

getData

setData

getDeleted

setDeleted

getEndTime

setEndTime

getEtag

setEtag

getMetadata

setMetadata

getSecurityInvestigationToolLink

setSecurityInvestigationToolLink

getSource

setSource

getStartTime

setStartTime

getType

setType

getUpdateTime

setUpdateTime

set

clone