Types.proto
DataChunk
This message represents a chunk of stream data and includes the following fields:
Parameter |
Description |
|---|---|
data (bytes) |
Contains the raw segment of data being transferred. |
is_last_chunk (bool) |
Indicates whether this is the final data chunk in the stream. If false, additional chunks follow and should be read from the request stream. If true, this is the last or only chunk. This field is particularly useful when the total data exceeds the client’s buffer size or when the client uses a fixed-size buffer. |
position (uint64) |
Specifies the byte offset of this chunk within the overall data stream. |
DataRequest
This message represents a request to retrieve data from a specific position in a data stream, up to a defined size. If the stream ends before the full requested size is available, the returned data chunk may be smaller than requested. Data request contains the following fields:
Parameter |
Description |
|---|---|
data_chunk_size_limit_bytes (uint32) |
If non-zero, this field defines the maximum size (in bytes) for data chunks imposed by the server. Requested data will be sent in segments not exceeding this limit. If set to zero, the client may determine the chunk size. If a client sends a chunk exceeding this limit, the server will return a BAD REQUEST error. |
position (uint64) |
Specifies the starting byte offset within the data stream from which the read operation begins. |
size_bytes (uint32) |
Defines the total number of bytes requested from the specified position |
FastScanSettings
This message defines the configuration settings for a fast scan operation. It contains the following fields:
Parameter |
Description |
|---|---|
detection_levels (repeated security_management.v1.ThreatCategoryDetectionLevel) |
Specifies the detection level (e.g., reporting strategy) for each threat category. The configured strategy is applied when a matching threat category is encountered. |
skip_archived_files (bool) |
Determines whether archived files are scanned individually. If false, archives are unpacked and each contained file is scanned separately. Scan results are provided for both the archive and its contents. If true, the archive is scanned as a BLOB, such as its hash, and results are returned only for the archive itself. Default is false. |
skip_cloud_reputation (bool) |
Note: Applicable only to customers with the dynamic scanning component enabled. If true, cloud reputation information is excluded from scan result generation. Default is false. |
skip_email_parts (bool) |
Controls email file decomposition. If false, emails are parsed and their components (body, attachments) are extracted and scanned individually. Scan results are provided for both the email file and its individual components. If true, the email is treated as a single BLOB. Results are provided only for the parent email file. Default is false. |
skip_machine_learning (bool) |
If true, machine learning–based threat detection is disabled. Default is false. |
skip_runtime_packed_files (bool) |
If false, when a runtime packer is identified within the scanned data, its content is extracted and scanned separately. Scan results are provided for both the runtime packer and the contained file(s). If true, the runtime packer is scanned as a regular executable, with results limited to the packer. Default is false. |
skip_sfx_archived_files (bool) |
If false, when a self-extracting archive (SFX) is identified within the scanned data, the files are unpacked and all contained files are scanned separately. Results are provided for both the SFX and the extracted files. If true, the SFX is treated as a regular executable, and scan results are provided only for the SFX. Default is false. |
FileBehavior
Applicable only to customers using the ESET PRIVATE Scanning Solution with the dynamic scan component enabled. |
This message describes the behavior exhibited by the scanned file. The behavior type may indicate various actions, including potential network-related activity observed during dynamic analysis.
FileDna
Applicable only to customers using the ESET PRIVATE Scanning Solution with the dynamic scan component enabled. |
This message defines detailed definitions of malicious behaviors and malware characteristics. It includes a repeated field genes, which enumerates individual traits or behavioral markers associated with the scanned file.