Interface EntityOrBuilder (0.3.0)

public interface EntityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditional()

public abstract Struct getAdditional()

Important entity data that cannot be adequately represented within the formal sections of the Entity.

.google.protobuf.Struct additional = 3;

Returns
Type Description
Struct

The additional.

getAdditionalOrBuilder()

public abstract StructOrBuilder getAdditionalOrBuilder()

Important entity data that cannot be adequately represented within the formal sections of the Entity.

.google.protobuf.Struct additional = 3;

Returns
Type Description
StructOrBuilder

getEntity()

public abstract Noun getEntity()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type Description
Noun

The entity.

getEntityOrBuilder()

public abstract NounOrBuilder getEntityOrBuilder()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type Description
NounOrBuilder

getMetadata()

public abstract EntityMetadata getMetadata()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type Description
EntityMetadata

The metadata.

getMetadataOrBuilder()

public abstract EntityMetadataOrBuilder getMetadataOrBuilder()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type Description
EntityMetadataOrBuilder

getMetric()

public abstract Metric getMetric()

Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.

.google.backstory.Metric metric = 6;

Returns
Type Description
Metric

The metric.

getMetricOrBuilder()

public abstract MetricOrBuilder getMetricOrBuilder()

Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.

.google.backstory.Metric metric = 6;

Returns
Type Description
MetricOrBuilder

getRelations(int index)

public abstract Relation getRelations(int index)

One or more relationships between the entity (a) and other entities, including the relationship type and related entity.

repeated .google.backstory.Relation relations = 4;

Parameter
Name Description
index int
Returns
Type Description
Relation

getRelationsCount()

public abstract int getRelationsCount()

One or more relationships between the entity (a) and other entities, including the relationship type and related entity.

repeated .google.backstory.Relation relations = 4;

Returns
Type Description
int

getRelationsList()

public abstract List<Relation> getRelationsList()

One or more relationships between the entity (a) and other entities, including the relationship type and related entity.

repeated .google.backstory.Relation relations = 4;

Returns
Type Description
List<Relation>

getRelationsOrBuilder(int index)

public abstract RelationOrBuilder getRelationsOrBuilder(int index)

One or more relationships between the entity (a) and other entities, including the relationship type and related entity.

repeated .google.backstory.Relation relations = 4;

Parameter
Name Description
index int
Returns
Type Description
RelationOrBuilder

getRelationsOrBuilderList()

public abstract List<? extends RelationOrBuilder> getRelationsOrBuilderList()

One or more relationships between the entity (a) and other entities, including the relationship type and related entity.

repeated .google.backstory.Relation relations = 4;

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

getRiskScore()

public abstract EntityRisk getRiskScore()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type Description
EntityRisk

The riskScore.

getRiskScoreOrBuilder()

public abstract EntityRiskOrBuilder getRiskScoreOrBuilder()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type Description
EntityRiskOrBuilder

hasAdditional()

public abstract boolean hasAdditional()

Important entity data that cannot be adequately represented within the formal sections of the Entity.

.google.protobuf.Struct additional = 3;

Returns
Type Description
boolean

Whether the additional field is set.

hasEntity()

public abstract boolean hasEntity()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type Description
boolean

Whether the entity field is set.

hasMetadata()

public abstract boolean hasMetadata()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type Description
boolean

Whether the metadata field is set.

hasMetric()

public abstract boolean hasMetric()

Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.

.google.backstory.Metric metric = 6;

Returns
Type Description
boolean

Whether the metric field is set.

hasRiskScore()

public abstract boolean hasRiskScore()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type Description
boolean

Whether the riskScore field is set.