Class Reference

Reference to model primatives including event and entity. As support is added for fast retrieval of objects by identifiers, this will be expanded to include ID references rather than full object copies.

Inheritance

object

Reference

Implements

IMessage<Reference>

IEquatable<Reference>

IDeepCloneable<Reference>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Backstory

Assembly: Google.Backstory.dll

Syntax

public sealed class Reference : IMessage<Reference>, IEquatable<Reference>, IDeepCloneable<Reference>, IBufferMessage, IMessage

Constructors

Reference()

Declaration

public Reference()

Reference(Reference)

Declaration

public Reference(Reference other)

Parameters

Type	Name	Description
Reference	other

Properties

Entity

Entity being referenced. In cases where the entity graph is overridden by data table, this will represent the original entity. End one-of

Declaration

public Entity Entity { get; set; }

Property Value

Type	Description
Entity

Event

Only one of event or entity will be populated for a single reference. Start one-of Event being referenced.

Declaration

public UDM Event { get; set; }

Property Value

Type	Description
UDM

GraphEnrichment

The entity graph enrichment details. Only set when the reference is an Entity which has been overridden by a data table or appended from a data table.

Declaration

public EntityGraphEnrichment GraphEnrichment { get; set; }

Property Value

Type	Description
EntityGraphEnrichment

Id

Id being referenced. This field will also be populated for both event and entity with the event id. For detections, only this field will be populated.

Declaration

public Id Id { get; set; }

Property Value

Type	Description
Id

JoinedDataTableRows

The data table rows joined with the event.

Declaration

public RepeatedField<DataTableRowInfo> JoinedDataTableRows { get; }

Property Value

Type	Description
RepeatedField<DataTableRowInfo>

LogBatchToken

The log batch token of the event being referenced. This field is used to fetch the raw log associated with the event in some legacy systems. This field is only populated for events/entities.

Declaration

public string LogBatchToken { get; set; }

Property Value

Type	Description
string