Package org.odpi.openmetadata.commonservices.ffdc.rest

Class APIParameterListRequestBody

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.ComplexSchemaTypeProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties
org.odpi.openmetadata.commonservices.ffdc.rest.APIParameterListRequestBody
public class APIParameterListRequestBody extends org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties
APIParameterListRequestBody describes the properties of the API parameter list plus the optional identifiers for an owning software server capability.

  • Constructor Summary

    Constructors
    Constructor
    Description
    APIParameterListRequestBody()
    Default constructor
    APIParameterListRequestBody(APIParameterListRequestBody template)
    Copy/clone constructor.
    APIParameterListRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties template)
    Copy/clone constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    String
    getExternalSourceGUID()
    Return the unique identifier of the software server capability entity that represented the external source - null for local.
    String
    getExternalSourceName()
    Return the unique name of the software server capability entity that represented the external source.
    int
    hashCode()
    Return hash code for this object
    void
    setExternalSourceGUID(String externalSourceGUID)
    Set up the unique identifier of the software server capability entity that represented the external source - null for local.
    void
    setExternalSourceName(String externalSourceName)
    Set up the unique name of the software server capability entity that represented the external source.
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties

    getRequired, setRequired

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties

    getAuthor, getEncodingStandard, getFormula, getFormulaType, getNamespace, getQueries, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setFormula, setFormulaType, setNamespace, setQueries, setUsage, setVersionNumber

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties

    getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

    getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • APIParameterListRequestBody

      public APIParameterListRequestBody()
      Default constructor

    • APIParameterListRequestBody

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

    • APIParameterListRequestBody

      public APIParameterListRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties template)
      Copy/clone constructor.
      Parameters:
      template - object to copy

  • Method Details

    • getExternalSourceGUID

      public String getExternalSourceGUID()
      Return the unique identifier of the software server capability entity that represented the external source - null for local.
      Returns:
      string guid

    • setExternalSourceGUID

      public void setExternalSourceGUID(String externalSourceGUID)
      Set up the unique identifier of the software server capability entity that represented the external source - null for local.
      Parameters:
      externalSourceGUID - string guid

    • getExternalSourceName

      public String getExternalSourceName()
      Return the unique name of the software server capability entity that represented the external source.
      Returns:
      string name

    • setExternalSourceName

      public void setExternalSourceName(String externalSourceName)
      Set up the unique name of the software server capability entity that represented the external source.
      Parameters:
      externalSourceName - string name

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterListProperties
      Returns:
      int hash code