Package org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.control

Enum Class OMAGServerPlatformConfigurationProperty

java.lang.Object

java.lang.Enum<OMAGServerPlatformConfigurationProperty>

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.control.OMAGServerPlatformConfigurationProperty

All Implemented Interfaces:

Serializable, Comparable<OMAGServerPlatformConfigurationProperty>, Constable

public enum OMAGServerPlatformConfigurationProperty
extends Enum<OMAGServerPlatformConfigurationProperty>

OMAGServerPlatformConfigurationProperty defines the configuration properties used with the OMAG Server Platform connectors.

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
SECRETS_STORE	Location of the secrets store.
SERVER_NAME	Unique identifier of a server running on the platform.

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	description
final String	example
final boolean	isPlaceholder
final String	name

Method Summary

Modifier and Type	Method	Description
ConfigurationPropertyType	getConfigurationPropertyType()	Return a summary of this enum to use in a connector provider.
static List<ConfigurationPropertyType>	getConfigurationPropertyTypes()	Retrieve all the defined configuration properties
String	getDataType()	Return the data type for the configuration property.
String	getDescription()	Return the description of the configuration property.
String	getExample()	Return an example of the configuration property to help users understand how to set it up.
String	getName()	Return the name of the request parameter.
static List<String>	getRecognizedConfigurationProperties()	Get recognizedConfigurationProperties for the connector.
boolean	isPlaceholder()	Return whether this value is also used as a placeholder property.
String	toString()	Output of this enum class and main value.
static OMAGServerPlatformConfigurationProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMAGServerPlatformConfigurationProperty[]	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

SERVER_NAME

public static final OMAGServerPlatformConfigurationProperty SERVER_NAME

Unique identifier of a server running on the platform.

SECRETS_STORE

public static final OMAGServerPlatformConfigurationProperty SECRETS_STORE

Location of the secrets store.

Field Details

name

public final String name

description

public final String description

dataType

public final String dataType

example

public final String example

isPlaceholder

public final boolean isPlaceholder

Method Details

values

public static OMAGServerPlatformConfigurationProperty[] 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 OMAGServerPlatformConfigurationProperty 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

getName

public String getName()

Return the name of the request parameter.

Returns:

string name

getDescription

public String getDescription()

Return the description of the configuration property.

Returns:

text

getDataType

public String getDataType()

Return the data type for the configuration property.

Returns:

data type name

getExample

public String getExample()

Return an example of the configuration property to help users understand how to set it up.

Returns:

example

isPlaceholder

public boolean isPlaceholder()

Return whether this value is also used as a placeholder property.

Returns:

boolean

getRecognizedConfigurationProperties

public static List<String> getRecognizedConfigurationProperties()

Get recognizedConfigurationProperties for the connector.

Returns:

list of property names

getConfigurationPropertyTypes

public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()

Retrieve all the defined configuration properties

Returns:

list of configuration property types

getConfigurationPropertyType

public ConfigurationPropertyType getConfigurationPropertyType()

Return a summary of this enum to use in a connector provider.

Returns:

request parameter type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<OMAGServerPlatformConfigurationProperty>

Returns:

string showing enum value