Package org.openapitools.client.model

Class VirusScanAdvancedResult

java.lang.Object
org.openapitools.client.model.VirusScanAdvancedResult
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-01-27T23:59:36.607801Z[Etc/UTC]", comments="Generator version: 7.12.0") public class VirusScanAdvancedResult extends Object
Result of running an advanced virus scan

  • Field Details

    • SERIALIZED_NAME_CLEAN_RESULT

      public static final String SERIALIZED_NAME_CLEAN_RESULT
      See Also:

    • SERIALIZED_NAME_CONTAINS_EXECUTABLE

      public static final String SERIALIZED_NAME_CONTAINS_EXECUTABLE
      See Also:

    • SERIALIZED_NAME_CONTAINS_INVALID_FILE

      public static final String SERIALIZED_NAME_CONTAINS_INVALID_FILE
      See Also:

    • SERIALIZED_NAME_CONTAINS_SCRIPT

      public static final String SERIALIZED_NAME_CONTAINS_SCRIPT
      See Also:

    • SERIALIZED_NAME_CONTAINS_PASSWORD_PROTECTED_FILE

      public static final String SERIALIZED_NAME_CONTAINS_PASSWORD_PROTECTED_FILE
      See Also:

    • SERIALIZED_NAME_CONTAINS_RESTRICTED_FILE_FORMAT

      public static final String SERIALIZED_NAME_CONTAINS_RESTRICTED_FILE_FORMAT
      See Also:

    • SERIALIZED_NAME_CONTAINS_MACROS

      public static final String SERIALIZED_NAME_CONTAINS_MACROS
      See Also:

    • SERIALIZED_NAME_CONTAINS_XML_EXTERNAL_ENTITIES

      public static final String SERIALIZED_NAME_CONTAINS_XML_EXTERNAL_ENTITIES
      See Also:

    • SERIALIZED_NAME_CONTAINS_INSECURE_DESERIALIZATION

      public static final String SERIALIZED_NAME_CONTAINS_INSECURE_DESERIALIZATION
      See Also:

    • SERIALIZED_NAME_CONTAINS_HTML

      public static final String SERIALIZED_NAME_CONTAINS_HTML
      See Also:

    • SERIALIZED_NAME_CONTAINS_UNSAFE_ARCHIVE

      public static final String SERIALIZED_NAME_CONTAINS_UNSAFE_ARCHIVE
      See Also:

    • SERIALIZED_NAME_CONTAINS_OLE_EMBEDDED_OBJECT

      public static final String SERIALIZED_NAME_CONTAINS_OLE_EMBEDDED_OBJECT
      See Also:

    • SERIALIZED_NAME_CONTAINS_UNWANTED_ACTION

      public static final String SERIALIZED_NAME_CONTAINS_UNWANTED_ACTION
      See Also:

    • SERIALIZED_NAME_VERIFIED_FILE_FORMAT

      public static final String SERIALIZED_NAME_VERIFIED_FILE_FORMAT
      See Also:

    • SERIALIZED_NAME_FOUND_VIRUSES

      public static final String SERIALIZED_NAME_FOUND_VIRUSES
      See Also:

    • SERIALIZED_NAME_CONTENT_INFORMATION

      public static final String SERIALIZED_NAME_CONTENT_INFORMATION
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • VirusScanAdvancedResult

      public VirusScanAdvancedResult()

  • Method Details

    • cleanResult

      public VirusScanAdvancedResult cleanResult(@Nullable Boolean cleanResult)

    • getCleanResult

      @Nullable public Boolean getCleanResult()
      True if the scan contained no viruses, false otherwise
      Returns:
      cleanResult

    • setCleanResult

      public void setCleanResult(@Nullable Boolean cleanResult)

    • containsExecutable

      public VirusScanAdvancedResult containsExecutable(@Nullable Boolean containsExecutable)

    • getContainsExecutable

      @Nullable public Boolean getContainsExecutable()
      True if the scan contained an executable (application code), which can be a significant risk factor
      Returns:
      containsExecutable

    • setContainsExecutable

      public void setContainsExecutable(@Nullable Boolean containsExecutable)

    • containsInvalidFile

      public VirusScanAdvancedResult containsInvalidFile(@Nullable Boolean containsInvalidFile)

    • getContainsInvalidFile

      @Nullable public Boolean getContainsInvalidFile()
      True if the scan contained an invalid file (such as a PDF that is not a valid PDF, Word Document that is not a valid Word Document, etc.), which can be a significant risk factor
      Returns:
      containsInvalidFile

    • setContainsInvalidFile

      public void setContainsInvalidFile(@Nullable Boolean containsInvalidFile)

    • containsScript

      public VirusScanAdvancedResult containsScript(@Nullable Boolean containsScript)

    • getContainsScript

      @Nullable public Boolean getContainsScript()
      True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor
      Returns:
      containsScript

    • setContainsScript

      public void setContainsScript(@Nullable Boolean containsScript)

    • containsPasswordProtectedFile

      public VirusScanAdvancedResult containsPasswordProtectedFile(@Nullable Boolean containsPasswordProtectedFile)

    • getContainsPasswordProtectedFile

      @Nullable public Boolean getContainsPasswordProtectedFile()
      True if the scan contained a password protected or encrypted file, which can be a significant risk factor
      Returns:
      containsPasswordProtectedFile

    • setContainsPasswordProtectedFile

      public void setContainsPasswordProtectedFile(@Nullable Boolean containsPasswordProtectedFile)

    • containsRestrictedFileFormat

      public VirusScanAdvancedResult containsRestrictedFileFormat(@Nullable Boolean containsRestrictedFileFormat)

    • getContainsRestrictedFileFormat

      @Nullable public Boolean getContainsRestrictedFileFormat()
      True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false
      Returns:
      containsRestrictedFileFormat

    • setContainsRestrictedFileFormat

      public void setContainsRestrictedFileFormat(@Nullable Boolean containsRestrictedFileFormat)

    • containsMacros

      public VirusScanAdvancedResult containsMacros(@Nullable Boolean containsMacros)

    • getContainsMacros

      @Nullable public Boolean getContainsMacros()
      True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
      Returns:
      containsMacros

    • setContainsMacros

      public void setContainsMacros(@Nullable Boolean containsMacros)

    • containsXmlExternalEntities

      public VirusScanAdvancedResult containsXmlExternalEntities(@Nullable Boolean containsXmlExternalEntities)

    • getContainsXmlExternalEntities

      @Nullable public Boolean getContainsXmlExternalEntities()
      True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor
      Returns:
      containsXmlExternalEntities

    • setContainsXmlExternalEntities

      public void setContainsXmlExternalEntities(@Nullable Boolean containsXmlExternalEntities)

    • containsInsecureDeserialization

      public VirusScanAdvancedResult containsInsecureDeserialization(@Nullable Boolean containsInsecureDeserialization)

    • getContainsInsecureDeserialization

      @Nullable public Boolean getContainsInsecureDeserialization()
      True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor
      Returns:
      containsInsecureDeserialization

    • setContainsInsecureDeserialization

      public void setContainsInsecureDeserialization(@Nullable Boolean containsInsecureDeserialization)

    • containsHtml

      public VirusScanAdvancedResult containsHtml(@Nullable Boolean containsHtml)

    • getContainsHtml

      @Nullable public Boolean getContainsHtml()
      True if the uploaded file contains HTML, which can be a significant risk factor
      Returns:
      containsHtml

    • setContainsHtml

      public void setContainsHtml(@Nullable Boolean containsHtml)

    • containsUnsafeArchive

      public VirusScanAdvancedResult containsUnsafeArchive(@Nullable Boolean containsUnsafeArchive)

    • getContainsUnsafeArchive

      @Nullable public Boolean getContainsUnsafeArchive()
      True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction
      Returns:
      containsUnsafeArchive

    • setContainsUnsafeArchive

      public void setContainsUnsafeArchive(@Nullable Boolean containsUnsafeArchive)

    • containsOleEmbeddedObject

      public VirusScanAdvancedResult containsOleEmbeddedObject(@Nullable Boolean containsOleEmbeddedObject)

    • getContainsOleEmbeddedObject

      @Nullable public Boolean getContainsOleEmbeddedObject()
      True if the uploaded file contains an OLE embedded object, which can be a significant risk factor
      Returns:
      containsOleEmbeddedObject

    • setContainsOleEmbeddedObject

      public void setContainsOleEmbeddedObject(@Nullable Boolean containsOleEmbeddedObject)

    • containsUnwantedAction

      public VirusScanAdvancedResult containsUnwantedAction(@Nullable Boolean containsUnwantedAction)

    • getContainsUnwantedAction

      @Nullable public Boolean getContainsUnwantedAction()
      True if the uploaded file contains an unwanted automatic action, which can be a significant risk factor
      Returns:
      containsUnwantedAction

    • setContainsUnwantedAction

      public void setContainsUnwantedAction(@Nullable Boolean containsUnwantedAction)

    • verifiedFileFormat

      public VirusScanAdvancedResult verifiedFileFormat(@Nullable String verifiedFileFormat)

    • getVerifiedFileFormat

      @Nullable public String getVerifiedFileFormat()
      For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null.
      Returns:
      verifiedFileFormat

    • setVerifiedFileFormat

      public void setVerifiedFileFormat(@Nullable String verifiedFileFormat)

    • foundViruses

      public VirusScanAdvancedResult foundViruses(@Nullable List<VirusFound> foundViruses)

    • addFoundVirusesItem

      public VirusScanAdvancedResult addFoundVirusesItem(VirusFound foundVirusesItem)

    • getFoundViruses

      @Nullable public List<VirusFound> getFoundViruses()
      Array of viruses found, if any
      Returns:
      foundViruses

    • setFoundViruses

      public void setFoundViruses(@Nullable List<VirusFound> foundViruses)

    • contentInformation

      public VirusScanAdvancedResult contentInformation(@Nullable AdditionalAdvancedScanInformation contentInformation)

    • getContentInformation

      @Nullable public AdditionalAdvancedScanInformation getContentInformation()
      Get contentInformation
      Returns:
      contentInformation

    • setContentInformation

      public void setContentInformation(@Nullable AdditionalAdvancedScanInformation contentInformation)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to VirusScanAdvancedResult

    • fromJson

      public static VirusScanAdvancedResult fromJson(String jsonString) throws IOException
      Create an instance of VirusScanAdvancedResult given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of VirusScanAdvancedResult
      Throws:
      IOException - if the JSON string is invalid with respect to VirusScanAdvancedResult

    • toJson

      public String toJson()
      Convert an instance of VirusScanAdvancedResult to an JSON string
      Returns:
      JSON string