Class Entity (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public final class Entity extends GeneratedMessage 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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Entity

Implements

EntityOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADDITIONAL_FIELD_NUMBER

public static final int ADDITIONAL_FIELD_NUMBER

Field Value
Type	Description
int

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER

Field Value
Type	Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

Field Value
Type	Description
int

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER

Field Value
Type	Description
int

RELATIONS_FIELD_NUMBER

public static final int RELATIONS_FIELD_NUMBER

Field Value
Type	Description
int

RISK_SCORE_FIELD_NUMBER

public static final int RISK_SCORE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Entity getDefaultInstance()

Returns
Type	Description
Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Entity.Builder newBuilder()

Returns
Type	Description
Entity.Builder

newBuilder(Entity prototype)

public static Entity.Builder newBuilder(Entity prototype)

Parameter
Name	Description
prototype	Entity

Returns
Type	Description
Entity.Builder

parseDelimitedFrom(InputStream input)

public static Entity parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Entity parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Entity parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Entity parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Entity parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Entity parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Entity> parser()

Returns
Type	Description
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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

getEntity()

public Noun getEntity()

Noun in the UDM event that this entity represents.

.google.backstory.Noun entity = 2;

Returns
Type	Description
Noun	The entity.

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.

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.

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

getParserForType()

public Parser<Entity> getParserForType()

Returns
Type	Description
Parser<Entity>

Overrides

GeneratedMessage.getParserForType()

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

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.

getRiskScoreOrBuilder()

public EntityRiskOrBuilder getRiskScoreOrBuilder()

Stores information related to the entity's risk score.

optional .google.backstory.EntityRisk risk_score = 5;

Returns
Type	Description
EntityRiskOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Entity.Builder newBuilderForType()

Returns
Type	Description
Entity.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Entity.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Entity.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Entity.Builder toBuilder()

Returns
Type	Description
Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException