Package org.odpi.openmetadata.frameworkservices.omf.rest

Class OpenMetadataTemplateRequestBody

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.frameworkservices.omf.rest.OpenMetadataTemplateRequestBody
public class OpenMetadataTemplateRequestBody extends TemplateOptions
TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.

  • Constructor Details

    • OpenMetadataTemplateRequestBody

      public OpenMetadataTemplateRequestBody()
      Default constructor

    • OpenMetadataTemplateRequestBody

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

    • OpenMetadataTemplateRequestBody

      public OpenMetadataTemplateRequestBody(TemplateOptions template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getTypeName

      public String getTypeName()
      Return the open metadata type name for the new metadata element.
      Returns:
      string name

    • setTypeName

      public void setTypeName(String typeName)
      Set up the open metadata type name for the new metadata element.
      Parameters:
      typeName - string name

    • getReplacementProperties

      public ElementProperties getReplacementProperties()
      Return the properties for the new metadata element.
      Returns:
      list of properties

    • setReplacementProperties

      public void setReplacementProperties(ElementProperties replacementProperties)
      Set up the properties for the new metadata element.
      Parameters:
      replacementProperties - list of properties

    • setTemplateGUID

      public void setTemplateGUID(String templateGUID)
      Set up the unique identifier of the element to use as a template (optional).
      Parameters:
      templateGUID - String guid

    • getTemplateGUID

      public String getTemplateGUID()
      Returns the unique identifier of the element to use as a template (optional).
      Returns:
      string guid

    • getPlaceholderPropertyValues

      public Map<String,String> getPlaceholderPropertyValues()
      Return the property values to replace placeholders in the template.
      Returns:
      map of property name to property value

    • setPlaceholderPropertyValues

      public void setPlaceholderPropertyValues(Map<String,String> placeholderPropertyValues)
      Set up the property values to replace placeholders in the template.
      Parameters:
      placeholderPropertyValues - map of property name to property value

    • getParentRelationshipProperties

      public NewElementProperties getParentRelationshipProperties()
      Return any properties that should be included in the parent relationship.
      Returns:
      element properties

    • setParentRelationshipProperties

      public void setParentRelationshipProperties(NewElementProperties parentRelationshipProperties)
      Set up any properties that should be included in the parent relationship.
      Parameters:
      parentRelationshipProperties - element properties

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class TemplateOptions
      Returns:
      list of properties and their values.

    • equals

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

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class TemplateOptions
      Returns:
      int hash code