Package org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis

Class APIOperationProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIOperationProperties
public class APIOperationProperties extends SchemaTypeProperties
APIOperationProperties is a class for an operation within an API specification.

  • Constructor Details

    • APIOperationProperties

      public APIOperationProperties()
      Default constructor

    • APIOperationProperties

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

  • Method Details

    • getPath

      public String getPath()
      Return the path name to add to the network address in the API's endpoint.
      Returns:
      string path name

    • setPath

      public void setPath(String path)
      Set up the path name to add to the network address in the API's endpoint.
      Parameters:
      path - string path name

    • getCommand

      public String getCommand()
      Return the command (eg GET, POST or method name) that is called.
      Returns:
      string command name

    • setCommand

      public void setCommand(String command)
      Set up the command (eg GET, POST or method name) that is called.
      Parameters:
      command - command string

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class SchemaTypeProperties
      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 SchemaTypeProperties
      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 SchemaTypeProperties
      Returns:
      int hash code