Interface ReferenceOrBuilder (0.3.0) 

public interface ReferenceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEntity()

public abstract Entity getEntity()

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

.google.backstory.Entity entity = 2;

Returns
Type Description
Entity

The entity.

getEntityOrBuilder()

public abstract EntityOrBuilder getEntityOrBuilder()

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

.google.backstory.Entity entity = 2;

Returns
Type Description
EntityOrBuilder

getEvent()

public abstract UDM getEvent()

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

.google.backstory.UDM event = 1;

Returns
Type Description
UDM

The event.

getEventOrBuilder()

public abstract UDMOrBuilder getEventOrBuilder()

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

.google.backstory.UDM event = 1;

Returns
Type Description
UDMOrBuilder

getGraphEnrichment()

public abstract EntityGraphEnrichment getGraphEnrichment()

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.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type Description
EntityGraphEnrichment

The graphEnrichment.

getGraphEnrichmentOrBuilder()

public abstract EntityGraphEnrichmentOrBuilder getGraphEnrichmentOrBuilder()

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.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type Description
EntityGraphEnrichmentOrBuilder

getId()

public abstract Id getId()

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.

.google.backstory.Id id = 3;

Returns
Type Description
Id

The id.

getIdOrBuilder()

public abstract IdOrBuilder getIdOrBuilder()

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.

.google.backstory.Id id = 3;

Returns
Type Description
IdOrBuilder

getJoinedDataTableRows(int index)

public abstract DataTableRowInfo getJoinedDataTableRows(int index)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name Description
index int
Returns
Type Description
DataTableRowInfo

getJoinedDataTableRowsCount()

public abstract int getJoinedDataTableRowsCount()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type Description
int

getJoinedDataTableRowsList()

public abstract List<DataTableRowInfo> getJoinedDataTableRowsList()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type Description
List<DataTableRowInfo>

getJoinedDataTableRowsOrBuilder(int index)

public abstract DataTableRowInfoOrBuilder getJoinedDataTableRowsOrBuilder(int index)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name Description
index int
Returns
Type Description
DataTableRowInfoOrBuilder

getJoinedDataTableRowsOrBuilderList()

public abstract List<? extends DataTableRowInfoOrBuilder> getJoinedDataTableRowsOrBuilderList()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type Description
List<? extends com.google.backstory.DataTableRowInfoOrBuilder>

getLogBatchToken()

public abstract String getLogBatchToken()

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.

string log_batch_token = 6;

Returns
Type Description
String

The logBatchToken.

getLogBatchTokenBytes()

public abstract ByteString getLogBatchTokenBytes()

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.

string log_batch_token = 6;

Returns
Type Description
ByteString

The bytes for logBatchToken.

hasEntity()

public abstract boolean hasEntity()

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

.google.backstory.Entity entity = 2;

Returns
Type Description
boolean

Whether the entity field is set.

hasEvent()

public abstract boolean hasEvent()

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

.google.backstory.UDM event = 1;

Returns
Type Description
boolean

Whether the event field is set.

hasGraphEnrichment()

public abstract boolean hasGraphEnrichment()

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.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type Description
boolean

Whether the graphEnrichment field is set.

hasId()

public abstract boolean hasId()

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.

.google.backstory.Id id = 3;

Returns
Type Description
boolean

Whether the id field is set.