org.odpi.openmetadata.governanceservers.discoveryengineservices.properties

Class DiscoveryEngineSummary

java.lang.Object

org.odpi.openmetadata.governanceservers.discoveryengineservices.properties.DiscoveryEngineSummary

All Implemented Interfaces:

Serializable

public class DiscoveryEngineSummary
extends Object
implements Serializable

DiscoveryEngineSummary is a summary of the properties known about a specific discovery engine.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare objects
String	getDiscoveryEngineDescription() Return the description of the discovery engine.
String	getDiscoveryEngineGUID() Return the discovery engine's unique identifier.
String	getDiscoveryEngineName() Return the name of this discovery engine.
DiscoveryEngineStatus	getDiscoveryEngineStatus() Return the status of the discovery engine.
List<String>	getDiscoveryRequestTypes() Return the list of request types that this discovery engine supports.
int	hashCode() Simple hash for the object
void	setDiscoveryEngineDescription(String discoveryEngineDescription) Set up the description of the discovery engine.
void	setDiscoveryEngineGUID(String discoveryEngineGUID) Set up the discovery engine's unique identifier.
void	setDiscoveryEngineName(String discoveryEngineName) Set up the name of this discovery engine.
void	setDiscoveryEngineStatus(DiscoveryEngineStatus discoveryEngineStatus) Set up the status of the discovery engine.
void	setDiscoveryRequestTypes(List<String> discoveryRequestTypes) Set up the discovery request types
String	toString() JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryEngineSummary

public DiscoveryEngineSummary()

Default constructor

DiscoveryEngineSummary

public DiscoveryEngineSummary(DiscoveryEngineSummary template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getDiscoveryEngineName

public String getDiscoveryEngineName()

Return the name of this discovery engine.

Returns:

string name

setDiscoveryEngineName

public void setDiscoveryEngineName(String discoveryEngineName)

Set up the name of this discovery engine.

Parameters:

discoveryEngineName - string name

getDiscoveryEngineGUID

public String getDiscoveryEngineGUID()

Return the discovery engine's unique identifier. This is only available if the discovery engine has managed to retrieve its configuration from the metadata server.

Returns:

string identifier

setDiscoveryEngineGUID

public void setDiscoveryEngineGUID(String discoveryEngineGUID)

Set up the discovery engine's unique identifier.

Parameters:

discoveryEngineGUID - string identifier

getDiscoveryEngineDescription

public String getDiscoveryEngineDescription()

Return the description of the discovery engine. This is only available if the discovery engine has managed to retrieve its configuration from the metadata server.

Returns:

string description

setDiscoveryEngineDescription

public void setDiscoveryEngineDescription(String discoveryEngineDescription)

Set up the description of the discovery engine.

Parameters:

discoveryEngineDescription - string description

getDiscoveryEngineStatus

public DiscoveryEngineStatus getDiscoveryEngineStatus()

Return the status of the discovery engine.

Returns:

status enum

setDiscoveryEngineStatus

public void setDiscoveryEngineStatus(DiscoveryEngineStatus discoveryEngineStatus)

Set up the status of the discovery engine.

Parameters:

discoveryEngineStatus - status enum

getDiscoveryRequestTypes

public List<String> getDiscoveryRequestTypes()

Return the list of request types that this discovery engine supports.

Returns:

list of strings (discovery request types)

setDiscoveryRequestTypes

public void setDiscoveryRequestTypes(List<String> discoveryRequestTypes)

Set up the discovery request types

Parameters:

discoveryRequestTypes - list of strings (discovery request types)

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

Returns:

description of the object values

equals

public boolean equals(Object objectToCompare)

Compare objects

Overrides:

equals in class Object

Parameters:

objectToCompare - object

Returns:

boolean

hashCode

public int hashCode()

Simple hash for the object

Overrides:

hashCode in class Object

Returns:

int