Class Entity.Builder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public static final class Entity.Builder extends GeneratedMessage.Builder<Entity.Builder> implements EntityOrBuilder

An Entity provides additional context about an item in a UDM event. For example, a PROCESS_LAUNCH event describes that user '[e-mail]' launched process 'shady.exe'. The event does not include information that user '[e-mail]' is a recently terminated employee who administers a server storing finance data. Information stored in one or more Entities can add this additional context.

Protobuf type google.backstory.Entity

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Entity.Builder

Implements

EntityOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllRelations(Iterable<? extends Relation> values)

public Entity.Builder addAllRelations(Iterable<? extends Relation> values)

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
values	Iterable<? extends com.google.backstory.Relation>

Returns
Type	Description
Entity.Builder

addRelations(Relation value)

public Entity.Builder addRelations(Relation value)

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
value	Relation

Returns
Type	Description
Entity.Builder

addRelations(Relation.Builder builderForValue)

public Entity.Builder addRelations(Relation.Builder builderForValue)

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
builderForValue	Relation.Builder

Returns
Type	Description
Entity.Builder

addRelations(int index, Relation value)

public Entity.Builder addRelations(int index, Relation value)

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

repeated .google.backstory.Relation relations = 4;

Parameters
Name	Description
index	int
value	Relation

Returns
Type	Description
Entity.Builder

addRelations(int index, Relation.Builder builderForValue)

public Entity.Builder addRelations(int index, Relation.Builder builderForValue)

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

repeated .google.backstory.Relation relations = 4;

Parameters
Name	Description
index	int
builderForValue	Relation.Builder

Returns
Type	Description
Entity.Builder

addRelationsBuilder()

public Relation.Builder addRelationsBuilder()

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
Relation.Builder

addRelationsBuilder(int index)

public Relation.Builder addRelationsBuilder(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.Builder

build()

public Entity build()

Returns
Type	Description
Entity

buildPartial()

public Entity buildPartial()

Returns
Type	Description
Entity

clear()

public Entity.Builder clear()

Returns
Type	Description
Entity.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAdditional()

public Entity.Builder clearAdditional()

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

.google.protobuf.Struct additional = 3;

Returns
Type	Description
Entity.Builder

clearEntity()

public Entity.Builder clearEntity()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type	Description
Entity.Builder

clearMetadata()

public Entity.Builder clearMetadata()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type	Description
Entity.Builder

clearMetric()

public Entity.Builder clearMetric()

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

.google.backstory.Metric metric = 6;

Returns
Type	Description
Entity.Builder

clearRelations()

public Entity.Builder clearRelations()

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
Entity.Builder

clearRiskScore()

public Entity.Builder clearRiskScore()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type	Description
Entity.Builder

getAdditional()

public 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.

getAdditionalBuilder()

public Struct.Builder getAdditionalBuilder()

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

.google.protobuf.Struct additional = 3;

Returns
Type	Description
Builder

getAdditionalOrBuilder()

public 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

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()

Returns
Type	Description
Entity

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEntity()

public Noun getEntity()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type	Description
Noun	The entity.

getEntityBuilder()

public Noun.Builder getEntityBuilder()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type	Description
Noun.Builder

getEntityOrBuilder()

public NounOrBuilder getEntityOrBuilder()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type	Description
NounOrBuilder

getMetadata()

public EntityMetadata getMetadata()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type	Description
EntityMetadata	The metadata.

getMetadataBuilder()

public EntityMetadata.Builder getMetadataBuilder()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type	Description
EntityMetadata.Builder

getMetadataOrBuilder()

public EntityMetadataOrBuilder getMetadataOrBuilder()

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Returns
Type	Description
EntityMetadataOrBuilder

getMetric()

public 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.

getMetricBuilder()

public Metric.Builder getMetricBuilder()

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

.google.backstory.Metric metric = 6;

Returns
Type	Description
Metric.Builder

getMetricOrBuilder()

public 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 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

getRelationsBuilder(int index)

public Relation.Builder getRelationsBuilder(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.Builder

getRelationsBuilderList()

public List<Relation.Builder> getRelationsBuilderList()

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<Builder>

getRelationsCount()

public 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 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 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 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 EntityRisk getRiskScore()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type	Description
EntityRisk	The riskScore.

getRiskScoreBuilder()

public EntityRisk.Builder getRiskScoreBuilder()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type	Description
EntityRisk.Builder

getRiskScoreOrBuilder()

public EntityRiskOrBuilder getRiskScoreOrBuilder()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type	Description
EntityRiskOrBuilder

hasAdditional()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeAdditional(Struct value)

public Entity.Builder mergeAdditional(Struct value)

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

.google.protobuf.Struct additional = 3;

Parameter
Name	Description
value	Struct

Returns
Type	Description
Entity.Builder

mergeEntity(Noun value)

public Entity.Builder mergeEntity(Noun value)

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Parameter
Name	Description
value	Noun

Returns
Type	Description
Entity.Builder

mergeFrom(Entity other)

public Entity.Builder mergeFrom(Entity other)

Parameter
Name	Description
other	Entity

Returns
Type	Description
Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Entity.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Entity.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMetadata(EntityMetadata value)

public Entity.Builder mergeMetadata(EntityMetadata value)

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Parameter
Name	Description
value	EntityMetadata

Returns
Type	Description
Entity.Builder

mergeMetric(Metric value)

public Entity.Builder mergeMetric(Metric value)

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

.google.backstory.Metric metric = 6;

Parameter
Name	Description
value	Metric

Returns
Type	Description
Entity.Builder

mergeRiskScore(EntityRisk value)

public Entity.Builder mergeRiskScore(EntityRisk value)

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Parameter
Name	Description
value	EntityRisk

Returns
Type	Description
Entity.Builder

removeRelations(int index)

public Entity.Builder removeRelations(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
Entity.Builder

setAdditional(Struct value)

public Entity.Builder setAdditional(Struct value)

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

.google.protobuf.Struct additional = 3;

Parameter
Name	Description
value	Struct

Returns
Type	Description
Entity.Builder

setAdditional(Struct.Builder builderForValue)

public Entity.Builder setAdditional(Struct.Builder builderForValue)

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

.google.protobuf.Struct additional = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Entity.Builder

setEntity(Noun value)

public Entity.Builder setEntity(Noun value)

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Parameter
Name	Description
value	Noun

Returns
Type	Description
Entity.Builder

setEntity(Noun.Builder builderForValue)

public Entity.Builder setEntity(Noun.Builder builderForValue)

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Parameter
Name	Description
builderForValue	Noun.Builder

Returns
Type	Description
Entity.Builder

setMetadata(EntityMetadata value)

public Entity.Builder setMetadata(EntityMetadata value)

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Parameter
Name	Description
value	EntityMetadata

Returns
Type	Description
Entity.Builder

setMetadata(EntityMetadata.Builder builderForValue)

public Entity.Builder setMetadata(EntityMetadata.Builder builderForValue)

Entity metadata such as timestamp, product, etc.

.google.backstory.EntityMetadata metadata = 1;

Parameter
Name	Description
builderForValue	EntityMetadata.Builder

Returns
Type	Description
Entity.Builder

setMetric(Metric value)

public Entity.Builder setMetric(Metric value)

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

.google.backstory.Metric metric = 6;

Parameter
Name	Description
value	Metric

Returns
Type	Description
Entity.Builder

setMetric(Metric.Builder builderForValue)

public Entity.Builder setMetric(Metric.Builder builderForValue)

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

.google.backstory.Metric metric = 6;

Parameter
Name	Description
builderForValue	Metric.Builder

Returns
Type	Description
Entity.Builder

setRelations(int index, Relation value)

public Entity.Builder setRelations(int index, Relation value)

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

repeated .google.backstory.Relation relations = 4;

Parameters
Name	Description
index	int
value	Relation

Returns
Type	Description
Entity.Builder

setRelations(int index, Relation.Builder builderForValue)

public Entity.Builder setRelations(int index, Relation.Builder builderForValue)

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

repeated .google.backstory.Relation relations = 4;

Parameters
Name	Description
index	int
builderForValue	Relation.Builder

Returns
Type	Description
Entity.Builder

setRiskScore(EntityRisk value)

public Entity.Builder setRiskScore(EntityRisk value)

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Parameter
Name	Description
value	EntityRisk

Returns
Type	Description
Entity.Builder

setRiskScore(EntityRisk.Builder builderForValue)

public Entity.Builder setRiskScore(EntityRisk.Builder builderForValue)

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Parameter
Name	Description
builderForValue	EntityRisk.Builder

Returns
Type	Description
Entity.Builder