Class APIParameterProperties
java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties
org.odpi.openmetadata.accessservices.datamanager.properties.APIParameterProperties
- All Implemented Interfaces:
Serializable
APIParameterProperties is a class for representing a parameter in an API specification.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorAPIParameterProperties
(APIParameterProperties template) Copy/clone constructor.Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?int
hashCode()
Create a hash code for this element type.void
setParameterType
(String parameterType) Set up the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties
getAliases, getAllowsDuplicateValues, getDataType, getDefaultValue, getDefaultValueOverride, getElementPosition, getExternalTypeGUID, getFixedValue, getIsNullable, getLength, getMaxCardinality, getMinCardinality, getMinimumLength, getNativeJavaClass, getOrderedValues, getPrecision, getSortOrder, getValidValuesSetGUID, setAliases, setAllowsDuplicateValues, setDataType, setDefaultValue, setDefaultValueOverride, setElementPosition, setExternalTypeGUID, setFixedValue, setIsNullable, setLength, setMaxCardinality, setMinCardinality, setMinimumLength, setNativeJavaClass, setOrderedValues, setPrecision, setSortOrder, setValidValuesSetGUID
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
Constructor Details
-
APIParameterProperties
public APIParameterProperties()Default constructor -
APIParameterProperties
Copy/clone constructor.- Parameters:
template
- object to copy
-
APIParameterProperties
Copy/clone constructor.- Parameters:
template
- object to copy
-
-
Method Details
-
getParameterType
Return the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?- Returns:
- string name
-
setParameterType
Set up the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?- Parameters:
parameterType
- string name
-
toString
Standard toString method.- Overrides:
toString
in classSchemaAttributeProperties
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classSchemaAttributeProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classSchemaAttributeProperties
- Returns:
- int hash code
-