Class File.Builder (0.3.0)

public static final class File.Builder extends GeneratedMessage.Builder<File.Builder> implements FileOrBuilder

Information about a file.

Protobuf type google.backstory.File

Implements

FileOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllCapabilitiesTags(Iterable<String> values)

public File.Builder addAllCapabilitiesTags(Iterable<String> values)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameter
Name Description
values Iterable<String>

The capabilitiesTags to add.

Returns
Type Description
File.Builder

This builder for chaining.

addAllEmbeddedDomains(Iterable<String> values)

public File.Builder addAllEmbeddedDomains(Iterable<String> values)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameter
Name Description
values Iterable<String>

The embeddedDomains to add.

Returns
Type Description
File.Builder

This builder for chaining.

addAllEmbeddedIps(Iterable<String> values)

public File.Builder addAllEmbeddedIps(Iterable<String> values)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameter
Name Description
values Iterable<String>

The embeddedIps to add.

Returns
Type Description
File.Builder

This builder for chaining.

addAllEmbeddedUrls(Iterable<String> values)

public File.Builder addAllEmbeddedUrls(Iterable<String> values)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameter
Name Description
values Iterable<String>

The embeddedUrls to add.

Returns
Type Description
File.Builder

This builder for chaining.

addAllNames(Iterable<String> values)

public File.Builder addAllNames(Iterable<String> values)

Names fields.

repeated string names = 14;

Parameter
Name Description
values Iterable<String>

The names to add.

Returns
Type Description
File.Builder

This builder for chaining.

addAllTags(Iterable<String> values)

public File.Builder addAllTags(Iterable<String> values)

Tags for the file.

repeated string tags = 27;

Parameter
Name Description
values Iterable<String>

The tags to add.

Returns
Type Description
File.Builder

This builder for chaining.

addCapabilitiesTags(String value)

public File.Builder addCapabilitiesTags(String value)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameter
Name Description
value String

The capabilitiesTags to add.

Returns
Type Description
File.Builder

This builder for chaining.

addCapabilitiesTagsBytes(ByteString value)

public File.Builder addCapabilitiesTagsBytes(ByteString value)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameter
Name Description
value ByteString

The bytes of the capabilitiesTags to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedDomains(String value)

public File.Builder addEmbeddedDomains(String value)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameter
Name Description
value String

The embeddedDomains to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedDomainsBytes(ByteString value)

public File.Builder addEmbeddedDomainsBytes(ByteString value)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameter
Name Description
value ByteString

The bytes of the embeddedDomains to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedIps(String value)

public File.Builder addEmbeddedIps(String value)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameter
Name Description
value String

The embeddedIps to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedIpsBytes(ByteString value)

public File.Builder addEmbeddedIpsBytes(ByteString value)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameter
Name Description
value ByteString

The bytes of the embeddedIps to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedUrls(String value)

public File.Builder addEmbeddedUrls(String value)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameter
Name Description
value String

The embeddedUrls to add.

Returns
Type Description
File.Builder

This builder for chaining.

addEmbeddedUrlsBytes(ByteString value)

public File.Builder addEmbeddedUrlsBytes(ByteString value)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameter
Name Description
value ByteString

The bytes of the embeddedUrls to add.

Returns
Type Description
File.Builder

This builder for chaining.

addNames(String value)

public File.Builder addNames(String value)

Names fields.

repeated string names = 14;

Parameter
Name Description
value String

The names to add.

Returns
Type Description
File.Builder

This builder for chaining.

addNamesBytes(ByteString value)

public File.Builder addNamesBytes(ByteString value)

Names fields.

repeated string names = 14;

Parameter
Name Description
value ByteString

The bytes of the names to add.

Returns
Type Description
File.Builder

This builder for chaining.

addTags(String value)

public File.Builder addTags(String value)

Tags for the file.

repeated string tags = 27;

Parameter
Name Description
value String

The tags to add.

Returns
Type Description
File.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public File.Builder addTagsBytes(ByteString value)

Tags for the file.

repeated string tags = 27;

Parameter
Name Description
value ByteString

The bytes of the tags to add.

Returns
Type Description
File.Builder

This builder for chaining.

build()

public File build()
Returns
Type Description
File

buildPartial()

public File buildPartial()
Returns
Type Description
File

clear()

public File.Builder clear()
Returns
Type Description
File.Builder
Overrides

clearAhash() (deprecated)

public File.Builder clearAhash()

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
File.Builder

This builder for chaining.

clearAppCompatCache()

public File.Builder clearAppCompatCache()

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Returns
Type Description
File.Builder

clearAuthentihash()

public File.Builder clearAuthentihash()

Authentihash of the file.

string authentihash = 20;

Returns
Type Description
File.Builder

This builder for chaining.

clearCapabilitiesTags()

public File.Builder clearCapabilitiesTags()

Capabilities tags.

repeated string capabilities_tags = 13;

Returns
Type Description
File.Builder

This builder for chaining.

clearCreateTime()

public File.Builder clearCreateTime()

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Returns
Type Description
File.Builder

clearEmbeddedDomains()

public File.Builder clearEmbeddedDomains()

Embedded domains found in the file.

repeated string embedded_domains = 29;

Returns
Type Description
File.Builder

This builder for chaining.

clearEmbeddedIps()

public File.Builder clearEmbeddedIps()

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Returns
Type Description
File.Builder

This builder for chaining.

clearEmbeddedUrls()

public File.Builder clearEmbeddedUrls()

Embedded urls found in the file.

repeated string embedded_urls = 28;

Returns
Type Description
File.Builder

This builder for chaining.

clearExifInfo()

public File.Builder clearExifInfo()

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Returns
Type Description
File.Builder

clearFileMetadata() (deprecated)

public File.Builder clearFileMetadata()

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
File.Builder

clearFileType()

public File.Builder clearFileType()

FileType field.

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

Returns
Type Description
File.Builder

This builder for chaining.

clearFirstSeenTime()

public File.Builder clearFirstSeenTime()

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

.google.protobuf.Timestamp first_seen_time = 17;

Returns
Type Description
File.Builder

clearFirstSubmissionTime()

public File.Builder clearFirstSubmissionTime()

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Returns
Type Description
File.Builder

clearFullPath()

public File.Builder clearFullPath()

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
File.Builder

This builder for chaining.

clearLastAccessTime()

public File.Builder clearLastAccessTime()

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Returns
Type Description
File.Builder

clearLastAnalysisTime()

public File.Builder clearLastAnalysisTime()

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Returns
Type Description
File.Builder

clearLastModificationTime()

public File.Builder clearLastModificationTime()

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Returns
Type Description
File.Builder

clearLastSeenTime()

public File.Builder clearLastSeenTime()

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

.google.protobuf.Timestamp last_seen_time = 18;

Returns
Type Description
File.Builder

clearLastSubmissionTime()

public File.Builder clearLastSubmissionTime()

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Returns
Type Description
File.Builder

clearMainIcon()

public File.Builder clearMainIcon()

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Returns
Type Description
File.Builder

clearMd5()

public File.Builder clearMd5()

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
File.Builder

This builder for chaining.

clearMimeType()

public File.Builder clearMimeType()

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

string mime_type = 6;

Returns
Type Description
File.Builder

This builder for chaining.

clearNames()

public File.Builder clearNames()

Names fields.

repeated string names = 14;

Returns
Type Description
File.Builder

This builder for chaining.

clearNtfs()

public File.Builder clearNtfs()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
File.Builder

clearPdfInfo()

public File.Builder clearPdfInfo()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
File.Builder

clearPeFile()

public File.Builder clearPeFile()

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Returns
Type Description
File.Builder

clearPrefetchFileMetadata()

public File.Builder clearPrefetchFileMetadata()

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Returns
Type Description
File.Builder

clearPrevalence()

public File.Builder clearPrevalence()

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

.google.backstory.Prevalence prevalence = 16;

Returns
Type Description
File.Builder

clearSecurityResult()

public File.Builder clearSecurityResult()

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
File.Builder

clearSha1()

public File.Builder clearSha1()

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
File.Builder

This builder for chaining.

clearSha256()

public File.Builder clearSha256()

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
File.Builder

This builder for chaining.

clearSignatureInfo()

public File.Builder clearSignatureInfo()

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Returns
Type Description
File.Builder

clearSize()

public File.Builder clearSize()

The size of the file in bytes.

uint64 size = 4;

Returns
Type Description
File.Builder

This builder for chaining.

clearSsdeep()

public File.Builder clearSsdeep()

Ssdeep of the file

string ssdeep = 9;

Returns
Type Description
File.Builder

This builder for chaining.

clearStatDev()

public File.Builder clearStatDev()

The file system identifier to which the object belongs.

uint64 stat_dev = 23;

Returns
Type Description
File.Builder

This builder for chaining.

clearStatFlags()

public File.Builder clearStatFlags()

User defined flags for file.

uint32 stat_flags = 25;

Returns
Type Description
File.Builder

This builder for chaining.

clearStatInode()

public File.Builder clearStatInode()

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

uint64 stat_inode = 22;

Returns
Type Description
File.Builder

This builder for chaining.

clearStatMode()

public File.Builder clearStatMode()

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

uint64 stat_mode = 21;

Returns
Type Description
File.Builder

This builder for chaining.

public File.Builder clearStatNlink()

Number of links to file.

uint64 stat_nlink = 24;

Returns
Type Description
File.Builder

This builder for chaining.

clearSymhash()

public File.Builder clearSymhash()

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
File.Builder

This builder for chaining.

clearTags()

public File.Builder clearTags()

Tags for the file.

repeated string tags = 27;

Returns
Type Description
File.Builder

This builder for chaining.

clearVhash()

public File.Builder clearVhash()

Vhash of the file.

string vhash = 10;

Returns
Type Description
File.Builder

This builder for chaining.

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.

getAppCompatCacheBuilder()

public AppCompatMetadata.Builder getAppCompatCacheBuilder()

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Returns
Type Description
AppCompatMetadata.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExifInfoBuilder()

public ExifInfo.Builder getExifInfoBuilder()

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Returns
Type Description
ExifInfo.Builder

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.

getFileMetadataBuilder() (deprecated)

public FileMetadata.Builder getFileMetadataBuilder()

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.Builder

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.

getFirstSeenTimeBuilder()

public Timestamp.Builder getFirstSeenTimeBuilder()

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

.google.protobuf.Timestamp first_seen_time = 17;

Returns
Type Description
Builder

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.

getFirstSubmissionTimeBuilder()

public Timestamp.Builder getFirstSubmissionTimeBuilder()

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Returns
Type Description
Builder

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.

getLastAccessTimeBuilder()

public Timestamp.Builder getLastAccessTimeBuilder()

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Returns
Type Description
Builder

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.

getLastAnalysisTimeBuilder()

public Timestamp.Builder getLastAnalysisTimeBuilder()

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Returns
Type Description
Builder

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.

getLastModificationTimeBuilder()

public Timestamp.Builder getLastModificationTimeBuilder()

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Returns
Type Description
Builder

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.

getLastSeenTimeBuilder()

public Timestamp.Builder getLastSeenTimeBuilder()

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

.google.protobuf.Timestamp last_seen_time = 18;

Returns
Type Description
Builder

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.

getLastSubmissionTimeBuilder()

public Timestamp.Builder getLastSubmissionTimeBuilder()

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Returns
Type Description
Builder

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.

getMainIconBuilder()

public Favicon.Builder getMainIconBuilder()

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Returns
Type Description
Favicon.Builder

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.

getNtfsBuilder()

public NtfsFileMetadata.Builder getNtfsBuilder()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
NtfsFileMetadata.Builder

getNtfsOrBuilder()

public NtfsFileMetadataOrBuilder getNtfsOrBuilder()

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Returns
Type Description
NtfsFileMetadataOrBuilder

getPdfInfo()

public PDFInfo getPdfInfo()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
PDFInfo

The pdfInfo.

getPdfInfoBuilder()

public PDFInfo.Builder getPdfInfoBuilder()

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Returns
Type Description
PDFInfo.Builder

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.

getPeFileBuilder()

public FileMetadataPE.Builder getPeFileBuilder()

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Returns
Type Description
FileMetadataPE.Builder

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.

getPrefetchFileMetadataBuilder()

public PrefetchFileMetadata.Builder getPrefetchFileMetadataBuilder()

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Returns
Type Description
PrefetchFileMetadata.Builder

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.

getPrevalenceBuilder()

public Prevalence.Builder getPrevalenceBuilder()

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

.google.backstory.Prevalence prevalence = 16;

Returns
Type Description
Prevalence.Builder

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.

getSecurityResultBuilder()

public SecurityResult.Builder getSecurityResultBuilder()

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.Builder

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

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.

getSignatureInfoBuilder()

public SignatureInfo.Builder getSignatureInfoBuilder()

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Returns
Type Description
SignatureInfo.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppCompatCache(AppCompatMetadata value)

public File.Builder mergeAppCompatCache(AppCompatMetadata value)

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Parameter
Name Description
value AppCompatMetadata
Returns
Type Description
File.Builder

mergeCreateTime(Timestamp value)

public File.Builder mergeCreateTime(Timestamp value)

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeExifInfo(ExifInfo value)

public File.Builder mergeExifInfo(ExifInfo value)

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Parameter
Name Description
value ExifInfo
Returns
Type Description
File.Builder

mergeFileMetadata(FileMetadata value) (deprecated)

public File.Builder mergeFileMetadata(FileMetadata value)

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

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

Parameter
Name Description
value FileMetadata
Returns
Type Description
File.Builder

mergeFirstSeenTime(Timestamp value)

public File.Builder mergeFirstSeenTime(Timestamp value)

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

.google.protobuf.Timestamp first_seen_time = 17;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeFirstSubmissionTime(Timestamp value)

public File.Builder mergeFirstSubmissionTime(Timestamp value)

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeFrom(File other)

public File.Builder mergeFrom(File other)
Parameter
Name Description
other File
Returns
Type Description
File.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public File.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
File.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public File.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
File.Builder
Overrides

mergeLastAccessTime(Timestamp value)

public File.Builder mergeLastAccessTime(Timestamp value)

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeLastAnalysisTime(Timestamp value)

public File.Builder mergeLastAnalysisTime(Timestamp value)

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeLastModificationTime(Timestamp value)

public File.Builder mergeLastModificationTime(Timestamp value)

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeLastSeenTime(Timestamp value)

public File.Builder mergeLastSeenTime(Timestamp value)

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

.google.protobuf.Timestamp last_seen_time = 18;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeLastSubmissionTime(Timestamp value)

public File.Builder mergeLastSubmissionTime(Timestamp value)

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

mergeMainIcon(Favicon value)

public File.Builder mergeMainIcon(Favicon value)

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Parameter
Name Description
value Favicon
Returns
Type Description
File.Builder

mergeNtfs(NtfsFileMetadata value)

public File.Builder mergeNtfs(NtfsFileMetadata value)

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Parameter
Name Description
value NtfsFileMetadata
Returns
Type Description
File.Builder

mergePdfInfo(PDFInfo value)

public File.Builder mergePdfInfo(PDFInfo value)

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Parameter
Name Description
value PDFInfo
Returns
Type Description
File.Builder

mergePeFile(FileMetadataPE value)

public File.Builder mergePeFile(FileMetadataPE value)

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Parameter
Name Description
value FileMetadataPE
Returns
Type Description
File.Builder

mergePrefetchFileMetadata(PrefetchFileMetadata value)

public File.Builder mergePrefetchFileMetadata(PrefetchFileMetadata value)

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Parameter
Name Description
value PrefetchFileMetadata
Returns
Type Description
File.Builder

mergePrevalence(Prevalence value)

public File.Builder mergePrevalence(Prevalence value)

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

.google.backstory.Prevalence prevalence = 16;

Parameter
Name Description
value Prevalence
Returns
Type Description
File.Builder

mergeSecurityResult(SecurityResult value)

public File.Builder mergeSecurityResult(SecurityResult value)

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

.google.backstory.SecurityResult security_result = 36;

Parameter
Name Description
value SecurityResult
Returns
Type Description
File.Builder

mergeSignatureInfo(SignatureInfo value)

public File.Builder mergeSignatureInfo(SignatureInfo value)

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Parameter
Name Description
value SignatureInfo
Returns
Type Description
File.Builder

setAhash(String value) (deprecated)

public File.Builder setAhash(String value)

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

Deprecated. Use authentihash instead.

string ahash = 11 [deprecated = true];

Parameter
Name Description
value String

The ahash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setAhashBytes(ByteString value) (deprecated)

public File.Builder setAhashBytes(ByteString value)

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

Deprecated. Use authentihash instead.

string ahash = 11 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for ahash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setAppCompatCache(AppCompatMetadata value)

public File.Builder setAppCompatCache(AppCompatMetadata value)

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Parameter
Name Description
value AppCompatMetadata
Returns
Type Description
File.Builder

setAppCompatCache(AppCompatMetadata.Builder builderForValue)

public File.Builder setAppCompatCache(AppCompatMetadata.Builder builderForValue)

Windows AppCompatCache (Application Compatibility) metadata.

.google.backstory.AppCompatMetadata app_compat_cache = 42;

Parameter
Name Description
builderForValue AppCompatMetadata.Builder
Returns
Type Description
File.Builder

setAuthentihash(String value)

public File.Builder setAuthentihash(String value)

Authentihash of the file.

string authentihash = 20;

Parameter
Name Description
value String

The authentihash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setAuthentihashBytes(ByteString value)

public File.Builder setAuthentihashBytes(ByteString value)

Authentihash of the file.

string authentihash = 20;

Parameter
Name Description
value ByteString

The bytes for authentihash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setCapabilitiesTags(int index, String value)

public File.Builder setCapabilitiesTags(int index, String value)

Capabilities tags.

repeated string capabilities_tags = 13;

Parameters
Name Description
index int

The index to set the value at.

value String

The capabilitiesTags to set.

Returns
Type Description
File.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public File.Builder setCreateTime(Timestamp value)

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setCreateTime(Timestamp.Builder builderForValue)

public File.Builder setCreateTime(Timestamp.Builder builderForValue)

Timestamp when the file was created.

.google.protobuf.Timestamp create_time = 39;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setEmbeddedDomains(int index, String value)

public File.Builder setEmbeddedDomains(int index, String value)

Embedded domains found in the file.

repeated string embedded_domains = 29;

Parameters
Name Description
index int

The index to set the value at.

value String

The embeddedDomains to set.

Returns
Type Description
File.Builder

This builder for chaining.

setEmbeddedIps(int index, String value)

public File.Builder setEmbeddedIps(int index, String value)

Embedded IP addresses found in the file.

repeated string embedded_ips = 30;

Parameters
Name Description
index int

The index to set the value at.

value String

The embeddedIps to set.

Returns
Type Description
File.Builder

This builder for chaining.

setEmbeddedUrls(int index, String value)

public File.Builder setEmbeddedUrls(int index, String value)

Embedded urls found in the file.

repeated string embedded_urls = 28;

Parameters
Name Description
index int

The index to set the value at.

value String

The embeddedUrls to set.

Returns
Type Description
File.Builder

This builder for chaining.

setExifInfo(ExifInfo value)

public File.Builder setExifInfo(ExifInfo value)

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Parameter
Name Description
value ExifInfo
Returns
Type Description
File.Builder

setExifInfo(ExifInfo.Builder builderForValue)

public File.Builder setExifInfo(ExifInfo.Builder builderForValue)

Exif metadata from different file formats extracted by exiftool.

.google.backstory.ExifInfo exif_info = 31;

Parameter
Name Description
builderForValue ExifInfo.Builder
Returns
Type Description
File.Builder

setFileMetadata(FileMetadata value) (deprecated)

public File.Builder setFileMetadata(FileMetadata value)

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

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

Parameter
Name Description
value FileMetadata
Returns
Type Description
File.Builder

setFileMetadata(FileMetadata.Builder builderForValue) (deprecated)

public File.Builder setFileMetadata(FileMetadata.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue FileMetadata.Builder
Returns
Type Description
File.Builder

setFileType(File.FileType value)

public File.Builder setFileType(File.FileType value)

FileType field.

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

Parameter
Name Description
value File.FileType

The fileType to set.

Returns
Type Description
File.Builder

This builder for chaining.

setFileTypeValue(int value)

public File.Builder setFileTypeValue(int value)

FileType field.

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

Parameter
Name Description
value int

The enum numeric value on the wire for fileType to set.

Returns
Type Description
File.Builder

This builder for chaining.

setFirstSeenTime(Timestamp value)

public File.Builder setFirstSeenTime(Timestamp value)

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

.google.protobuf.Timestamp first_seen_time = 17;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setFirstSeenTime(Timestamp.Builder builderForValue)

public File.Builder setFirstSeenTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp first_seen_time = 17;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setFirstSubmissionTime(Timestamp value)

public File.Builder setFirstSubmissionTime(Timestamp value)

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setFirstSubmissionTime(Timestamp.Builder builderForValue)

public File.Builder setFirstSubmissionTime(Timestamp.Builder builderForValue)

First submission time of the file.

.google.protobuf.Timestamp first_submission_time = 34;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setFullPath(String value)

public File.Builder setFullPath(String value)

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;

Parameter
Name Description
value String

The fullPath to set.

Returns
Type Description
File.Builder

This builder for chaining.

setFullPathBytes(ByteString value)

public File.Builder setFullPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fullPath to set.

Returns
Type Description
File.Builder

This builder for chaining.

setLastAccessTime(Timestamp value)

public File.Builder setLastAccessTime(Timestamp value)

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setLastAccessTime(Timestamp.Builder builderForValue)

public File.Builder setLastAccessTime(Timestamp.Builder builderForValue)

Timestamp when the file was accessed.

.google.protobuf.Timestamp last_access_time = 40;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setLastAnalysisTime(Timestamp value)

public File.Builder setLastAnalysisTime(Timestamp value)

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setLastAnalysisTime(Timestamp.Builder builderForValue)

public File.Builder setLastAnalysisTime(Timestamp.Builder builderForValue)

Timestamp the file was last analysed.

.google.protobuf.Timestamp last_analysis_time = 26;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setLastModificationTime(Timestamp value)

public File.Builder setLastModificationTime(Timestamp value)

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setLastModificationTime(Timestamp.Builder builderForValue)

public File.Builder setLastModificationTime(Timestamp.Builder builderForValue)

Timestamp when the file was last updated.

.google.protobuf.Timestamp last_modification_time = 15;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setLastSeenTime(Timestamp value)

public File.Builder setLastSeenTime(Timestamp value)

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

.google.protobuf.Timestamp last_seen_time = 18;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setLastSeenTime(Timestamp.Builder builderForValue)

public File.Builder setLastSeenTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp last_seen_time = 18;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setLastSubmissionTime(Timestamp value)

public File.Builder setLastSubmissionTime(Timestamp value)

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Parameter
Name Description
value Timestamp
Returns
Type Description
File.Builder

setLastSubmissionTime(Timestamp.Builder builderForValue)

public File.Builder setLastSubmissionTime(Timestamp.Builder builderForValue)

Last submission time of the file.

.google.protobuf.Timestamp last_submission_time = 35;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
File.Builder

setMainIcon(Favicon value)

public File.Builder setMainIcon(Favicon value)

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Parameter
Name Description
value Favicon
Returns
Type Description
File.Builder

setMainIcon(Favicon.Builder builderForValue)

public File.Builder setMainIcon(Favicon.Builder builderForValue)

Icon's relevant hashes.

.google.backstory.Favicon main_icon = 37;

Parameter
Name Description
builderForValue Favicon.Builder
Returns
Type Description
File.Builder

setMd5(String value)

public File.Builder setMd5(String value)

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;

Parameter
Name Description
value String

The md5 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setMd5Bytes(ByteString value)

public File.Builder setMd5Bytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for md5 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setMimeType(String value)

public File.Builder setMimeType(String value)

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

string mime_type = 6;

Parameter
Name Description
value String

The mimeType to set.

Returns
Type Description
File.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public File.Builder setMimeTypeBytes(ByteString value)

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

string mime_type = 6;

Parameter
Name Description
value ByteString

The bytes for mimeType to set.

Returns
Type Description
File.Builder

This builder for chaining.

setNames(int index, String value)

public File.Builder setNames(int index, String value)

Names fields.

repeated string names = 14;

Parameters
Name Description
index int

The index to set the value at.

value String

The names to set.

Returns
Type Description
File.Builder

This builder for chaining.

setNtfs(NtfsFileMetadata value)

public File.Builder setNtfs(NtfsFileMetadata value)

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Parameter
Name Description
value NtfsFileMetadata
Returns
Type Description
File.Builder

setNtfs(NtfsFileMetadata.Builder builderForValue)

public File.Builder setNtfs(NtfsFileMetadata.Builder builderForValue)

NTFS metadata.

.google.backstory.NtfsFileMetadata ntfs = 38;

Parameter
Name Description
builderForValue NtfsFileMetadata.Builder
Returns
Type Description
File.Builder

setPdfInfo(PDFInfo value)

public File.Builder setPdfInfo(PDFInfo value)

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Parameter
Name Description
value PDFInfo
Returns
Type Description
File.Builder

setPdfInfo(PDFInfo.Builder builderForValue)

public File.Builder setPdfInfo(PDFInfo.Builder builderForValue)

Information about the PDF file structure.

.google.backstory.PDFInfo pdf_info = 33;

Parameter
Name Description
builderForValue PDFInfo.Builder
Returns
Type Description
File.Builder

setPeFile(FileMetadataPE value)

public File.Builder setPeFile(FileMetadataPE value)

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Parameter
Name Description
value FileMetadataPE
Returns
Type Description
File.Builder

setPeFile(FileMetadataPE.Builder builderForValue)

public File.Builder setPeFile(FileMetadataPE.Builder builderForValue)

Metadata about the Portable Executable (PE) file.

.google.backstory.FileMetadataPE pe_file = 8;

Parameter
Name Description
builderForValue FileMetadataPE.Builder
Returns
Type Description
File.Builder

setPrefetchFileMetadata(PrefetchFileMetadata value)

public File.Builder setPrefetchFileMetadata(PrefetchFileMetadata value)

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Parameter
Name Description
value PrefetchFileMetadata
Returns
Type Description
File.Builder

setPrefetchFileMetadata(PrefetchFileMetadata.Builder builderForValue)

public File.Builder setPrefetchFileMetadata(PrefetchFileMetadata.Builder builderForValue)

Metadata about the prefetch file.

.google.backstory.PrefetchFileMetadata prefetch_file_metadata = 43;

Parameter
Name Description
builderForValue PrefetchFileMetadata.Builder
Returns
Type Description
File.Builder

setPrevalence(Prevalence value)

public File.Builder setPrevalence(Prevalence value)

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

.google.backstory.Prevalence prevalence = 16;

Parameter
Name Description
value Prevalence
Returns
Type Description
File.Builder

setPrevalence(Prevalence.Builder builderForValue)

public File.Builder setPrevalence(Prevalence.Builder builderForValue)

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

.google.backstory.Prevalence prevalence = 16;

Parameter
Name Description
builderForValue Prevalence.Builder
Returns
Type Description
File.Builder

setSecurityResult(SecurityResult value)

public File.Builder setSecurityResult(SecurityResult value)

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

.google.backstory.SecurityResult security_result = 36;

Parameter
Name Description
value SecurityResult
Returns
Type Description
File.Builder

setSecurityResult(SecurityResult.Builder builderForValue)

public File.Builder setSecurityResult(SecurityResult.Builder builderForValue)

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

.google.backstory.SecurityResult security_result = 36;

Parameter
Name Description
builderForValue SecurityResult.Builder
Returns
Type Description
File.Builder

setSha1(String value)

public File.Builder setSha1(String value)

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;

Parameter
Name Description
value String

The sha1 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSha1Bytes(ByteString value)

public File.Builder setSha1Bytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for sha1 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSha256(String value)

public File.Builder setSha256(String value)

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;

Parameter
Name Description
value String

The sha256 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSha256Bytes(ByteString value)

public File.Builder setSha256Bytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for sha256 to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSignatureInfo(SignatureInfo value)

public File.Builder setSignatureInfo(SignatureInfo value)

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Parameter
Name Description
value SignatureInfo
Returns
Type Description
File.Builder

setSignatureInfo(SignatureInfo.Builder builderForValue)

public File.Builder setSignatureInfo(SignatureInfo.Builder builderForValue)

File signature information extracted from different tools.

.google.backstory.SignatureInfo signature_info = 32;

Parameter
Name Description
builderForValue SignatureInfo.Builder
Returns
Type Description
File.Builder

setSize(long value)

public File.Builder setSize(long value)

The size of the file in bytes.

uint64 size = 4;

Parameter
Name Description
value long

The size to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSsdeep(String value)

public File.Builder setSsdeep(String value)

Ssdeep of the file

string ssdeep = 9;

Parameter
Name Description
value String

The ssdeep to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSsdeepBytes(ByteString value)

public File.Builder setSsdeepBytes(ByteString value)

Ssdeep of the file

string ssdeep = 9;

Parameter
Name Description
value ByteString

The bytes for ssdeep to set.

Returns
Type Description
File.Builder

This builder for chaining.

setStatDev(long value)

public File.Builder setStatDev(long value)

The file system identifier to which the object belongs.

uint64 stat_dev = 23;

Parameter
Name Description
value long

The statDev to set.

Returns
Type Description
File.Builder

This builder for chaining.

setStatFlags(int value)

public File.Builder setStatFlags(int value)

User defined flags for file.

uint32 stat_flags = 25;

Parameter
Name Description
value int

The statFlags to set.

Returns
Type Description
File.Builder

This builder for chaining.

setStatInode(long value)

public File.Builder setStatInode(long value)

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

uint64 stat_inode = 22;

Parameter
Name Description
value long

The statInode to set.

Returns
Type Description
File.Builder

This builder for chaining.

setStatMode(long value)

public File.Builder setStatMode(long value)

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

uint64 stat_mode = 21;

Parameter
Name Description
value long

The statMode to set.

Returns
Type Description
File.Builder

This builder for chaining.

public File.Builder setStatNlink(long value)

Number of links to file.

uint64 stat_nlink = 24;

Parameter
Name Description
value long

The statNlink to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSymhash(String value)

public File.Builder setSymhash(String value)

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

string symhash = 41;

Parameter
Name Description
value String

The symhash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setSymhashBytes(ByteString value)

public File.Builder setSymhashBytes(ByteString value)

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

string symhash = 41;

Parameter
Name Description
value ByteString

The bytes for symhash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setTags(int index, String value)

public File.Builder setTags(int index, String value)

Tags for the file.

repeated string tags = 27;

Parameters
Name Description
index int

The index to set the value at.

value String

The tags to set.

Returns
Type Description
File.Builder

This builder for chaining.

setVhash(String value)

public File.Builder setVhash(String value)

Vhash of the file.

string vhash = 10;

Parameter
Name Description
value String

The vhash to set.

Returns
Type Description
File.Builder

This builder for chaining.

setVhashBytes(ByteString value)

public File.Builder setVhashBytes(ByteString value)

Vhash of the file.

string vhash = 10;

Parameter
Name Description
value ByteString

The bytes for vhash to set.

Returns
Type Description
File.Builder

This builder for chaining.