Package org.odpi.openmetadata.frameworkservices.gaf.rest

Class NewMetadataElementRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.rest.MetadataSourceRequestBody
org.odpi.openmetadata.frameworkservices.gaf.rest.NewMetadataElementRequestBody
public class NewMetadataElementRequestBody extends MetadataSourceRequestBody
NewMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NewMetadataElementRequestBody()
    Default constructor
    NewMetadataElementRequestBody(NewMetadataElementRequestBody template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    Date
    getEffectiveFrom()
    Return the date/time that this new element becomes effective in the governance program (null means immediately).
    Date
    getEffectiveTime()
    Return the effective time use on any queries for related elements.
    Date
    getEffectiveTo()
    Return the date/time when the new element is no longer effective in the governance program (null means until deleted).
    org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus
    getInitialStatus()
    Return the initial status of the metadata element (typically ACTIVE).
    org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties
    getProperties()
    Return the properties for the new metadata element.
    String
    getTemplateGUID()
    Returns the unique identifier of the element to use as a template (optional).
    String
    getTypeName()
    Return the open metadata type name for the new metadata element.
    int
    hashCode()
    Return hash code for this object
    void
    setEffectiveFrom(Date effectiveFrom)
    Set up the date/time that this new element becomes effective in the governance program (null means immediately).
    void
    setEffectiveTime(Date effectiveTime)
    Set up the effective time use on any queries for related elements.
    void
    setEffectiveTo(Date effectiveTo)
    Set up the date/time when the new element is no longer effective in the governance program (null means until deleted).
    void
    setInitialStatus(org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus initialStatus)
    Set up the initial status of the metadata element (typically ACTIVE).
    void
    setProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties properties)
    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).
    void
    setTypeName(String typeName)
    Set up the open metadata type name for the new metadata element.
    String
    toString()
    JSON-style toString.

    Methods inherited from class org.odpi.openmetadata.frameworkservices.gaf.rest.MetadataSourceRequestBody

    getExternalSourceGUID, getExternalSourceName, setExternalSourceGUID, setExternalSourceName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NewMetadataElementRequestBody

      public NewMetadataElementRequestBody()
      Default constructor

    • NewMetadataElementRequestBody

      public NewMetadataElementRequestBody(NewMetadataElementRequestBody 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

    • getInitialStatus

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus getInitialStatus()
      Return the initial status of the metadata element (typically ACTIVE).
      Returns:
      element status enum value

    • setInitialStatus

      public void setInitialStatus(org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus initialStatus)
      Set up the initial status of the metadata element (typically ACTIVE).
      Parameters:
      initialStatus - element status enum value

    • getEffectiveFrom

      public Date getEffectiveFrom()
      Return the date/time that this new element becomes effective in the governance program (null means immediately).
      Returns:
      date object

    • setEffectiveFrom

      public void setEffectiveFrom(Date effectiveFrom)
      Set up the date/time that this new element becomes effective in the governance program (null means immediately).
      Parameters:
      effectiveFrom - date object

    • getEffectiveTo

      public Date getEffectiveTo()
      Return the date/time when the new element is no longer effective in the governance program (null means until deleted).
      Returns:
      date object

    • setEffectiveTo

      public void setEffectiveTo(Date effectiveTo)
      Set up the date/time when the new element is no longer effective in the governance program (null means until deleted).
      Parameters:
      effectiveTo - date object

    • getProperties

      public org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties getProperties()
      Return the properties for the new metadata element.
      Returns:
      list of properties

    • setProperties

      public void setProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties properties)
      Set up the properties for the new metadata element.
      Parameters:
      properties - 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

    • getEffectiveTime

      public Date getEffectiveTime()
      Return the effective time use on any queries for related elements.
      Returns:
      date object

    • setEffectiveTime

      public void setEffectiveTime(Date effectiveTime)
      Set up the effective time use on any queries for related elements.
      Parameters:
      effectiveTime - date object

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class MetadataSourceRequestBody
      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 MetadataSourceRequestBody
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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