Class TemplateRequestBody
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions
org.odpi.openmetadata.frameworks.openmetadata.search.AnchorOptions
org.odpi.openmetadata.frameworks.openmetadata.search.NewLinkedElementOptions
org.odpi.openmetadata.frameworks.openmetadata.search.NewElementOptions
org.odpi.openmetadata.frameworks.openmetadata.search.TemplateOptions
org.odpi.openmetadata.commonservices.ffdc.rest.TemplateRequestBody
TemplateRequestBody provides a structure for passing the properties for a new metadata element
that is to be created via a template.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorTemplateRequestBody
(TemplateRequestBody template) Copy/clone constructorTemplateRequestBody
(TemplateOptions template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equals method that returns true if containing properties are the same.Return any properties that should be included in the parent relationship.Return the property values to replace placeholders in the template.Return the properties for the new metadata element.Returns the unique identifier of the element to use as a template (optional).int
hashCode()
Return hash code for this objectvoid
setParentRelationshipProperties
(RelationshipProperties parentRelationshipProperties) Set up any properties that should be included in the parent relationship.void
setPlaceholderPropertyValues
(Map<String, String> placeholderPropertyValues) Set up the property values to replace placeholders in the template.void
setReplacementProperties
(ElementProperties replacementProperties) Set up the properties for the new metadata element.void
setTemplateGUID
(String templateGUID) Set up the unique identifier of the element to use as a template (optional).toString()
JSON-style toString.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.TemplateOptions
getAllowRetrieve, getDeepCopy, getEffectiveFrom, getEffectiveTo, getIsTemplateSubstitute, setAllowRetrieve, setDeepCopy, setEffectiveFrom, setEffectiveTo, setIsTemplateSubstitute
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.NewElementOptions
getInitialStatus, setInitialStatus
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.NewLinkedElementOptions
getParentAtEnd1, getParentGUID, getParentRelationshipTypeName, setParentAtEnd1, setParentGUID, setParentRelationshipTypeName
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.AnchorOptions
getAnchorGUID, getAnchorScopeGUID, getIsOwnAnchor, setAnchorGUID, setAnchorScopeGUID, setIsOwnAnchor
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions
getExternalSourceGUID, getExternalSourceName, setExternalSourceGUID, setExternalSourceName
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter
-
Constructor Details
-
TemplateRequestBody
public TemplateRequestBody()Default constructor -
TemplateRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
TemplateRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getReplacementProperties
Return the properties for the new metadata element.- Returns:
- list of properties
-
setReplacementProperties
Set up the properties for the new metadata element.- Parameters:
replacementProperties
- list of properties
-
setTemplateGUID
Set up the unique identifier of the element to use as a template (optional).- Parameters:
templateGUID
- String guid
-
getTemplateGUID
Returns the unique identifier of the element to use as a template (optional).- Returns:
- string guid
-
getPlaceholderPropertyValues
Return the property values to replace placeholders in the template.- Returns:
- map of property name to property value
-
setPlaceholderPropertyValues
Set up the property values to replace placeholders in the template.- Parameters:
placeholderPropertyValues
- map of property name to property value
-
getParentRelationshipProperties
Return any properties that should be included in the parent relationship.- Returns:
- element properties
-
setParentRelationshipProperties
Set up any properties that should be included in the parent relationship.- Parameters:
parentRelationshipProperties
- element properties
-
toString
JSON-style toString.- Overrides:
toString
in classTemplateOptions
- Returns:
- list of properties and their values.
-
equals
Equals method that returns true if containing properties are the same.- Overrides:
equals
in classTemplateOptions
- Parameters:
objectToCompare
- object to compare- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCode
in classTemplateOptions
- Returns:
- int hash code
-