Class EntityMetadata (0.3.0)

public final class EntityMetadata extends GeneratedMessage implements EntityMetadataOrBuilder

Information about the Entity and the product where the entity was created.

Protobuf type google.backstory.EntityMetadata

Static Fields

ATI_PRIORITIZATION_FIELD_NUMBER

public static final int ATI_PRIORITIZATION_FIELD_NUMBER
Field Value
Type Description
int

COLLECTED_TIMESTAMP_FIELD_NUMBER

public static final int COLLECTED_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_METADATA_FIELD_NUMBER

public static final int EVENT_METADATA_FIELD_NUMBER
Field Value
Type Description
int

EXTRACTED_FIELD_NUMBER

public static final int EXTRACTED_FIELD_NUMBER
Field Value
Type Description
int

FEED_FIELD_NUMBER

public static final int FEED_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_ENTITY_ID_FIELD_NUMBER

public static final int PRODUCT_ENTITY_ID_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_NAME_FIELD_NUMBER

public static final int PRODUCT_NAME_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_VERSION_FIELD_NUMBER

public static final int PRODUCT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_LABELS_FIELD_NUMBER

public static final int SOURCE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TYPE_FIELD_NUMBER

public static final int SOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STRUCTURED_FIELDS_FIELD_NUMBER

public static final int STRUCTURED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

THREAT_FIELD_NUMBER

public static final int THREAT_FIELD_NUMBER
Field Value
Type Description
int

VENDOR_NAME_FIELD_NUMBER

public static final int VENDOR_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EntityMetadata getDefaultInstance()
Returns
Type Description
EntityMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EntityMetadata.Builder newBuilder()
Returns
Type Description
EntityMetadata.Builder

newBuilder(EntityMetadata prototype)

public static EntityMetadata.Builder newBuilder(EntityMetadata prototype)
Parameter
Name Description
prototype EntityMetadata
Returns
Type Description
EntityMetadata.Builder

parseDelimitedFrom(InputStream input)

public static EntityMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EntityMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EntityMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EntityMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EntityMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EntityMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EntityMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EntityMetadata> parser()
Returns
Type Description
Parser<EntityMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAtiPrioritization()

public AtiPrioritization getAtiPrioritization()

Prioritization factors used by ATI curated rules.

.google.backstory.AtiPrioritization ati_prioritization = 17;

Returns
Type Description
AtiPrioritization

The atiPrioritization.

getAtiPrioritizationOrBuilder()

public AtiPrioritizationOrBuilder getAtiPrioritizationOrBuilder()

Prioritization factors used by ATI curated rules.

.google.backstory.AtiPrioritization ati_prioritization = 17;

Returns
Type Description
AtiPrioritizationOrBuilder

getCollectedTimestamp()

public Timestamp getCollectedTimestamp()

GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 2;

Returns
Type Description
Timestamp

The collectedTimestamp.

getCollectedTimestampOrBuilder()

public TimestampOrBuilder getCollectedTimestampOrBuilder()

GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 2;

Returns
Type Description
TimestampOrBuilder

getCreationTimestamp()

public Timestamp getCreationTimestamp()

GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.

.google.protobuf.Timestamp creation_timestamp = 8;

Returns
Type Description
Timestamp

The creationTimestamp.

getCreationTimestampOrBuilder()

public TimestampOrBuilder getCreationTimestampOrBuilder()

GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.

.google.protobuf.Timestamp creation_timestamp = 8;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public EntityMetadata getDefaultInstanceForType()
Returns
Type Description
EntityMetadata

getDescription()

public String getDescription()

Human-readable description of the entity.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Human-readable description of the entity.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getEntityType()

public EntityMetadata.EntityType getEntityType()

Entity type. If an entity has multiple possible types, this specifies the most specific type.

.google.backstory.EntityMetadata.EntityType entity_type = 6;

Returns
Type Description
EntityMetadata.EntityType

The entityType.

getEntityTypeValue()

public int getEntityTypeValue()

Entity type. If an entity has multiple possible types, this specifies the most specific type.

.google.backstory.EntityMetadata.EntityType entity_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for entityType.

getEventMetadata()

public Metadata getEventMetadata()

Metadata field from the event.

.google.backstory.Metadata event_metadata = 13;

Returns
Type Description
Metadata

The eventMetadata.

getEventMetadataOrBuilder()

public MetadataOrBuilder getEventMetadataOrBuilder()

Metadata field from the event.

.google.backstory.Metadata event_metadata = 13;

Returns
Type Description
MetadataOrBuilder

getExtracted()

public Struct getExtracted()

Flattened fields extracted from the log.

.google.protobuf.Struct extracted = 16;

Returns
Type Description
Struct

The extracted.

getExtractedOrBuilder()

public StructOrBuilder getExtractedOrBuilder()

Flattened fields extracted from the log.

.google.protobuf.Struct extracted = 16;

Returns
Type Description
StructOrBuilder

getFeed()

public String getFeed()

Vendor feed name for a threat indicator feed.

string feed = 14;

Returns
Type Description
String

The feed.

getFeedBytes()

public ByteString getFeedBytes()

Vendor feed name for a threat indicator feed.

string feed = 14;

Returns
Type Description
ByteString

The bytes for feed.

getInterval()

public Interval getInterval()

Valid existence time range for the version of the entity represented by this entity data.

.google.type.Interval interval = 9;

Returns
Type Description
com.google.type.Interval

The interval.

getIntervalOrBuilder()

public IntervalOrBuilder getIntervalOrBuilder()

Valid existence time range for the version of the entity represented by this entity data.

.google.type.Interval interval = 9;

Returns
Type Description
com.google.type.IntervalOrBuilder

getParserForType()

public Parser<EntityMetadata> getParserForType()
Returns
Type Description
Parser<EntityMetadata>
Overrides

getProductEntityId()

public String getProductEntityId()

A vendor-specific identifier that uniquely identifies the entity (e.g. a GUID, LDAP, OID, or similar).

string product_entity_id = 1;

Returns
Type Description
String

The productEntityId.

getProductEntityIdBytes()

public ByteString getProductEntityIdBytes()

A vendor-specific identifier that uniquely identifies the entity (e.g. a GUID, LDAP, OID, or similar).

string product_entity_id = 1;

Returns
Type Description
ByteString

The bytes for productEntityId.

getProductName()

public String getProductName()

Product name that produced the entity information.

string product_name = 4;

Returns
Type Description
String

The productName.

getProductNameBytes()

public ByteString getProductNameBytes()

Product name that produced the entity information.

string product_name = 4;

Returns
Type Description
ByteString

The bytes for productName.

getProductVersion()

public String getProductVersion()

Version of the product that produced the entity information.

string product_version = 5;

Returns
Type Description
String

The productVersion.

getProductVersionBytes()

public ByteString getProductVersionBytes()

Version of the product that produced the entity information.

string product_version = 5;

Returns
Type Description
ByteString

The bytes for productVersion.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceLabels(int index)

public Label getSourceLabels(int index)

Entity source metadata labels.

repeated .google.backstory.Label source_labels = 12;

Parameter
Name Description
index int
Returns
Type Description
Label

getSourceLabelsCount()

public int getSourceLabelsCount()

Entity source metadata labels.

repeated .google.backstory.Label source_labels = 12;

Returns
Type Description
int

getSourceLabelsList()

public List<Label> getSourceLabelsList()

Entity source metadata labels.

repeated .google.backstory.Label source_labels = 12;

Returns
Type Description
List<Label>

getSourceLabelsOrBuilder(int index)

public LabelOrBuilder getSourceLabelsOrBuilder(int index)

Entity source metadata labels.

repeated .google.backstory.Label source_labels = 12;

Parameter
Name Description
index int
Returns
Type Description
LabelOrBuilder

getSourceLabelsOrBuilderList()

public List<? extends LabelOrBuilder> getSourceLabelsOrBuilderList()

Entity source metadata labels.

repeated .google.backstory.Label source_labels = 12;

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

getSourceType()

public EntityMetadata.SourceType getSourceType()

The source of the entity.

.google.backstory.EntityMetadata.SourceType source_type = 11;

Returns
Type Description
EntityMetadata.SourceType

The sourceType.

getSourceTypeValue()

public int getSourceTypeValue()

The source of the entity.

.google.backstory.EntityMetadata.SourceType source_type = 11;

Returns
Type Description
int

The enum numeric value on the wire for sourceType.

getStructuredFields() (deprecated)

public Struct getStructuredFields()

Deprecated. google.backstory.EntityMetadata.structured_fields is deprecated. See backstory/entity.proto;l=140

Structured fields extracted from the log.

.google.protobuf.Struct structured_fields = 15 [deprecated = true];

Returns
Type Description
Struct

The structuredFields.

getStructuredFieldsOrBuilder() (deprecated)

public StructOrBuilder getStructuredFieldsOrBuilder()

Structured fields extracted from the log.

.google.protobuf.Struct structured_fields = 15 [deprecated = true];

Returns
Type Description
StructOrBuilder

getThreat(int index)

public SecurityResult getThreat(int index)

Metadata provided by a threat intelligence feed that identified the entity as malicious.

repeated .google.backstory.SecurityResult threat = 10;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult

getThreatCount()

public int getThreatCount()

Metadata provided by a threat intelligence feed that identified the entity as malicious.

repeated .google.backstory.SecurityResult threat = 10;

Returns
Type Description
int

getThreatList()

public List<SecurityResult> getThreatList()

Metadata provided by a threat intelligence feed that identified the entity as malicious.

repeated .google.backstory.SecurityResult threat = 10;

Returns
Type Description
List<SecurityResult>

getThreatOrBuilder(int index)

public SecurityResultOrBuilder getThreatOrBuilder(int index)

Metadata provided by a threat intelligence feed that identified the entity as malicious.

repeated .google.backstory.SecurityResult threat = 10;

Parameter
Name Description
index int
Returns
Type Description
SecurityResultOrBuilder

getThreatOrBuilderList()

public List<? extends SecurityResultOrBuilder> getThreatOrBuilderList()

Metadata provided by a threat intelligence feed that identified the entity as malicious.

repeated .google.backstory.SecurityResult threat = 10;

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

getVendorName()

public String getVendorName()

Vendor name of the product that produced the entity information.

string vendor_name = 3;

Returns
Type Description
String

The vendorName.

getVendorNameBytes()

public ByteString getVendorNameBytes()

Vendor name of the product that produced the entity information.

string vendor_name = 3;

Returns
Type Description
ByteString

The bytes for vendorName.

hasAtiPrioritization()

public boolean hasAtiPrioritization()

Prioritization factors used by ATI curated rules.

.google.backstory.AtiPrioritization ati_prioritization = 17;

Returns
Type Description
boolean

Whether the atiPrioritization field is set.

hasCollectedTimestamp()

public boolean hasCollectedTimestamp()

GMT timestamp when the entity information was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 2;

Returns
Type Description
boolean

Whether the collectedTimestamp field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

GMT timestamp when the entity described by the product_entity_id was created on the system where data was collected.

.google.protobuf.Timestamp creation_timestamp = 8;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasEventMetadata()

public boolean hasEventMetadata()

Metadata field from the event.

.google.backstory.Metadata event_metadata = 13;

Returns
Type Description
boolean

Whether the eventMetadata field is set.

hasExtracted()

public boolean hasExtracted()

Flattened fields extracted from the log.

.google.protobuf.Struct extracted = 16;

Returns
Type Description
boolean

Whether the extracted field is set.

hasInterval()

public boolean hasInterval()

Valid existence time range for the version of the entity represented by this entity data.

.google.type.Interval interval = 9;

Returns
Type Description
boolean

Whether the interval field is set.

hasStructuredFields() (deprecated)

public boolean hasStructuredFields()

Deprecated. google.backstory.EntityMetadata.structured_fields is deprecated. See backstory/entity.proto;l=140

Structured fields extracted from the log.

.google.protobuf.Struct structured_fields = 15 [deprecated = true];

Returns
Type Description
boolean

Whether the structuredFields field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EntityMetadata.Builder newBuilderForType()
Returns
Type Description
EntityMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EntityMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EntityMetadata.Builder
Overrides

toBuilder()

public EntityMetadata.Builder toBuilder()
Returns
Type Description
EntityMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException