Package org.odpi.openmetadata.accessservices.datamanager.rest

Class APIRequestBody

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.datamanager.properties.AssetProperties

org.odpi.openmetadata.accessservices.datamanager.properties.APIProperties

org.odpi.openmetadata.accessservices.datamanager.rest.APIRequestBody

All Implemented Interfaces:

Serializable

public class APIRequestBody
extends APIProperties

APIRequestBody describes the properties of the API plus the optional identifiers for an owning software server capability.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
APIRequestBody()	Default constructor
APIRequestBody(APIProperties template)	Copy/clone constructor.
APIRequestBody(APIRequestBody 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.accessservices.datamanager.properties.AssetProperties

getDescription, getDisplayName, getName, getVersionIdentifier, setDescription, setDisplayName, setName, setVersionIdentifier

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

APIRequestBody

public APIRequestBody()

Default constructor

APIRequestBody

public APIRequestBody(APIRequestBody template)

Copy/clone constructor.

Parameters:

template - object to copy

APIRequestBody

public APIRequestBody(APIProperties 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 APIProperties

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 AssetProperties

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class AssetProperties

Returns:

int hash code