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
public class APIOperationProperties extends ComplexSchemaTypeProperties
APIOperationProperties is a class for an operation within an API specification.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description APIOperationProperties()
Default constructorAPIOperationProperties(APIOperationProperties template)
Copy/clone constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object objectToCompare)
Compare the values of the supplied object with those stored in the current object.String
getCommand()
Return the command (eg GET, POST or method name) that is called.String
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
setPath(String path)
Set up the path name to add to the network address in the API's endpoint.String
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 Detail
-
APIOperationProperties
public APIOperationProperties()
Default constructor
-
APIOperationProperties
public APIOperationProperties(APIOperationProperties template)
Copy/clone constructor.- Parameters:
template
- object to copy
-
-
Method Detail
-
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 classComplexSchemaTypeProperties
- 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 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
-
-