Package org.odpi.openmetadata.accessservices.discoveryengine.rest

Class DiscoveryAnalysisReportRequestBody

  • All Implemented Interfaces:
    Serializable
    public class DiscoveryAnalysisReportRequestBody
extends ReferenceableRequestBody
    DiscoveryAnalysisReportRequestBody provides a structure for passing the properties of a discovery analysis report as a request body over a REST API.
    See Also:
    Serialized Form

    • Field Detail

      • displayName

        protected String displayName

      • description

        protected String description

      • creationDate

        protected Date creationDate

      • analysisStep

        protected String analysisStep

      • discoveryEngineGUID

        protected String discoveryEngineGUID

      • discoveryServiceGUID

        protected String discoveryServiceGUID

    • Constructor Detail

      • DiscoveryAnalysisReportRequestBody

        public DiscoveryAnalysisReportRequestBody()
        Default constructor

      • DiscoveryAnalysisReportRequestBody

        public DiscoveryAnalysisReportRequestBody​(DiscoveryAnalysisReportRequestBody template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        Return the display name of the discovery analysis report.
        Returns:
        String report name

      • setDisplayName

        public void setDisplayName​(String reportName)
        Set up the display name of the discovery analysis report.
        Parameters:
        reportName - String report name

      • getDescription

        public String getDescription()
        Return the discovery analysis report description.
        Returns:
        String report description

      • setDescription

        public void setDescription​(String reportDescription)
        Set up the discovery analysis report description.
        Parameters:
        reportDescription - String report description

      • getCreationDate

        public Date getCreationDate()
        Return the creation date for the report. If this date is not known then null is returned.
        Returns:
        Date that the report was created.

      • setCreationDate

        public void setCreationDate​(Date creationDate)
        Set up the creation date for the report. If this date is not known then null is returned.
        Parameters:
        creationDate - Date that the report was created.

      • getAnalysisParameters

        public Map<String,​String> getAnalysisParameters()
        Return the parameters used to drive the discovery service's analysis.
        Returns:
        map storing the analysis parameters

      • setAnalysisParameters

        public void setAnalysisParameters​(Map<String,​String> analysisParameters)
        Set up the parameters used to drive the discovery service's analysis.
        Parameters:
        analysisParameters - map storing the analysis parameters

      • getAnalysisStep

        public String getAnalysisStep()
        Return the current analysis step name.
        Returns:
        step name

      • setAnalysisStep

        public void setAnalysisStep​(String analysisStep)
        Set up the analysis step name.
        Parameters:
        analysisStep - new step name

      • getDiscoveryRequestStatus

        public DiscoveryRequestStatus getDiscoveryRequestStatus()
        Return the status of the discovery process.
        Returns:
        status enum

      • setDiscoveryRequestStatus

        public void setDiscoveryRequestStatus​(DiscoveryRequestStatus discoveryRequestStatus)
        Set up the status of the discovery process.
        Parameters:
        discoveryRequestStatus - status enum

      • getDiscoveryEngineGUID

        public String getDiscoveryEngineGUID()
        Return the unique identifier of the discovery engine that ran the discovery service.
        Returns:
        unique identifier (guid)

      • setDiscoveryEngineGUID

        public void setDiscoveryEngineGUID​(String discoveryEngineGUID)
        Set up the unique identifier of the discovery engine that ran the discovery service.
        Parameters:
        discoveryEngineGUID - unique identifier (guid)

      • getDiscoveryServiceGUID

        public String getDiscoveryServiceGUID()
        Return the unique identifier of the discovery service.
        Returns:
        unique identifier (guid)

      • setDiscoveryServiceGUID

        public void setDiscoveryServiceGUID​(String discoveryServiceGUID)
        Set up the unique identifier of the discovery service.
        Parameters:
        discoveryServiceGUID - unique identifier (guid)

      • equals

        public boolean equals​(Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class ReferenceableRequestBody
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison