Package org.odpi.openmetadata.frameworkservices.omf.rest

Class UpdatePropertiesRequestBody

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions

org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions

org.odpi.openmetadata.frameworks.openmetadata.search.UpdateOptions

org.odpi.openmetadata.frameworkservices.omf.rest.UpdatePropertiesRequestBody

public class UpdatePropertiesRequestBody
extends UpdateOptions

UpdatePropertiesRequestBody provides a structure for passing the properties for updating metadata elements, relationships or classifications.

Constructor Summary

Constructors

Constructor	Description
UpdatePropertiesRequestBody()	Default constructor
UpdatePropertiesRequestBody(UpdateOptions template)	Copy/clone constructor
UpdatePropertiesRequestBody(UpdatePropertiesRequestBody template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Equals method that returns true if containing properties are the same.
ElementProperties	getProperties()	Return the properties for the update.
int	hashCode()	Return hash code for this object
void	setProperties(ElementProperties properties)	Set up the properties for the update.
String	toString()	JSON-style toString.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.UpdateOptions

getMergeUpdate, setMergeUpdate

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions

getExternalSourceGUID, getExternalSourceName, setExternalSourceGUID, setExternalSourceName

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions

getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter

Methods inherited from class java.lang.Object

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

Constructor Details

UpdatePropertiesRequestBody

public UpdatePropertiesRequestBody()

Default constructor

UpdatePropertiesRequestBody

public UpdatePropertiesRequestBody(UpdatePropertiesRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

UpdatePropertiesRequestBody

public UpdatePropertiesRequestBody(UpdateOptions template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getProperties

public ElementProperties getProperties()

Return the properties for the update.

Returns:

list of properties

setProperties

public void setProperties(ElementProperties properties)

Set up the properties for the update.

Parameters:

properties - list of properties

toString

public String toString()

JSON-style toString.

Overrides:

toString in class UpdateOptions

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class UpdateOptions

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class UpdateOptions

Returns:

int hash code