Class UniqueNameRequestBody
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
org.odpi.openmetadata.frameworkservices.omf.rest.UniqueNameRequestBody
UniqueNameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve
an element by name.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorUniqueNameRequestBody
(GetOptions template) Copy/clone constructorUniqueNameRequestBody
(UniqueNameRequestBody template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.getName()
Return the name for the query request.Return the parameter name.Return the property name from the open metadata types.int
hashCode()
Create a hash code for this element type.void
Set up the name for the query request.void
setNameParameterName
(String nameParameterName) Set up the parameter name.void
setNamePropertyName
(String namePropertyName) Set up the property name from the open metadata types.toString()
Standard toString method.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
-
UniqueNameRequestBody
public UniqueNameRequestBody()Default constructor -
UniqueNameRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
UniqueNameRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getName
Return the name for the query request.- Returns:
- string name
-
setName
Set up the name for the query request.- Parameters:
name
- string
-
getNameParameterName
Return the parameter name.- Returns:
- string name
-
setNameParameterName
Set up the parameter name.- Parameters:
nameParameterName
- string
-
getNamePropertyName
Return the property name from the open metadata types.- Returns:
- string name
-
setNamePropertyName
Set up the property name from the open metadata types.- Parameters:
namePropertyName
- string
-
toString
Standard toString method.- Overrides:
toString
in classGetOptions
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classGetOptions
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classGetOptions
- Returns:
- int hash code
-