Package org.odpi.openmetadata.frameworks.integration.bitol.odps

Class DataProductManagementPort

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.odps.DataProductManagementPort
public class DataProductManagementPort extends Object
This class represents a management port of an Open Data Product Standard (ODPS) data product. Management ports are the access points used to manage the data product, covering discoverability, observability, control and dictionary content.

  • Constructor Details

    • DataProductManagementPort

      public DataProductManagementPort()
      Default constructor

  • Method Details

    • getName

      public String getName()
      Return the unique name (endpoint identifier) of the management port.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the unique name (endpoint identifier) of the management port.
      Parameters:
      name - string name

    • getContent

      public String getContent()
      Return the type of content: discoverability, observability, control or dictionary. Standard values are defined in DataProductManagementPortContent.
      Returns:
      string content type

    • setContent

      public void setContent(String content)
      Set up the type of content: discoverability, observability, control or dictionary. Standard values are defined in DataProductManagementPortContent.
      Parameters:
      content - string content type

    • getType

      public String getType()
      Return the type of access: rest or topic. Standard values are defined in DataProductManagementPortType.
      Returns:
      string type name

    • setType

      public void setType(String type)
      Set up the type of access: rest or topic. Standard values are defined in DataProductManagementPortType.
      Parameters:
      type - string type name

    • getUrl

      public String getUrl()
      Return the URL used to access the endpoint.
      Returns:
      string URL

    • setUrl

      public void setUrl(String url)
      Set up the URL used to access the endpoint.
      Parameters:
      url - string URL

    • getChannel

      public String getChannel()
      Return the channel (for example topic name) used to communicate with the data product.
      Returns:
      string channel name

    • setChannel

      public void setChannel(String channel)
      Set up the channel (for example topic name) used to communicate with the data product.
      Parameters:
      channel - string channel name

    • getDescription

      public String getDescription()
      Return the purpose and usage of the management port.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the purpose and usage of the management port.
      Parameters:
      description - string description

    • getTags

      public List<String> getTags()
      Return the list of tags attached to this element.
      Returns:
      list of tag strings

    • setTags

      public void setTags(List<String> tags)
      Set up the list of tags attached to this element.
      Parameters:
      tags - list of tag strings

    • getCustomProperties

      public List<BitolCustomProperty> getCustomProperties()
      Return the list of custom (key/value) properties attached to this element.
      Returns:
      list of custom properties

    • setCustomProperties

      public void setCustomProperties(List<BitolCustomProperty> customProperties)
      Set up the list of custom (key/value) properties attached to this element.
      Parameters:
      customProperties - list of custom properties

    • getAuthoritativeDefinitions

      public List<BitolAuthoritativeDefinition> getAuthoritativeDefinitions()
      Return the list of links to sources that provide more details about this element.
      Returns:
      list of authoritative definitions

    • setAuthoritativeDefinitions

      public void setAuthoritativeDefinitions(List<BitolAuthoritativeDefinition> authoritativeDefinitions)
      Set up the list of links to sources that provide more details about this element.
      Parameters:
      authoritativeDefinitions - list of authoritative definitions

    • getId

      public String getId()
      Return the stable identifier of this port.
      Returns:
      String

    • setId

      public void setId(String id)
      Set up the stable identifier of this port.
      Parameters:
      id - String

    • getDeprecated

      public Boolean getDeprecated()
      Return whether this port is deprecated and should not be used in new implementations.
      Returns:
      Boolean

    • setDeprecated

      public void setDeprecated(Boolean deprecated)
      Set up whether this port is deprecated and should not be used in new implementations.
      Parameters:
      deprecated - Boolean

    • 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()
      Return hash code based on properties.
      Overrides:
      hashCode in class Object
      Returns:
      int