Class DiscoveryAnalysisReportRequestBody
java.lang.Object
org.odpi.openmetadata.accessservices.discoveryengine.rest.ODFOMASAPIRequestBody
org.odpi.openmetadata.accessservices.discoveryengine.rest.ReferenceableRequestBody
org.odpi.openmetadata.accessservices.discoveryengine.rest.DiscoveryAnalysisReportRequestBody
- All Implemented Interfaces:
Serializable
DiscoveryAnalysisReportRequestBody provides a structure for passing the properties of
a discovery analysis report as a request body over a REST API.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected Date
protected String
protected String
protected DiscoveryRequestStatus
protected String
protected String
Fields inherited from class org.odpi.openmetadata.accessservices.discoveryengine.rest.ReferenceableRequestBody
additionalProperties, classifications, extendedProperties, meanings, qualifiedName, typeName
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equals method that returns true if containing properties are the same.Return the parameters used to drive the discovery service's analysis.Return the current analysis step name.Return the creation date for the report.Return the discovery analysis report description.Return the unique identifier of the discovery engine that ran the discovery service.Return the status of the discovery process.Return the unique identifier of the discovery service.Return the display name of the discovery analysis report.int
hashCode()
Return hash code for this objectvoid
setAnalysisParameters
(Map<String, String> analysisParameters) Set up the parameters used to drive the discovery service's analysis.void
setAnalysisStep
(String analysisStep) Set up the analysis step name.void
setCreationDate
(Date creationDate) Set up the creation date for the report.void
setDescription
(String reportDescription) Set up the discovery analysis report description.void
setDiscoveryEngineGUID
(String discoveryEngineGUID) Set up the unique identifier of the discovery engine that ran the discovery service.void
setDiscoveryRequestStatus
(DiscoveryRequestStatus discoveryRequestStatus) Set up the status of the discovery process.void
setDiscoveryServiceGUID
(String discoveryServiceGUID) Set up the unique identifier of the discovery service.void
setDisplayName
(String reportName) Set up the display name of the discovery analysis report.toString()
JSON-style toString.Methods inherited from class org.odpi.openmetadata.accessservices.discoveryengine.rest.ReferenceableRequestBody
getAdditionalProperties, getClassifications, getExtendedProperties, getMeanings, getQualifiedName, getTypeName, setAdditionalProperties, setClassifications, setExtendedProperties, setMeanings, setQualifiedName, setTypeName
-
Field Details
-
displayName
-
description
-
creationDate
-
analysisParameters
-
analysisStep
-
discoveryRequestStatus
-
discoveryEngineGUID
-
discoveryServiceGUID
-
-
Constructor Details
-
DiscoveryAnalysisReportRequestBody
public DiscoveryAnalysisReportRequestBody()Default constructor -
DiscoveryAnalysisReportRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getDisplayName
Return the display name of the discovery analysis report.- Returns:
- String report name
-
setDisplayName
Set up the display name of the discovery analysis report.- Parameters:
reportName
- String report name
-
getDescription
Return the discovery analysis report description.- Returns:
- String report description
-
setDescription
Set up the discovery analysis report description.- Parameters:
reportDescription
- String report description
-
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
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
Return the parameters used to drive the discovery service's analysis.- Returns:
- map storing the analysis parameters
-
setAnalysisParameters
Set up the parameters used to drive the discovery service's analysis.- Parameters:
analysisParameters
- map storing the analysis parameters
-
getAnalysisStep
Return the current analysis step name.- Returns:
- step name
-
setAnalysisStep
Set up the analysis step name.- Parameters:
analysisStep
- new step name
-
getDiscoveryRequestStatus
Return the status of the discovery process.- Returns:
- status enum
-
setDiscoveryRequestStatus
Set up the status of the discovery process.- Parameters:
discoveryRequestStatus
- status enum
-
getDiscoveryEngineGUID
Return the unique identifier of the discovery engine that ran the discovery service.- Returns:
- unique identifier (guid)
-
setDiscoveryEngineGUID
Set up the unique identifier of the discovery engine that ran the discovery service.- Parameters:
discoveryEngineGUID
- unique identifier (guid)
-
getDiscoveryServiceGUID
Return the unique identifier of the discovery service.- Returns:
- unique identifier (guid)
-
setDiscoveryServiceGUID
Set up the unique identifier of the discovery service.- Parameters:
discoveryServiceGUID
- unique identifier (guid)
-
toString
JSON-style toString.- Overrides:
toString
in classReferenceableRequestBody
- Returns:
- list of properties and their values.
-
equals
Equals method that returns true if containing properties are the same.- Overrides:
equals
in classReferenceableRequestBody
- Parameters:
objectToCompare
- object to compare- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCode
in classReferenceableRequestBody
- Returns:
- int hash code
-