com.google.api.services.alertcenter.v1beta1.model

Class RuleViolationInfo

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.RuleViolationInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RuleViolationInfo
extends com.google.api.client.json.GenericJson

Common alert information about violated rules that are configured by Google Workspace administrators.

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
RuleViolationInfo()

Method Summary

Modifier and Type	Method and Description
RuleViolationInfo	clone()
String	getDataSource() Source of the data.
String	getEventType() Event associated with this alert after applying the rule.
List<MatchInfo>	getMatchInfo() List of matches that were found in the resource content.
List<String>	getRecipients() Resource recipients.
ResourceInfo	getResourceInfo() Details of the resource which violated the rule.
RuleInfo	getRuleInfo() Details of the violated rule.
List<String>	getSuppressedActionTypes() Actions suppressed due to other actions with higher priority.
String	getTrigger() Trigger of the rule.
List<ActionInfo>	getTriggeredActionInfo() Metadata related to the triggered actions.
List<String>	getTriggeredActionTypes() Actions applied as a consequence of the rule being triggered.
String	getTriggeringUserEmail() Email of the user who caused the violation.
RuleViolationInfo	set(String fieldName, Object value)
RuleViolationInfo	setDataSource(String dataSource) Source of the data.
RuleViolationInfo	setEventType(String eventType) Event associated with this alert after applying the rule.
RuleViolationInfo	setMatchInfo(List<MatchInfo> matchInfo) List of matches that were found in the resource content.
RuleViolationInfo	setRecipients(List<String> recipients) Resource recipients.
RuleViolationInfo	setResourceInfo(ResourceInfo resourceInfo) Details of the resource which violated the rule.
RuleViolationInfo	setRuleInfo(RuleInfo ruleInfo) Details of the violated rule.
RuleViolationInfo	setSuppressedActionTypes(List<String> suppressedActionTypes) Actions suppressed due to other actions with higher priority.
RuleViolationInfo	setTrigger(String trigger) Trigger of the rule.
RuleViolationInfo	setTriggeredActionInfo(List<ActionInfo> triggeredActionInfo) Metadata related to the triggered actions.
RuleViolationInfo	setTriggeredActionTypes(List<String> triggeredActionTypes) Actions applied as a consequence of the rule being triggered.
RuleViolationInfo	setTriggeringUserEmail(String triggeringUserEmail) Email of the user who caused the violation.

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

RuleViolationInfo

public RuleViolationInfo()

Method Detail

getDataSource

public String getDataSource()

Source of the data.

Returns:

value or null for none

setDataSource

public RuleViolationInfo setDataSource(String dataSource)

Source of the data.

Parameters:

dataSource - dataSource or null for none

getEventType

public String getEventType()

Event associated with this alert after applying the rule.

Returns:

value or null for none

setEventType

public RuleViolationInfo setEventType(String eventType)

Event associated with this alert after applying the rule.

Parameters:

eventType - eventType or null for none

getMatchInfo

public List<MatchInfo> getMatchInfo()

List of matches that were found in the resource content.

Returns:

value or null for none

setMatchInfo

public RuleViolationInfo setMatchInfo(List<MatchInfo> matchInfo)

List of matches that were found in the resource content.

Parameters:

matchInfo - matchInfo or null for none

getRecipients

public List<String> getRecipients()

Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.

Returns:

value or null for none

setRecipients

public RuleViolationInfo setRecipients(List<String> recipients)

Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.

Parameters:

recipients - recipients or null for none

getResourceInfo

public ResourceInfo getResourceInfo()

Details of the resource which violated the rule.

Returns:

value or null for none

setResourceInfo

public RuleViolationInfo setResourceInfo(ResourceInfo resourceInfo)

Details of the resource which violated the rule.

Parameters:

resourceInfo - resourceInfo or null for none

getRuleInfo

public RuleInfo getRuleInfo()

Details of the violated rule.

Returns:

value or null for none

setRuleInfo

public RuleViolationInfo setRuleInfo(RuleInfo ruleInfo)

Details of the violated rule.

Parameters:

ruleInfo - ruleInfo or null for none

getSuppressedActionTypes

public List<String> getSuppressedActionTypes()

Actions suppressed due to other actions with higher priority.

Returns:

value or null for none

setSuppressedActionTypes

public RuleViolationInfo setSuppressedActionTypes(List<String> suppressedActionTypes)

Actions suppressed due to other actions with higher priority.

Parameters:

suppressedActionTypes - suppressedActionTypes or null for none

getTrigger

public String getTrigger()

Trigger of the rule.

Returns:

value or null for none

setTrigger

public RuleViolationInfo setTrigger(String trigger)

Trigger of the rule.

Parameters:

trigger - trigger or null for none

getTriggeredActionInfo

public List<ActionInfo> getTriggeredActionInfo()

Metadata related to the triggered actions.

Returns:

value or null for none

setTriggeredActionInfo

public RuleViolationInfo setTriggeredActionInfo(List<ActionInfo> triggeredActionInfo)

Metadata related to the triggered actions.

Parameters:

triggeredActionInfo - triggeredActionInfo or null for none

getTriggeredActionTypes

public List<String> getTriggeredActionTypes()

Actions applied as a consequence of the rule being triggered.

Returns:

value or null for none

setTriggeredActionTypes

public RuleViolationInfo setTriggeredActionTypes(List<String> triggeredActionTypes)

Actions applied as a consequence of the rule being triggered.

Parameters:

triggeredActionTypes - triggeredActionTypes or null for none

getTriggeringUserEmail

public String getTriggeringUserEmail()

Email of the user who caused the violation. Value could be empty if not applicable, for example, a violation found by drive continuous scan.

Returns:

value or null for none

setTriggeringUserEmail

public RuleViolationInfo setTriggeringUserEmail(String triggeringUserEmail)

Email of the user who caused the violation. Value could be empty if not applicable, for example, a violation found by drive continuous scan.

Parameters:

triggeringUserEmail - triggeringUserEmail or null for none

set

public RuleViolationInfo set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RuleViolationInfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson