Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::Entity.
An Entity provides additional context about an item in a UDM event. For example, a PROCESS_LAUNCH event describes that user 'abc@example.corp' launched process 'shady.exe'. The event does not include information that user 'abc@example.com' is a recently terminated employee who administers a server storing finance data. Information stored in one or more Entities can add this additional context.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#additional
def additional() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Important entity data that cannot be adequately represented within the formal sections of the Entity.
#additional=
def additional=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Important entity data that cannot be adequately represented within the formal sections of the Entity.
Returns
- (::Google::Protobuf::Struct) — Important entity data that cannot be adequately represented within the formal sections of the Entity.
#entity
def entity() -> ::Google::Backstory::Noun
Returns
- (::Google::Backstory::Noun) — Noun in the UDM event that this entity represents.
#entity=
def entity=(value) -> ::Google::Backstory::Noun
Parameter
- value (::Google::Backstory::Noun) — Noun in the UDM event that this entity represents.
Returns
- (::Google::Backstory::Noun) — Noun in the UDM event that this entity represents.
#metadata
def metadata() -> ::Google::Backstory::EntityMetadata
Returns
- (::Google::Backstory::EntityMetadata) — Entity metadata such as timestamp, product, etc.
#metadata=
def metadata=(value) -> ::Google::Backstory::EntityMetadata
Parameter
- value (::Google::Backstory::EntityMetadata) — Entity metadata such as timestamp, product, etc.
Returns
- (::Google::Backstory::EntityMetadata) — Entity metadata such as timestamp, product, etc.
#metric
def metric() -> ::Google::Backstory::Metric
Returns
- (::Google::Backstory::Metric) — Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.
#metric=
def metric=(value) -> ::Google::Backstory::Metric
Parameter
- value (::Google::Backstory::Metric) — Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.
Returns
- (::Google::Backstory::Metric) — Stores statistical metrics about the entity. Used if metadata.entity_type is METRIC.
#relations
def relations() -> ::Array<::Google::Backstory::Relation>
Returns
- (::Array<::Google::Backstory::Relation>) — One or more relationships between the entity (a) and other entities, including the relationship type and related entity.
#relations=
def relations=(value) -> ::Array<::Google::Backstory::Relation>
Parameter
- value (::Array<::Google::Backstory::Relation>) — One or more relationships between the entity (a) and other entities, including the relationship type and related entity.
Returns
- (::Array<::Google::Backstory::Relation>) — One or more relationships between the entity (a) and other entities, including the relationship type and related entity.
#risk_score
def risk_score() -> ::Google::Backstory::EntityRisk
Returns
- (::Google::Backstory::EntityRisk) — Stores information related to the entity's risk score.
#risk_score=
def risk_score=(value) -> ::Google::Backstory::EntityRisk
Parameter
- value (::Google::Backstory::EntityRisk) — Stores information related to the entity's risk score.
Returns
- (::Google::Backstory::EntityRisk) — Stores information related to the entity's risk score.