Package org.odpi.openmetadata.conformance.workbenches.performance

Enum Class PerformanceProfile

java.lang.Object

java.lang.Enum<PerformanceProfile>

org.odpi.openmetadata.conformance.workbenches.performance.PerformanceProfile

All Implemented Interfaces:

Serializable, Comparable<PerformanceProfile>, Constable

public enum PerformanceProfile
extends Enum<PerformanceProfile>
implements Serializable

PerformanceProfile defines the list of performance profiles for an open metadata and governance (OMAG) server platform.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASSIFICATION_SEARCH	Performance tests for the technology under test's ability to search entities based on classification.
CLASSIFICATION_UPDATE	Performance tests for the technology under test's ability to update classifications.
ENTITY_CLASSIFICATION	Performance tests for the technology under test's ability to classify entities.
ENTITY_CREATION	Performance tests for the technology under test's ability to create entities.
ENTITY_DECLASSIFY	Performance tests for the technology under test's ability to declassify entities.
ENTITY_DELETE	Performance tests for the technology under test's ability to delete entities.
ENTITY_HISTORY_RETRIEVAL	Performance tests for the technology under test's ability to retrieve entities' history by ID.
ENTITY_HISTORY_SEARCH	Performance tests for the technology under test's ability to search entities' history.
ENTITY_PURGE	Performance tests for the technology under test's ability to purge entities.
ENTITY_RE_HOME	Performance tests for the technology under test's ability to re-home entities.
ENTITY_RE_IDENTIFY	Performance tests for the technology under test's ability to re-identify entities.
ENTITY_RESTORE	Performance tests for the technology under test's ability to restore entities.
ENTITY_RETRIEVAL	Performance tests for the technology under test's ability to retrieve entities by ID.
ENTITY_RETYPE	Performance tests for the technology under test's ability to retype entities.
ENTITY_SEARCH	Performance tests for the technology under test's ability to search entities.
ENTITY_UNDO	Performance tests for the technology under test's ability to undo entity updates.
ENTITY_UPDATE	Performance tests for the technology under test's ability to update entities.
ENVIRONMENT	Information about the environment in which the performance tests were executed.
GRAPH_HISTORY_QUERIES	Performance tests for the technology under test's ability to run graph history queries.
GRAPH_QUERIES	Performance tests for the technology under test's ability to run graph queries.
RELATIONSHIP_CREATION	Performance tests for the technology under test's ability to create relationships.
RELATIONSHIP_DELETE	Performance tests for the technology under test's ability to delete relationships.
RELATIONSHIP_HISTORY_RETRIEVAL	Performance tests for the technology under test's ability to retrieve relationships' history by ID.
RELATIONSHIP_HISTORY_SEARCH	Performance tests for the technology under test's ability to search relationships' history.
RELATIONSHIP_PURGE	Performance tests for the technology under test's ability to purge relationships.
RELATIONSHIP_RE_HOME	Performance tests for the technology under test's ability to re-home relationships.
RELATIONSHIP_RE_IDENTIFY	Performance tests for the technology under test's ability to re-identify relationships.
RELATIONSHIP_RESTORE	Performance tests for the technology under test's ability to restore relationships.
RELATIONSHIP_RETRIEVAL	Performance tests for the technology under test's ability to retrieve relationships by ID.
RELATIONSHIP_RETYPE	Performance tests for the technology under test's ability to retype relationships.
RELATIONSHIP_SEARCH	Performance tests for the technology under test's ability to search relationships.
RELATIONSHIP_UNDO	Performance tests for the technology under test's ability to undo relationship updates.
RELATIONSHIP_UPDATE	Performance tests for the technology under test's ability to update relationships.

Method Summary

Modifier and Type	Method	Description
String	getProfileDescription()	Return the default description for the enum, used when there is not a natural language resource bundle available.
String	getProfileDocumentationURL()	Return the URL to link to more documentation about this profile.
Integer	getProfileId()	Return the identifier for the enum, used for indexing arrays etcetera with the enum.
String	getProfileName()	Return the name for the enum, used for message content.
OpenMetadataConformanceProfilePriority	getProfilePriority()	Return whether this profile is mandatory or optional.
String	toString()	toString() JSON-style
static PerformanceProfile	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PerformanceProfile[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENTITY_CREATION

public static final PerformanceProfile ENTITY_CREATION

Performance tests for the technology under test's ability to create entities.

ENTITY_SEARCH

public static final PerformanceProfile ENTITY_SEARCH

Performance tests for the technology under test's ability to search entities.

RELATIONSHIP_CREATION

public static final PerformanceProfile RELATIONSHIP_CREATION

Performance tests for the technology under test's ability to create relationships.

RELATIONSHIP_SEARCH

public static final PerformanceProfile RELATIONSHIP_SEARCH

Performance tests for the technology under test's ability to search relationships.

ENTITY_CLASSIFICATION

public static final PerformanceProfile ENTITY_CLASSIFICATION

Performance tests for the technology under test's ability to classify entities.

CLASSIFICATION_SEARCH

public static final PerformanceProfile CLASSIFICATION_SEARCH

Performance tests for the technology under test's ability to search entities based on classification.

ENTITY_UPDATE

public static final PerformanceProfile ENTITY_UPDATE

Performance tests for the technology under test's ability to update entities.

RELATIONSHIP_UPDATE

public static final PerformanceProfile RELATIONSHIP_UPDATE

Performance tests for the technology under test's ability to update relationships.

CLASSIFICATION_UPDATE

public static final PerformanceProfile CLASSIFICATION_UPDATE

Performance tests for the technology under test's ability to update classifications.

ENTITY_UNDO

public static final PerformanceProfile ENTITY_UNDO

Performance tests for the technology under test's ability to undo entity updates.

RELATIONSHIP_UNDO

public static final PerformanceProfile RELATIONSHIP_UNDO

Performance tests for the technology under test's ability to undo relationship updates.

ENTITY_RETRIEVAL

public static final PerformanceProfile ENTITY_RETRIEVAL

Performance tests for the technology under test's ability to retrieve entities by ID.

ENTITY_HISTORY_RETRIEVAL

public static final PerformanceProfile ENTITY_HISTORY_RETRIEVAL

Performance tests for the technology under test's ability to retrieve entities' history by ID.

RELATIONSHIP_RETRIEVAL

public static final PerformanceProfile RELATIONSHIP_RETRIEVAL

Performance tests for the technology under test's ability to retrieve relationships by ID.

RELATIONSHIP_HISTORY_RETRIEVAL

public static final PerformanceProfile RELATIONSHIP_HISTORY_RETRIEVAL

Performance tests for the technology under test's ability to retrieve relationships' history by ID.

ENTITY_HISTORY_SEARCH

public static final PerformanceProfile ENTITY_HISTORY_SEARCH

Performance tests for the technology under test's ability to search entities' history.

RELATIONSHIP_HISTORY_SEARCH

public static final PerformanceProfile RELATIONSHIP_HISTORY_SEARCH

Performance tests for the technology under test's ability to search relationships' history.

GRAPH_QUERIES

public static final PerformanceProfile GRAPH_QUERIES

Performance tests for the technology under test's ability to run graph queries.

GRAPH_HISTORY_QUERIES

public static final PerformanceProfile GRAPH_HISTORY_QUERIES

Performance tests for the technology under test's ability to run graph history queries.

ENTITY_RE_HOME

public static final PerformanceProfile ENTITY_RE_HOME

Performance tests for the technology under test's ability to re-home entities.

RELATIONSHIP_RE_HOME

public static final PerformanceProfile RELATIONSHIP_RE_HOME

Performance tests for the technology under test's ability to re-home relationships.

ENTITY_DECLASSIFY

public static final PerformanceProfile ENTITY_DECLASSIFY

Performance tests for the technology under test's ability to declassify entities.

ENTITY_RETYPE

public static final PerformanceProfile ENTITY_RETYPE

Performance tests for the technology under test's ability to retype entities.

RELATIONSHIP_RETYPE

public static final PerformanceProfile RELATIONSHIP_RETYPE

Performance tests for the technology under test's ability to retype relationships.

ENTITY_RE_IDENTIFY

public static final PerformanceProfile ENTITY_RE_IDENTIFY

Performance tests for the technology under test's ability to re-identify entities.

RELATIONSHIP_RE_IDENTIFY

public static final PerformanceProfile RELATIONSHIP_RE_IDENTIFY

Performance tests for the technology under test's ability to re-identify relationships.

RELATIONSHIP_DELETE

public static final PerformanceProfile RELATIONSHIP_DELETE

Performance tests for the technology under test's ability to delete relationships.

ENTITY_DELETE

public static final PerformanceProfile ENTITY_DELETE

Performance tests for the technology under test's ability to delete entities.

ENTITY_RESTORE

public static final PerformanceProfile ENTITY_RESTORE

Performance tests for the technology under test's ability to restore entities.

RELATIONSHIP_RESTORE

public static final PerformanceProfile RELATIONSHIP_RESTORE

Performance tests for the technology under test's ability to restore relationships.

RELATIONSHIP_PURGE

public static final PerformanceProfile RELATIONSHIP_PURGE

Performance tests for the technology under test's ability to purge relationships.

ENTITY_PURGE

public static final PerformanceProfile ENTITY_PURGE

Performance tests for the technology under test's ability to purge entities.

ENVIRONMENT

public static final PerformanceProfile ENVIRONMENT

Information about the environment in which the performance tests were executed.

Method Details

values

public static PerformanceProfile[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PerformanceProfile valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getProfileId

public Integer getProfileId()

Return the identifier for the enum, used for indexing arrays etcetera with the enum.

Returns:

int identifier

getProfileName

public String getProfileName()

Return the name for the enum, used for message content.

Returns:

String name

getProfileDescription

public String getProfileDescription()

Return the default description for the enum, used when there is not a natural language resource bundle available.

Returns:

String default description

getProfileDocumentationURL

public String getProfileDocumentationURL()

Return the URL to link to more documentation about this profile.

Returns:

url

getProfilePriority

public OpenMetadataConformanceProfilePriority getProfilePriority()

Return whether this profile is mandatory or optional.

Returns:

OpenMetadataConformanceProfilePriority enum

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<PerformanceProfile>

Returns:

string description