Package ai.reveng.model

Class ReportAnalysisResponse

java.lang.Object
ai.reveng.model.ReportAnalysisResponse
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class ReportAnalysisResponse extends Object
ReportAnalysisResponse

  • Field Details

  • Constructor Details

    • ReportAnalysisResponse

      public ReportAnalysisResponse()

  • Method Details

    • summary

      public ReportAnalysisResponse summary(@Nonnull String summary)

    • getSummary

      @Nonnull public String getSummary()
      A markdown summary of the report
      Returns:
      summary

    • setSummary

      public void setSummary(@Nonnull String summary)

    • softwareType

      public ReportAnalysisResponse softwareType(@Nonnull ReportAnalysisResponse.SoftwareTypeEnum softwareType)

    • getSoftwareType

      @Nonnull public ReportAnalysisResponse.SoftwareTypeEnum getSoftwareType()
      The type of software being analyzed
      Returns:
      softwareType

    • setSoftwareType

      public void setSoftwareType(@Nonnull ReportAnalysisResponse.SoftwareTypeEnum softwareType)

    • totalNumberOfFunctions

      public ReportAnalysisResponse totalNumberOfFunctions(@Nonnull Integer totalNumberOfFunctions)

    • getTotalNumberOfFunctions

      @Nonnull public Integer getTotalNumberOfFunctions()
      The total number of functions identified in the binary
      Returns:
      totalNumberOfFunctions

    • setTotalNumberOfFunctions

      public void setTotalNumberOfFunctions(@Nonnull Integer totalNumberOfFunctions)

    • numberOfAnalysedFunctions

      public ReportAnalysisResponse numberOfAnalysedFunctions(@Nonnull Integer numberOfAnalysedFunctions)

    • getNumberOfAnalysedFunctions

      @Nonnull public Integer getNumberOfAnalysedFunctions()
      The number of functions that were analyzed in the binary
      Returns:
      numberOfAnalysedFunctions

    • setNumberOfAnalysedFunctions

      public void setNumberOfAnalysedFunctions(@Nonnull Integer numberOfAnalysedFunctions)

    • attackFlowSummary

      public ReportAnalysisResponse attackFlowSummary(@Nonnull String attackFlowSummary)

    • getAttackFlowSummary

      @Nonnull public String getAttackFlowSummary()
      A summary in markdown format of the attack flow
      Returns:
      attackFlowSummary

    • setAttackFlowSummary

      public void setAttackFlowSummary(@Nonnull String attackFlowSummary)

    • ioCs

      public ReportAnalysisResponse ioCs(@Nonnull List<IOC> ioCs)

    • addIoCsItem

      public ReportAnalysisResponse addIoCsItem(IOC ioCsItem)

    • getIoCs

      @Nonnull public List<IOC> getIoCs()
      A list of IOCs (Indicators of Compromise) found in the analysis
      Returns:
      ioCs

    • setIoCs

      public void setIoCs(@Nonnull List<IOC> ioCs)

    • executableTechniques

      public ReportAnalysisResponse executableTechniques(@Nonnull List<MITRETechnique> executableTechniques)

    • addExecutableTechniquesItem

      public ReportAnalysisResponse addExecutableTechniquesItem(MITRETechnique executableTechniquesItem)

    • getExecutableTechniques

      @Nonnull public List<MITRETechnique> getExecutableTechniques()
      A series of MITRE Techniques found
      Returns:
      executableTechniques

    • setExecutableTechniques

      public void setExecutableTechniques(@Nonnull List<MITRETechnique> executableTechniques)

    • yaraRule

      public ReportAnalysisResponse yaraRule(@Nonnull String yaraRule)

    • getYaraRule

      @Nonnull public String getYaraRule()
      The YARA rule generated for the binary
      Returns:
      yaraRule

    • setYaraRule

      public void setYaraRule(@Nonnull String yaraRule)

    • putAdditionalProperty

      public ReportAnalysisResponse putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the ReportAnalysisResponse instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

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

    • fromJson

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

    • toJson

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