Package org.odpi.openmetadata.repositoryservices.rest.properties

Class EntityCreateRequest

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest
org.odpi.openmetadata.repositoryservices.rest.properties.EntityCreateRequest
All Implemented Interfaces:
Serializable
public class EntityCreateRequest extends OMRSAPIRequest
EntityCreateRequest carries the properties needed to create a new entity.
See Also:

  • Constructor Details

    • EntityCreateRequest

      public EntityCreateRequest()
      Default constructor

    • EntityCreateRequest

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

  • Method Details

    • getEntityTypeGUID

      public String getEntityTypeGUID()
      Return the type of the new entity.
      Returns:
      String guid

    • setEntityTypeGUID

      public void setEntityTypeGUID(String entityTypeGUID)
      Set up the type of the new entity.
      Parameters:
      entityTypeGUID - String guid

    • getInitialProperties

      public InstanceProperties getInitialProperties()
      Return the list of properties for the new entity.
      Returns:
      instance properties object

    • setInitialProperties

      public void setInitialProperties(InstanceProperties initialProperties)
      Set up the initial properties for the entity.
      Parameters:
      initialProperties - InstanceProperties object

    • getInitialClassifications

      public List<Classification> getInitialClassifications()
      Return the list of classification for the new entity.
      Returns:
      list of classification objects

    • setInitialClassifications

      public void setInitialClassifications(List<Classification> initialClassifications)
      Set up the list of classification for the new entity.
      Parameters:
      initialClassifications - list of classification objects

    • getInitialStatus

      public InstanceStatus getInitialStatus()
      Return the initial status for the new entity.
      Returns:
      instance status enum

    • setInitialStatus

      public void setInitialStatus(InstanceStatus initialStatus)
      Set up the initial status for the new entity.
      Parameters:
      initialStatus - instance status enum

    • getMetadataCollectionId

      public String getMetadataCollectionId()
      Return the metadata collection id for this new entity
      Returns:
      guid

    • setMetadataCollectionId

      public void setMetadataCollectionId(String metadataCollectionId)
      Set up the metadata collection id for this new entity. This field is optional for addEntity and mandatory for addExternalEntity.
      Parameters:
      metadataCollectionId - guid

    • getMetadataCollectionName

      public String getMetadataCollectionName()
      Return the name of the metadata collection for this new relationship.
      Returns:
      name

    • setMetadataCollectionName

      public void setMetadataCollectionName(String metadataCollectionName)
      Set up the name of the metadata collection for this new relationship.
      Parameters:
      metadataCollectionName - name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class Object
      Returns:
      int hash code