Class File (0.3.0)

public final class File extends GeneratedMessage implements FileOrBuilder

Information about a file.

Protobuf type google.backstory.File

Implements

FileOrBuilder

Static Fields

AHASH_FIELD_NUMBER

public static final int AHASH_FIELD_NUMBER
Field Value
Type Description
int

APP_COMPAT_CACHE_FIELD_NUMBER

public static final int APP_COMPAT_CACHE_FIELD_NUMBER
Field Value
Type Description
int

AUTHENTIHASH_FIELD_NUMBER

public static final int AUTHENTIHASH_FIELD_NUMBER
Field Value
Type Description
int

CAPABILITIES_TAGS_FIELD_NUMBER

public static final int CAPABILITIES_TAGS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDED_DOMAINS_FIELD_NUMBER

public static final int EMBEDDED_DOMAINS_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDED_IPS_FIELD_NUMBER

public static final int EMBEDDED_IPS_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDED_URLS_FIELD_NUMBER

public static final int EMBEDDED_URLS_FIELD_NUMBER
Field Value
Type Description
int

EXIF_INFO_FIELD_NUMBER

public static final int EXIF_INFO_FIELD_NUMBER
Field Value
Type Description
int

FILE_METADATA_FIELD_NUMBER

public static final int FILE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

FILE_TYPE_FIELD_NUMBER

public static final int FILE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FIRST_SEEN_TIME_FIELD_NUMBER

public static final int FIRST_SEEN_TIME_FIELD_NUMBER
Field Value
Type Description
int

FIRST_SUBMISSION_TIME_FIELD_NUMBER

public static final int FIRST_SUBMISSION_TIME_FIELD_NUMBER
Field Value
Type Description
int

FULL_PATH_FIELD_NUMBER

public static final int FULL_PATH_FIELD_NUMBER
Field Value
Type Description
int

LAST_ACCESS_TIME_FIELD_NUMBER

public static final int LAST_ACCESS_TIME_FIELD_NUMBER
Field Value
Type Description
int

LAST_ANALYSIS_TIME_FIELD_NUMBER

public static final int LAST_ANALYSIS_TIME_FIELD_NUMBER
Field Value
Type Description
int

LAST_MODIFICATION_TIME_FIELD_NUMBER

public static final int LAST_MODIFICATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

LAST_SEEN_TIME_FIELD_NUMBER

public static final int LAST_SEEN_TIME_FIELD_NUMBER
Field Value
Type Description
int

LAST_SUBMISSION_TIME_FIELD_NUMBER

public static final int LAST_SUBMISSION_TIME_FIELD_NUMBER
Field Value
Type Description
int

MAIN_ICON_FIELD_NUMBER

public static final int MAIN_ICON_FIELD_NUMBER
Field Value
Type Description
int

MD5_FIELD_NUMBER

public static final int MD5_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAMES_FIELD_NUMBER

public static final int NAMES_FIELD_NUMBER
Field Value
Type Description
int

NTFS_FIELD_NUMBER

public static final int NTFS_FIELD_NUMBER
Field Value
Type Description
int

PDF_INFO_FIELD_NUMBER

public static final int PDF_INFO_FIELD_NUMBER
Field Value
Type Description
int

PE_FILE_FIELD_NUMBER

public static final int PE_FILE_FIELD_NUMBER
Field Value
Type Description
int

PREFETCH_FILE_METADATA_FIELD_NUMBER

public static final int PREFETCH_FILE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

PREVALENCE_FIELD_NUMBER

public static final int PREVALENCE_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_RESULT_FIELD_NUMBER

public static final int SECURITY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

SHA1_FIELD_NUMBER

public static final int SHA1_FIELD_NUMBER
Field Value
Type Description
int

SHA256_FIELD_NUMBER

public static final int SHA256_FIELD_NUMBER
Field Value
Type Description
int

SIGNATURE_INFO_FIELD_NUMBER

public static final int SIGNATURE_INFO_FIELD_NUMBER
Field Value
Type Description
int

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER
Field Value
Type Description
int

SSDEEP_FIELD_NUMBER

public static final int SSDEEP_FIELD_NUMBER
Field Value
Type Description
int

STAT_DEV_FIELD_NUMBER

public static final int STAT_DEV_FIELD_NUMBER
Field Value
Type Description
int

STAT_FLAGS_FIELD_NUMBER

public static final int STAT_FLAGS_FIELD_NUMBER
Field Value
Type Description
int

STAT_INODE_FIELD_NUMBER

public static final int STAT_INODE_FIELD_NUMBER
Field Value
Type Description
int

STAT_MODE_FIELD_NUMBER

public static final int STAT_MODE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STAT_NLINK_FIELD_NUMBER
Field Value
Type Description
int

SYMHASH_FIELD_NUMBER

public static final int SYMHASH_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

VHASH_FIELD_NUMBER

public static final int VHASH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static File getDefaultInstance()
Returns
Type Description
File

getDescriptor()

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

newBuilder()

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

newBuilder(File prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAhash() (deprecated)

public String getAhash()

Deprecated. google.backstory.File.ahash is deprecated. See backstory/udm.proto;l=3365

Deprecated. Use authentihash instead.

string ahash = 11 [deprecated = true];

Returns
Type Description
String

The ahash.

getAhashBytes() (deprecated)

public ByteString getAhashBytes()

Deprecated. google.backstory.File.ahash is deprecated. See backstory/udm.proto;l=3365

Deprecated. Use authentihash instead.

string ahash = 11 [deprecated = true];

Returns
Type Description
ByteString

The bytes for ahash.

getAppCompatCache()

public AppCompatMetadata getAppCompatCache()

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Returns
Type Description
AppCompatMetadata

The appCompatCache.

getAppCompatCacheOrBuilder()

public AppCompatMetadataOrBuilder getAppCompatCacheOrBuilder()

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Returns
Type Description
AppCompatMetadataOrBuilder

getAuthentihash()

public String getAuthentihash()

Authentihash of the file.

string authentihash = 20;

Returns
Type Description
String

The authentihash.

getAuthentihashBytes()

public ByteString getAuthentihashBytes()

Authentihash of the file.

string authentihash = 20;

Returns
Type Description
ByteString

The bytes for authentihash.

getCapabilitiesTags(int index)

public String getCapabilitiesTags(int index)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The capabilitiesTags at the given index.

getCapabilitiesTagsBytes(int index)

public ByteString getCapabilitiesTagsBytes(int index)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the capabilitiesTags at the given index.

getCapabilitiesTagsCount()

public int getCapabilitiesTagsCount()

Capabilities tags.

repeated string capabilities_tags = 13;

Returns
Type Description
int

The count of capabilitiesTags.

getCapabilitiesTagsList()

public ProtocolStringList getCapabilitiesTagsList()

Capabilities tags.

repeated string capabilities_tags = 13;

Returns
Type Description
ProtocolStringList

A list containing the capabilitiesTags.

getCreateTime()

public Timestamp getCreateTime()

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public File getDefaultInstanceForType()
Returns
Type Description
File

getEmbeddedDomains(int index)

public String getEmbeddedDomains(int index)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The embeddedDomains at the given index.

getEmbeddedDomainsBytes(int index)

public ByteString getEmbeddedDomainsBytes(int index)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the embeddedDomains at the given index.

getEmbeddedDomainsCount()

public int getEmbeddedDomainsCount()

Embedded domains found in the file.

repeated string embedded_domains = 29;

Returns
Type Description
int

The count of embeddedDomains.

getEmbeddedDomainsList()

public ProtocolStringList getEmbeddedDomainsList()

Embedded domains found in the file.

repeated string embedded_domains = 29;

Returns
Type Description
ProtocolStringList

A list containing the embeddedDomains.

getEmbeddedIps(int index)

public String getEmbeddedIps(int index)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The embeddedIps at the given index.

getEmbeddedIpsBytes(int index)

public ByteString getEmbeddedIpsBytes(int index)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the embeddedIps at the given index.

getEmbeddedIpsCount()

public int getEmbeddedIpsCount()

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Returns
Type Description
int

The count of embeddedIps.

getEmbeddedIpsList()

public ProtocolStringList getEmbeddedIpsList()

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Returns
Type Description
ProtocolStringList

A list containing the embeddedIps.

getEmbeddedUrls(int index)

public String getEmbeddedUrls(int index)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The embeddedUrls at the given index.

getEmbeddedUrlsBytes(int index)

public ByteString getEmbeddedUrlsBytes(int index)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the embeddedUrls at the given index.

getEmbeddedUrlsCount()

public int getEmbeddedUrlsCount()

Embedded urls found in the file.

repeated string embedded_urls = 28;

Returns
Type Description
int

The count of embeddedUrls.

getEmbeddedUrlsList()

public ProtocolStringList getEmbeddedUrlsList()

Embedded urls found in the file.

repeated string embedded_urls = 28;

Returns
Type Description
ProtocolStringList

A list containing the embeddedUrls.

getExifInfo()

public ExifInfo getExifInfo()

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Returns
Type Description
ExifInfo

The exifInfo.

getExifInfoOrBuilder()

public ExifInfoOrBuilder getExifInfoOrBuilder()

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Returns
Type Description
ExifInfoOrBuilder

getFileMetadata() (deprecated)

public FileMetadata getFileMetadata()

Deprecated. google.backstory.File.file_metadata is deprecated. See backstory/udm.proto;l=3349

Metadata associated with the file. Deprecate FileMetadata in favor of using fields in File.

.google.backstory.FileMetadata file_metadata = 7 [deprecated = true];

Returns
Type Description
FileMetadata

The fileMetadata.

getFileMetadataOrBuilder() (deprecated)

public FileMetadataOrBuilder getFileMetadataOrBuilder()

Metadata associated with the file. Deprecate FileMetadata in favor of using fields in File.

.google.backstory.FileMetadata file_metadata = 7 [deprecated = true];

Returns
Type Description
FileMetadataOrBuilder

getFileType()

public File.FileType getFileType()

FileType field.

.google.backstory.File.FileType file_type = 12;

Returns
Type Description
File.FileType

The fileType.

getFileTypeValue()

public int getFileTypeValue()

FileType field.

.google.backstory.File.FileType file_type = 12;

Returns
Type Description
int

The enum numeric value on the wire for fileType.

getFirstSeenTime()

public Timestamp getFirstSeenTime()

Timestamp the file was first seen in the customer's environment.

.google.protobuf.Timestamp first_seen_time = 17;

Returns
Type Description
Timestamp

The firstSeenTime.

getFirstSeenTimeOrBuilder()

public TimestampOrBuilder getFirstSeenTimeOrBuilder()

Timestamp the file was first seen in the customer's environment.

.google.protobuf.Timestamp first_seen_time = 17;

Returns
Type Description
TimestampOrBuilder

getFirstSubmissionTime()

public Timestamp getFirstSubmissionTime()

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Returns
Type Description
Timestamp

The firstSubmissionTime.

getFirstSubmissionTimeOrBuilder()

public TimestampOrBuilder getFirstSubmissionTimeOrBuilder()

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Returns
Type Description
TimestampOrBuilder

getFullPath()

public String getFullPath()

The full path identifying the location of the file on the system. This field can be used as an entity indicator for file entities.

string full_path = 5;

Returns
Type Description
String

The fullPath.

getFullPathBytes()

public ByteString getFullPathBytes()

The full path identifying the location of the file on the system. This field can be used as an entity indicator for file entities.

string full_path = 5;

Returns
Type Description
ByteString

The bytes for fullPath.

getLastAccessTime()

public Timestamp getLastAccessTime()

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Returns
Type Description
Timestamp

The lastAccessTime.

getLastAccessTimeOrBuilder()

public TimestampOrBuilder getLastAccessTimeOrBuilder()

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Returns
Type Description
TimestampOrBuilder

getLastAnalysisTime()

public Timestamp getLastAnalysisTime()

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Returns
Type Description
Timestamp

The lastAnalysisTime.

getLastAnalysisTimeOrBuilder()

public TimestampOrBuilder getLastAnalysisTimeOrBuilder()

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Returns
Type Description
TimestampOrBuilder

getLastModificationTime()

public Timestamp getLastModificationTime()

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Returns
Type Description
Timestamp

The lastModificationTime.

getLastModificationTimeOrBuilder()

public TimestampOrBuilder getLastModificationTimeOrBuilder()

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Returns
Type Description
TimestampOrBuilder

getLastSeenTime()

public Timestamp getLastSeenTime()

Timestamp the file was last seen in the customer's environment.

.google.protobuf.Timestamp last_seen_time = 18;

Returns
Type Description
Timestamp

The lastSeenTime.

getLastSeenTimeOrBuilder()

public TimestampOrBuilder getLastSeenTimeOrBuilder()

Timestamp the file was last seen in the customer's environment.

.google.protobuf.Timestamp last_seen_time = 18;

Returns
Type Description
TimestampOrBuilder

getLastSubmissionTime()

public Timestamp getLastSubmissionTime()

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Returns
Type Description
Timestamp

The lastSubmissionTime.

getLastSubmissionTimeOrBuilder()

public TimestampOrBuilder getLastSubmissionTimeOrBuilder()

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Returns
Type Description
TimestampOrBuilder

getMainIcon()

public Favicon getMainIcon()

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Returns
Type Description
Favicon

The mainIcon.

getMainIconOrBuilder()

public FaviconOrBuilder getMainIconOrBuilder()

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Returns
Type Description
FaviconOrBuilder

getMd5()

public String getMd5()

The MD5 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string md5 = 2;

Returns
Type Description
String

The md5.

getMd5Bytes()

public ByteString getMd5Bytes()

The MD5 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string md5 = 2;

Returns
Type Description
ByteString

The bytes for md5.

getMimeType()

public String getMimeType()

The MIME (Multipurpose Internet Mail Extensions) type of the file, for example "PE", "PDF", or "powershell script".

string mime_type = 6;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The MIME (Multipurpose Internet Mail Extensions) type of the file, for example "PE", "PDF", or "powershell script".

string mime_type = 6;

Returns
Type Description
ByteString

The bytes for mimeType.

getNames(int index)

public String getNames(int index)

Names fields.

repeated string names = 14;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The names at the given index.

getNamesBytes(int index)

public ByteString getNamesBytes(int index)

Names fields.

repeated string names = 14;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the names at the given index.

getNamesCount()

public int getNamesCount()

Names fields.

repeated string names = 14;

Returns
Type Description
int

The count of names.

getNamesList()

public ProtocolStringList getNamesList()

Names fields.

repeated string names = 14;

Returns
Type Description
ProtocolStringList

A list containing the names.

getNtfs()

public NtfsFileMetadata getNtfs()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
NtfsFileMetadata

The ntfs.

getNtfsOrBuilder()

public NtfsFileMetadataOrBuilder getNtfsOrBuilder()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
NtfsFileMetadataOrBuilder

getParserForType()

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

getPdfInfo()

public PDFInfo getPdfInfo()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
PDFInfo

The pdfInfo.

getPdfInfoOrBuilder()

public PDFInfoOrBuilder getPdfInfoOrBuilder()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
PDFInfoOrBuilder

getPeFile()

public FileMetadataPE getPeFile()

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Returns
Type Description
FileMetadataPE

The peFile.

getPeFileOrBuilder()

public FileMetadataPEOrBuilder getPeFileOrBuilder()

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Returns
Type Description
FileMetadataPEOrBuilder

getPrefetchFileMetadata()

public PrefetchFileMetadata getPrefetchFileMetadata()

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Returns
Type Description
PrefetchFileMetadata

The prefetchFileMetadata.

getPrefetchFileMetadataOrBuilder()

public PrefetchFileMetadataOrBuilder getPrefetchFileMetadataOrBuilder()

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Returns
Type Description
PrefetchFileMetadataOrBuilder

getPrevalence()

public Prevalence getPrevalence()

Prevalence of the file hash in the customer's environment.

.google.backstory.Prevalence prevalence = 16;

Returns
Type Description
Prevalence

The prevalence.

getPrevalenceOrBuilder()

public PrevalenceOrBuilder getPrevalenceOrBuilder()

Prevalence of the file hash in the customer's environment.

.google.backstory.Prevalence prevalence = 16;

Returns
Type Description
PrevalenceOrBuilder

getSecurityResult()

public SecurityResult getSecurityResult()

Google Cloud Threat Intelligence (GCTI) security result for the file including threat context and detection metadata.

.google.backstory.SecurityResult security_result = 36;

Returns
Type Description
SecurityResult

The securityResult.

getSecurityResultOrBuilder()

public SecurityResultOrBuilder getSecurityResultOrBuilder()

Google Cloud Threat Intelligence (GCTI) security result for the file including threat context and detection metadata.

.google.backstory.SecurityResult security_result = 36;

Returns
Type Description
SecurityResultOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSha1()

public String getSha1()

The SHA1 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string sha1 = 3;

Returns
Type Description
String

The sha1.

getSha1Bytes()

public ByteString getSha1Bytes()

The SHA1 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string sha1 = 3;

Returns
Type Description
ByteString

The bytes for sha1.

getSha256()

public String getSha256()

The SHA256 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string sha256 = 1;

Returns
Type Description
String

The sha256.

getSha256Bytes()

public ByteString getSha256Bytes()

The SHA256 hash of the file, as a hex-encoded string. This field can be used as an entity indicator for file entities.

string sha256 = 1;

Returns
Type Description
ByteString

The bytes for sha256.

getSignatureInfo()

public SignatureInfo getSignatureInfo()

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Returns
Type Description
SignatureInfo

The signatureInfo.

getSignatureInfoOrBuilder()

public SignatureInfoOrBuilder getSignatureInfoOrBuilder()

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Returns
Type Description
SignatureInfoOrBuilder

getSize()

public long getSize()

The size of the file in bytes.

uint64 size = 4;

Returns
Type Description
long

The size.

getSsdeep()

public String getSsdeep()

Ssdeep of the file

string ssdeep = 9;

Returns
Type Description
String

The ssdeep.

getSsdeepBytes()

public ByteString getSsdeepBytes()

Ssdeep of the file

string ssdeep = 9;

Returns
Type Description
ByteString

The bytes for ssdeep.

getStatDev()

public long getStatDev()

The file system identifier to which the object belongs.

uint64 stat_dev = 23;

Returns
Type Description
long

The statDev.

getStatFlags()

public int getStatFlags()

User defined flags for file.

uint32 stat_flags = 25;

Returns
Type Description
int

The statFlags.

getStatInode()

public long getStatInode()

The file identifier. Unique identifier of object within a file system.

uint64 stat_inode = 22;

Returns
Type Description
long

The statInode.

getStatMode()

public long getStatMode()

The mode of the file. A bit string indicating the permissions and privileges of the file.

uint64 stat_mode = 21;

Returns
Type Description
long

The statMode.

public long getStatNlink()

Number of links to file.

uint64 stat_nlink = 24;

Returns
Type Description
long

The statNlink.

getSymhash()

public String getSymhash()

SymHash of the file. Used for Mach-O (e.g. MacOS) binaries, to identify similar files based on their symbol table.

string symhash = 41;

Returns
Type Description
String

The symhash.

getSymhashBytes()

public ByteString getSymhashBytes()

SymHash of the file. Used for Mach-O (e.g. MacOS) binaries, to identify similar files based on their symbol table.

string symhash = 41;

Returns
Type Description
ByteString

The bytes for symhash.

getTags(int index)

public String getTags(int index)

Tags for the file.

repeated string tags = 27;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Tags for the file.

repeated string tags = 27;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

Tags for the file.

repeated string tags = 27;

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Tags for the file.

repeated string tags = 27;

Returns
Type Description
ProtocolStringList

A list containing the tags.

getVhash()

public String getVhash()

Vhash of the file.

string vhash = 10;

Returns
Type Description
String

The vhash.

getVhashBytes()

public ByteString getVhashBytes()

Vhash of the file.

string vhash = 10;

Returns
Type Description
ByteString

The bytes for vhash.

hasAppCompatCache()

public boolean hasAppCompatCache()

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Returns
Type Description
boolean

Whether the appCompatCache field is set.

hasCreateTime()

public boolean hasCreateTime()

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Returns
Type Description
boolean

Whether the createTime field is set.

hasExifInfo()

public boolean hasExifInfo()

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Returns
Type Description
boolean

Whether the exifInfo field is set.

hasFileMetadata() (deprecated)

public boolean hasFileMetadata()

Deprecated. google.backstory.File.file_metadata is deprecated. See backstory/udm.proto;l=3349

Metadata associated with the file. Deprecate FileMetadata in favor of using fields in File.

.google.backstory.FileMetadata file_metadata = 7 [deprecated = true];

Returns
Type Description
boolean

Whether the fileMetadata field is set.

hasFirstSeenTime()

public boolean hasFirstSeenTime()

Timestamp the file was first seen in the customer's environment.

.google.protobuf.Timestamp first_seen_time = 17;

Returns
Type Description
boolean

Whether the firstSeenTime field is set.

hasFirstSubmissionTime()

public boolean hasFirstSubmissionTime()

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Returns
Type Description
boolean

Whether the firstSubmissionTime field is set.

hasLastAccessTime()

public boolean hasLastAccessTime()

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Returns
Type Description
boolean

Whether the lastAccessTime field is set.

hasLastAnalysisTime()

public boolean hasLastAnalysisTime()

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Returns
Type Description
boolean

Whether the lastAnalysisTime field is set.

hasLastModificationTime()

public boolean hasLastModificationTime()

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Returns
Type Description
boolean

Whether the lastModificationTime field is set.

hasLastSeenTime()

public boolean hasLastSeenTime()

Timestamp the file was last seen in the customer's environment.

.google.protobuf.Timestamp last_seen_time = 18;

Returns
Type Description
boolean

Whether the lastSeenTime field is set.

hasLastSubmissionTime()

public boolean hasLastSubmissionTime()

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Returns
Type Description
boolean

Whether the lastSubmissionTime field is set.

hasMainIcon()

public boolean hasMainIcon()

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Returns
Type Description
boolean

Whether the mainIcon field is set.

hasNtfs()

public boolean hasNtfs()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
boolean

Whether the ntfs field is set.

hasPdfInfo()

public boolean hasPdfInfo()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
boolean

Whether the pdfInfo field is set.

hasPeFile()

public boolean hasPeFile()

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Returns
Type Description
boolean

Whether the peFile field is set.

hasPrefetchFileMetadata()

public boolean hasPrefetchFileMetadata()

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Returns
Type Description
boolean

Whether the prefetchFileMetadata field is set.

hasPrevalence()

public boolean hasPrevalence()

Prevalence of the file hash in the customer's environment.

.google.backstory.Prevalence prevalence = 16;

Returns
Type Description
boolean

Whether the prevalence field is set.

hasSecurityResult()

public boolean hasSecurityResult()

Google Cloud Threat Intelligence (GCTI) security result for the file including threat context and detection metadata.

.google.backstory.SecurityResult security_result = 36;

Returns
Type Description
boolean

Whether the securityResult field is set.

hasSignatureInfo()

public boolean hasSignatureInfo()

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Returns
Type Description
boolean

Whether the signatureInfo 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 File.Builder newBuilderForType()
Returns
Type Description
File.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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