Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Class APIOperation

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaType
org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DeployedAPIOperation
public class APIOperation extends SchemaType
APIOperation describes an API command used as part of an API schema. It also defines the structure of the header information, request and response.
See Also:

  • Field Details

    • command

      protected String command

    • headerSchemaType

      protected SchemaType headerSchemaType

    • requestSchemaType

      protected SchemaType requestSchemaType

    • responseSchemaType

      protected SchemaType responseSchemaType

  • Constructor Details

    • APIOperation

      public APIOperation()
      Default constructor used by subclasses

    • APIOperation

      public APIOperation(APIOperation template)
      Copy/clone Constructor.
      Parameters:
      template - template object to copy.

  • Method Details

    • getCommand

      public String getCommand()
      Return the command for this operation
      Returns:
      String name

    • setCommand

      public void setCommand(String command)
      Set up the command for this operation
      Parameters:
      command - name

    • getHeaderSchemaType

      public SchemaType getHeaderSchemaType()
      Return the structure of the API header (or null if no header).
      Returns:
      schema type

    • setHeaderSchemaType

      public void setHeaderSchemaType(SchemaType headerSchemaType)
      Set up the structure of the API header (or null if no header).
      Parameters:
      headerSchemaType - schema type

    • getRequestSchemaType

      public SchemaType getRequestSchemaType()
      Return the structure of the request parameters (request body).
      Returns:
      schema type

    • setRequestSchemaType

      public void setRequestSchemaType(SchemaType requestSchemaType)
      Set up the structure of the request parameters (request body).
      Parameters:
      requestSchemaType - schema type

    • getResponseSchemaType

      public SchemaType getResponseSchemaType()
      Return the structure of the response.
      Returns:
      schema type

    • setResponseSchemaType

      public void setResponseSchemaType(SchemaType responseSchemaType)
      Set up the structure of the response.
      Parameters:
      responseSchemaType - schema type

    • cloneSchemaElement

      public SchemaElement cloneSchemaElement()
      Returns a clone of this object as the abstract SchemaElement class.
      Overrides:
      cloneSchemaElement in class SchemaType
      Returns:
      PrimitiveSchemaType object

    • cloneSchemaType

      public SchemaType cloneSchemaType()
      Returns a clone of this object as the abstract SchemaType class.
      Overrides:
      cloneSchemaType in class SchemaType
      Returns:
      PrimitiveSchemaType object

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class SchemaType
      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 SchemaType
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class SchemaType
      Returns:
      int