Class FindRequestBody
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
org.odpi.openmetadata.frameworkservices.omf.rest.FindRequestBody
FindRequestBody provides a structure for passing the properties for the find request.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorFindRequestBody
(QueryOptions template) Copy/clone constructorFindRequestBody
(FindRequestBody template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equals method that returns true if containing properties are the same.Return details about the classifications that need to be present/absent from the search request.Return the details of the property values that must be true for the returned metadata elements.int
hashCode()
Return hash code for this objectvoid
setMatchClassifications
(SearchClassifications matchClassifications) Set up details about the classifications that need to be present/absent from the search request.void
setSearchProperties
(SearchProperties searchProperties) Set up the details of the property values that must be true for the returned metadata elements.toString()
JSON-style toString.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
getAnchorGUID, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAnchorGUID, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
getPageSize, getStartFrom, setPageSize, setStartFrom
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
getAsOfTime, getGraphQueryDepth, getIncludeOnlyClassifiedElements, getIncludeOnlyRelationships, getMetadataElementSubtypeNames, getMetadataElementTypeName, getSkipClassifiedElements, getSkipRelationships, setAsOfTime, setGraphQueryDepth, setIncludeOnlyClassifiedElements, setIncludeOnlyRelationships, setMetadataElementSubtypeNames, setMetadataElementTypeName, setSkipClassifiedElements, setSkipRelationships
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter
-
Constructor Details
-
FindRequestBody
public FindRequestBody()Default constructor -
FindRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
FindRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getSearchProperties
Return the details of the property values that must be true for the returned metadata elements.- Returns:
- property specification
-
setSearchProperties
Set up the details of the property values that must be true for the returned metadata elements.- Parameters:
searchProperties
- property specification
-
getMatchClassifications
Return details about the classifications that need to be present/absent from the search request.- Returns:
- classification specification
-
setMatchClassifications
Set up details about the classifications that need to be present/absent from the search request.- Parameters:
matchClassifications
- classification specification
-
toString
JSON-style toString.- Overrides:
toString
in classResultsRequestBody
- Returns:
- list of properties and their values.
-
equals
Equals method that returns true if containing properties are the same.- Overrides:
equals
in classQueryOptions
- Parameters:
objectToCompare
- object to compare- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCode
in classQueryOptions
- Returns:
- int hash code
-