Interface ElementOrBuilder (0.3.0) 

public interface ElementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssociation()

public abstract SecurityResult getAssociation()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type Description
SecurityResult

The association.

getAssociationOrBuilder()

public abstract SecurityResultOrBuilder getAssociationOrBuilder()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type Description
SecurityResultOrBuilder

getLabel()

public abstract String getLabel()

A name that labels the entire references group.

string label = 3;

Returns
Type Description
String

The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

A name that labels the entire references group.

string label = 3;

Returns
Type Description
ByteString

The bytes for label.

getLatencyMetrics()

public abstract LatencyMetrics getLatencyMetrics()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type Description
LatencyMetrics

The latencyMetrics.

getLatencyMetricsOrBuilder()

public abstract LatencyMetricsOrBuilder getLatencyMetricsOrBuilder()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type Description
LatencyMetricsOrBuilder

getReferences(int index)

public abstract Reference getReferences(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name Description
index int
Returns
Type Description
Reference

getReferencesCount()

public abstract int getReferencesCount()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type Description
int

getReferencesList()

public abstract List<Reference> getReferencesList()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type Description
List<Reference>

getReferencesOrBuilder(int index)

public abstract ReferenceOrBuilder getReferencesOrBuilder(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name Description
index int
Returns
Type Description
ReferenceOrBuilder

getReferencesOrBuilderList()

public abstract List<? extends ReferenceOrBuilder> getReferencesOrBuilderList()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

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

getReferencesSampled()

public abstract boolean getReferencesSampled()

Copied from the detection event_sample.too_many_event_samples field. If true, the number of references will be capped at the sample limit (set at rule service). This is applicable to both UDM references and Entity references.

bool references_sampled = 4;

Returns
Type Description
boolean

The referencesSampled.

hasAssociation()

public abstract boolean hasAssociation()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type Description
boolean

Whether the association field is set.

hasLatencyMetrics()

public abstract boolean hasLatencyMetrics()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type Description
boolean

Whether the latencyMetrics field is set.