Enum Class OMAGServerPlatformPlaceholderProperty
java.lang.Object
java.lang.Enum<OMAGServerPlatformPlaceholderProperty>
org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.control.OMAGServerPlatformPlaceholderProperty
- All Implemented Interfaces:
Serializable
,Comparable<OMAGServerPlatformPlaceholderProperty>
,Constable
public enum OMAGServerPlatformPlaceholderProperty
extends Enum<OMAGServerPlatformPlaceholderProperty>
PlaceholderProperty provides some standard definitions for placeholder properties used to pass properties
to services that use templates.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe userId to store in the userId attribute of the connection.The host IP address or domain name.The description of the server being catalogued.The name of the server being catalogued.The number of the port to use to connect to a service. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturn the data type for the placeholder property.Return the description of the placeholder property.Return an example of the placeholder property to help users understand how to set it up.getName()
Return the name of the placeholder property.Return the placeholder to use when building templates.static List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesReturn a summary of this enum to use in a service provider.toString()
Output of this enum class and main value.Returns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
HOST_URL
The host IP address or domain name. -
PORT_NUMBER
The number of the port to use to connect to a service. -
CONNECTION_USER_ID
The userId to store in the userId attribute of the connection. -
PLATFORM_NAME
The name of the server being catalogued. -
PLATFORM_DESCRIPTION
The description of the server being catalogued.
-
-
Field Details
-
name
-
description
-
dataType
-
example
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getName
Return the name of the placeholder property.- Returns:
- string name
-
getPlaceholder
Return the placeholder to use when building templates.- Returns:
- placeholder property
-
getDescription
Return the description of the placeholder property.- Returns:
- text
-
getDataType
Return the data type for the placeholder property.- Returns:
- data type name
-
getExample
Return an example of the placeholder property to help users understand how to set it up.- Returns:
- example
-
getPlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getPlaceholderType
Return a summary of this enum to use in a service provider.- Returns:
- placeholder property type
-
toString
Output of this enum class and main value.- Overrides:
toString
in classEnum<OMAGServerPlatformPlaceholderProperty>
- Returns:
- string showing enum value
-