Package org.odpi.openmetadata.frameworks.connectors.controls

Enum Class SecretsStoreConfigurationProperty

java.lang.Object

java.lang.Enum<SecretsStoreConfigurationProperty>

org.odpi.openmetadata.frameworks.connectors.controls.SecretsStoreConfigurationProperty

All Implemented Interfaces:

Serializable, Comparable<SecretsStoreConfigurationProperty>, Constable

public enum SecretsStoreConfigurationProperty
extends Enum<SecretsStoreConfigurationProperty>

SecretsStoreConfigurationProperty provides definitions for the configuration properties used with the secrets store 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_COLLECTION_NAME	The name used to identify the collection of properties that a particular connector is using.

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()	Retrieve all the defined configuration properties
static List<ConfigurationPropertyType>	getStaticSecretStoreConfigurationPropertyTypes()	Get recognizedConfigurationProperties for the PostgreSQLServer Integration connector.
static List<String>	getStaticSecretStoreRecognizedConfProperties()	Get recognizedConfigurationProperties for the static secret store connectors.
boolean	isPlaceholder()	Return whether this value is also used as a placeholder property.
String	toString()	Output of this enum class and main value.
static SecretsStoreConfigurationProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecretsStoreConfigurationProperty[]	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

SECRETS_COLLECTION_NAME

public static final SecretsStoreConfigurationProperty SECRETS_COLLECTION_NAME

The name used to identify the collection of properties that a particular connector is using.

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 SecretsStoreConfigurationProperty[] 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 SecretsStoreConfigurationProperty 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

getStaticSecretStoreRecognizedConfProperties

public static List<String> getStaticSecretStoreRecognizedConfProperties()

Get recognizedConfigurationProperties for the static secret store connectors.

Returns:

list of property names

getStaticSecretStoreConfigurationPropertyTypes

public static List<ConfigurationPropertyType> getStaticSecretStoreConfigurationPropertyTypes()

Get recognizedConfigurationProperties for the PostgreSQLServer Integration connector.

Returns:

list of property names

getRecognizedConfigurationProperties

public static List<String> getRecognizedConfigurationProperties()

Retrieve all the defined configuration properties

Returns:

list of configuration property types

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<SecretsStoreConfigurationProperty>

Returns:

string showing enum value