Class APIOperationProperties
java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaTypeProperties
org.odpi.openmetadata.accessservices.datamanager.properties.ComplexSchemaTypeProperties
org.odpi.openmetadata.accessservices.datamanager.properties.APIOperationProperties
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
APIOperationRequestBody
APIOperationProperties is a class for an operation within an API specification.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorAPIOperationProperties
(APIOperationProperties template) Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the command (eg GET, POST or method name) that is called.getPath()
Return the path name to add to the network address in the API's endpoint.int
hashCode()
Create a hash code for this element type.void
setCommand
(String command) Set up the command (eg GET, POST or method name) that is called.void
Set up the path name to add to the network address in the API's endpoint.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaTypeProperties
getAuthor, getEncodingStandard, getNamespace, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setNamespace, setUsage, setVersionNumber
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
Constructor Details
-
APIOperationProperties
public APIOperationProperties()Default constructor -
APIOperationProperties
Copy/clone constructor.- Parameters:
template
- object to copy
-
-
Method Details
-
getPath
Return the path name to add to the network address in the API's endpoint.- Returns:
- string path name
-
setPath
Set up the path name to add to the network address in the API's endpoint.- Parameters:
path
- string path name
-
getCommand
Return the command (eg GET, POST or method name) that is called.- Returns:
- string command name
-
setCommand
Set up the command (eg GET, POST or method name) that is called.- Parameters:
command
- command string
-
toString
Standard toString method.- Overrides:
toString
in classComplexSchemaTypeProperties
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classSchemaTypeProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classSchemaTypeProperties
- Returns:
- int hash code
-