Enum Class APIParameterListType
java.lang.Object
java.lang.Enum<APIParameterListType>
org.odpi.openmetadata.accessservices.datamanager.properties.APIParameterListType
- All Implemented Interfaces:
Serializable
,Comparable<APIParameterListType>
,Constable
An APIParameterListType defines which parameter list relationship to use when attaching an APIParameterList to an operation.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturn the default description for the key pattern for this enum instance.getName()
Return the default name for this enum instance.Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.int
Return the code for this enum instancetoString()
Standard toString method.static APIParameterListType
Returns the enum constant of this class with the specified name.static APIParameterListType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
HEADER
-
REQUEST
-
RESPONSE
-
-
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
-
getOrdinal
public int getOrdinal()Return the code for this enum instance- Returns:
- int key pattern code
-
getName
Return the default name for this enum instance.- Returns:
- String default name
-
getDescription
Return the default description for the key pattern for this enum instance.- Returns:
- String default description
-
getOpenTypeRelationshipName
Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.- Returns:
- strinng type name
-
toString
Standard toString method.- Overrides:
toString
in classEnum<APIParameterListType>
- Returns:
- print out of variables in a JSON-style
-