Package org.openapitools.client.model

Class CloudStorageVirusScanResult

java.lang.Object
org.openapitools.client.model.CloudStorageVirusScanResult
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-11-03T08:41:21.483351Z[Etc/UTC]", comments="Generator version: 7.12.0") public class CloudStorageVirusScanResult extends Object
Result of running a virus scan on cloud storage

  • Field Details

    • SERIALIZED_NAME_SUCCESSFUL

      public static final String SERIALIZED_NAME_SUCCESSFUL
      See Also:

    • SERIALIZED_NAME_CLEAN_RESULT

      public static final String SERIALIZED_NAME_CLEAN_RESULT
      See Also:

    • SERIALIZED_NAME_FOUND_VIRUSES

      public static final String SERIALIZED_NAME_FOUND_VIRUSES
      See Also:

    • SERIALIZED_NAME_ERROR_DETAILED_DESCRIPTION

      public static final String SERIALIZED_NAME_ERROR_DETAILED_DESCRIPTION
      See Also:

    • SERIALIZED_NAME_FILE_SIZE

      public static final String SERIALIZED_NAME_FILE_SIZE
      See Also:

    • SERIALIZED_NAME_CONTAINS_CONTENT_MODERATION_REJECTION

      public static final String SERIALIZED_NAME_CONTAINS_CONTENT_MODERATION_REJECTION
      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_VERIFIED_FILE_FORMAT

      public static final String SERIALIZED_NAME_VERIFIED_FILE_FORMAT
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • CloudStorageVirusScanResult

      public CloudStorageVirusScanResult()

  • Method Details

    • successful

      public CloudStorageVirusScanResult successful(@Nullable Boolean successful)

    • getSuccessful

      @Nullable public Boolean getSuccessful()
      True if the operation of retrieving the file, and scanning it were successfully completed, false if the file could not be downloaded from cloud storage, or if the file could not be scanned. Note that successful completion does not mean the file is clean; for the output of the virus scanning operation itself, use the CleanResult and FoundViruses parameters.
      Returns:
      successful

    • setSuccessful

      public void setSuccessful(@Nullable Boolean successful)

    • cleanResult

      public CloudStorageVirusScanResult 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)

    • foundViruses

      public CloudStorageVirusScanResult foundViruses(@Nullable List<CloudStorageVirusFound> foundViruses)

    • addFoundVirusesItem

      public CloudStorageVirusScanResult addFoundVirusesItem(CloudStorageVirusFound foundVirusesItem)

    • getFoundViruses

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

    • setFoundViruses

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

    • errorDetailedDescription

      public CloudStorageVirusScanResult errorDetailedDescription(@Nullable String errorDetailedDescription)

    • getErrorDetailedDescription

      @Nullable public String getErrorDetailedDescription()
      Detailed error message if the operation was not successful
      Returns:
      errorDetailedDescription

    • setErrorDetailedDescription

      public void setErrorDetailedDescription(@Nullable String errorDetailedDescription)

    • fileSize

      public CloudStorageVirusScanResult fileSize(@Nullable Long fileSize)

    • getFileSize

      @Nullable public Long getFileSize()
      Size in bytes of the file that was retrieved and scanned
      Returns:
      fileSize

    • setFileSize

      public void setFileSize(@Nullable Long fileSize)

    • containsContentModerationRejection

      public CloudStorageVirusScanResult containsContentModerationRejection(@Nullable Boolean containsContentModerationRejection)

    • getContainsContentModerationRejection

      @Nullable public Boolean getContainsContentModerationRejection()
      Set to true when using NSFW Content Moderation in the Cloudmersive Storage Protect product (disabled by default)
      Returns:
      containsContentModerationRejection

    • setContainsContentModerationRejection

      public void setContainsContentModerationRejection(@Nullable Boolean containsContentModerationRejection)

    • containsExecutable

      public CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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 CloudStorageVirusScanResult 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)

    • verifiedFileFormat

      public CloudStorageVirusScanResult 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)

    • 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 CloudStorageVirusScanResult

    • fromJson

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

    • toJson

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