Class Entity
An Entity provides additional context about an item in a UDM event. For example, a PROCESS_LAUNCH event describes that user 'abc@example.corp' launched process 'shady.exe'. The event does not include information that user 'abc@example.com' is a recently terminated employee who administers a server storing finance data. Information stored in one or more Entities can add this additional context.
Namespace: Google.Backstory
Assembly: Google.Backstory.dll
Syntax
public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessageConstructors
Entity()
Declaration
public Entity()Entity(Entity)
Declaration
public Entity(Entity other)Parameters
| Type | Name | Description |
|---|---|---|
| Entity | other |
Properties
Additional
Important entity data that cannot be adequately represented within the formal sections of the Entity.
Declaration
public Struct Additional { get; set; }Property Value
| Type | Description |
|---|---|
| Struct |
Entity_
Noun in the UDM event that this entity represents.
Declaration
public Noun Entity_ { get; set; }Property Value
| Type | Description |
|---|---|
| Noun |
Metadata
Entity metadata such as timestamp, product, etc.
Declaration
public EntityMetadata Metadata { get; set; }Property Value
| Type | Description |
|---|---|
| EntityMetadata |
Metric
Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.
Declaration
public Metric Metric { get; set; }Property Value
| Type | Description |
|---|---|
| Metric |
Relations
One or more relationships between the entity (a) and other entities, including the relationship type and related entity.
Declaration
public RepeatedField<Relation> Relations { get; }Property Value
| Type | Description |
|---|---|
| RepeatedField<Relation> |
RiskScore
Stores information related to the entity's risk score.
Declaration
public EntityRisk RiskScore { get; set; }Property Value
| Type | Description |
|---|---|
| EntityRisk |