org.odpi.openmetadata.accessservices.discoveryengine.rest

Class NewDiscoveryEngineRequestBody

java.lang.Object

org.odpi.openmetadata.accessservices.discoveryengine.rest.ODFOMASAPIRequestBody

org.odpi.openmetadata.accessservices.discoveryengine.rest.NewDiscoveryEngineRequestBody

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UpdateDiscoveryEngineRequestBody

public class NewDiscoveryEngineRequestBody
extends ODFOMASAPIRequestBody

NewDiscoveryEngineRequestBody provides a structure for passing the properties of a new discovery engine as a request body over a REST API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NewDiscoveryEngineRequestBody() Default constructor
NewDiscoveryEngineRequestBody(NewDiscoveryEngineRequestBody template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Equals method that returns true if containing properties are the same.
String	getDescription() Return the description of the discovery engine.
String	getDisplayName() Return the display name for messages and UI.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
int	hashCode() Return hash code for this object
void	setDescription(String description) Set up the description of the discovery engine.
void	setDisplayName(String displayName) Set up the display name for messages and UI.
void	setQualifiedName(String qualifiedName) Set up the fully qualified name.
String	toString() JSON-style toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewDiscoveryEngineRequestBody

public NewDiscoveryEngineRequestBody()

Default constructor

NewDiscoveryEngineRequestBody

public NewDiscoveryEngineRequestBody(NewDiscoveryEngineRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the fully qualified name.

Parameters:

qualifiedName - String name

getQualifiedName

public String getQualifiedName()

Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.

Returns:

qualifiedName

getDisplayName

public String getDisplayName()

Return the display name for messages and UI.

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up the display name for messages and UI.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description of the discovery engine.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the description of the discovery engine.

Parameters:

description - string

toString

public String toString()

JSON-style toString.

Overrides:

toString in class ODFOMASAPIRequestBody

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 Object

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code