Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::EntityMetadata.
Information about the Entity and the product where the entity was created.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ati_prioritization
def ati_prioritization() -> ::Google::Backstory::AtiPrioritization
Returns
- (::Google::Backstory::AtiPrioritization) — Prioritization factors used by ATI curated rules.
#ati_prioritization=
def ati_prioritization=(value) -> ::Google::Backstory::AtiPrioritization
Parameter
- value (::Google::Backstory::AtiPrioritization) — Prioritization factors used by ATI curated rules.
Returns
- (::Google::Backstory::AtiPrioritization) — Prioritization factors used by ATI curated rules.
#collected_timestamp
def collected_timestamp() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.
#collected_timestamp=
def collected_timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.
Returns
- (::Google::Protobuf::Timestamp) — GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.
#creation_timestamp
def creation_timestamp() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.
#creation_timestamp=
def creation_timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.
Returns
- (::Google::Protobuf::Timestamp) — GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.
#description
def description() -> ::String
Returns
- (::String) — Human-readable description of the entity.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Human-readable description of the entity.
Returns
- (::String) — Human-readable description of the entity.
#entity_type
def entity_type() -> ::Google::Backstory::EntityMetadata::EntityType
Returns
- (::Google::Backstory::EntityMetadata::EntityType) — Entity type. If an entity has multiple possible types, this specifies the most specific type.
#entity_type=
def entity_type=(value) -> ::Google::Backstory::EntityMetadata::EntityType
Parameter
- value (::Google::Backstory::EntityMetadata::EntityType) — Entity type. If an entity has multiple possible types, this specifies the most specific type.
Returns
- (::Google::Backstory::EntityMetadata::EntityType) — Entity type. If an entity has multiple possible types, this specifies the most specific type.
#event_metadata
def event_metadata() -> ::Google::Backstory::Metadata
Returns
- (::Google::Backstory::Metadata) — Metadata field from the event.
#event_metadata=
def event_metadata=(value) -> ::Google::Backstory::Metadata
Parameter
- value (::Google::Backstory::Metadata) — Metadata field from the event.
Returns
- (::Google::Backstory::Metadata) — Metadata field from the event.
#extracted
def extracted() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Flattened fields extracted from the log.
#extracted=
def extracted=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Flattened fields extracted from the log.
Returns
- (::Google::Protobuf::Struct) — Flattened fields extracted from the log.
#feed
def feed() -> ::String
Returns
- (::String) — Vendor feed name for a threat indicator feed.
#feed=
def feed=(value) -> ::String
Parameter
- value (::String) — Vendor feed name for a threat indicator feed.
Returns
- (::String) — Vendor feed name for a threat indicator feed.
#interval
def interval() -> ::Google::Type::Interval
Returns
- (::Google::Type::Interval) — Valid existence time range for the version of the entity represented by this entity data.
#interval=
def interval=(value) -> ::Google::Type::Interval
Parameter
- value (::Google::Type::Interval) — Valid existence time range for the version of the entity represented by this entity data.
Returns
- (::Google::Type::Interval) — Valid existence time range for the version of the entity represented by this entity data.
#product_entity_id
def product_entity_id() -> ::String
Returns
- (::String) — A vendor-specific identifier that uniquely identifies the entity (e.g. a GUID, LDAP, OID, or similar).
#product_entity_id=
def product_entity_id=(value) -> ::String
Parameter
- value (::String) — A vendor-specific identifier that uniquely identifies the entity (e.g. a GUID, LDAP, OID, or similar).
Returns
- (::String) — A vendor-specific identifier that uniquely identifies the entity (e.g. a GUID, LDAP, OID, or similar).
#product_name
def product_name() -> ::String
Returns
- (::String) — Product name that produced the entity information.
#product_name=
def product_name=(value) -> ::String
Parameter
- value (::String) — Product name that produced the entity information.
Returns
- (::String) — Product name that produced the entity information.
#product_version
def product_version() -> ::String
Returns
- (::String) — Version of the product that produced the entity information.
#product_version=
def product_version=(value) -> ::String
Parameter
- value (::String) — Version of the product that produced the entity information.
Returns
- (::String) — Version of the product that produced the entity information.
#source_labels
def source_labels() -> ::Array<::Google::Backstory::Label>
Returns
- (::Array<::Google::Backstory::Label>) — Entity source metadata labels.
#source_labels=
def source_labels=(value) -> ::Array<::Google::Backstory::Label>
Parameter
- value (::Array<::Google::Backstory::Label>) — Entity source metadata labels.
Returns
- (::Array<::Google::Backstory::Label>) — Entity source metadata labels.
#source_type
def source_type() -> ::Google::Backstory::EntityMetadata::SourceType
Returns
- (::Google::Backstory::EntityMetadata::SourceType) — The source of the entity.
#source_type=
def source_type=(value) -> ::Google::Backstory::EntityMetadata::SourceType
Parameter
- value (::Google::Backstory::EntityMetadata::SourceType) — The source of the entity.
Returns
- (::Google::Backstory::EntityMetadata::SourceType) — The source of the entity.
#structured_fields
def structured_fields() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Structured fields extracted from the log.
#structured_fields=
def structured_fields=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Structured fields extracted from the log.
Returns
- (::Google::Protobuf::Struct) — Structured fields extracted from the log.
#threat
def threat() -> ::Array<::Google::Backstory::SecurityResult>
Returns
- (::Array<::Google::Backstory::SecurityResult>) — Metadata provided by a threat intelligence feed that identified the entity as malicious.
#threat=
def threat=(value) -> ::Array<::Google::Backstory::SecurityResult>
Parameter
- value (::Array<::Google::Backstory::SecurityResult>) — Metadata provided by a threat intelligence feed that identified the entity as malicious.
Returns
- (::Array<::Google::Backstory::SecurityResult>) — Metadata provided by a threat intelligence feed that identified the entity as malicious.
#vendor_name
def vendor_name() -> ::String
Returns
- (::String) — Vendor name of the product that produced the entity information.
#vendor_name=
def vendor_name=(value) -> ::String
Parameter
- value (::String) — Vendor name of the product that produced the entity information.
Returns
- (::String) — Vendor name of the product that produced the entity information.