Class EntityCreateRequest

  • All Implemented Interfaces:
    java.io.Serializable

    public class EntityCreateRequest
    extends OMRSAPIRequest
    EntityCreateRequest carries the properties needed to create a new entity.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.lang.String getEntityTypeGUID()
      Return the type of the new entity.
      java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> getInitialClassifications()
      Return the list of classification for the new entity.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getInitialProperties()
      Return the list of properties for the new entity.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus getInitialStatus()
      Return the initial status for the new entity.
      java.lang.String getMetadataCollectionId()
      Return the metadata collection id for this new entity
      java.lang.String getMetadataCollectionName()
      Return the name of the metadata collection for this new relationship.
      int hashCode()
      Create a hash code for this element type.
      void setEntityTypeGUID​(java.lang.String entityTypeGUID)
      Set up the type of the new entity.
      void setInitialClassifications​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> initialClassifications)
      Set up the list of classification for the new entity.
      void setInitialProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties)
      Set up the initial properties for the entity.
      void setInitialStatus​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
      Set up the initial status for the new entity.
      void setMetadataCollectionId​(java.lang.String metadataCollectionId)
      Set up the metadata collection id for this new entity.
      void setMetadataCollectionName​(java.lang.String metadataCollectionName)
      Set up the name of the metadata collection for this new relationship.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • EntityCreateRequest

        public EntityCreateRequest()
        Default constructor
      • EntityCreateRequest

        public EntityCreateRequest​(EntityCreateRequest template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getEntityTypeGUID

        public java.lang.String getEntityTypeGUID()
        Return the type of the new entity.
        Returns:
        String guid
      • setEntityTypeGUID

        public void setEntityTypeGUID​(java.lang.String entityTypeGUID)
        Set up the type of the new entity.
        Parameters:
        entityTypeGUID - String guid
      • getInitialProperties

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getInitialProperties()
        Return the list of properties for the new entity.
        Returns:
        instance properties object
      • setInitialProperties

        public void setInitialProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties)
        Set up the initial properties for the entity.
        Parameters:
        initialProperties - InstanceProperties object
      • getInitialClassifications

        public java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> getInitialClassifications()
        Return the list of classification for the new entity.
        Returns:
        list of classification objects
      • setInitialClassifications

        public void setInitialClassifications​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> initialClassifications)
        Set up the list of classification for the new entity.
        Parameters:
        initialClassifications - list of classification objects
      • getInitialStatus

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus getInitialStatus()
        Return the initial status for the new entity.
        Returns:
        instance status enum
      • setInitialStatus

        public void setInitialStatus​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
        Set up the initial status for the new entity.
        Parameters:
        initialStatus - instance status enum
      • getMetadataCollectionId

        public java.lang.String getMetadataCollectionId()
        Return the metadata collection id for this new entity
        Returns:
        guid
      • setMetadataCollectionId

        public void setMetadataCollectionId​(java.lang.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 java.lang.String getMetadataCollectionName()
        Return the name of the metadata collection for this new relationship.
        Returns:
        name
      • setMetadataCollectionName

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

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

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        int hash code