Class APIParameterListProperties
java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
org.odpi.openmetadata.accessservices.datamanager.properties.SchemaTypeProperties
org.odpi.openmetadata.accessservices.datamanager.properties.ComplexSchemaTypeProperties
org.odpi.openmetadata.accessservices.datamanager.properties.APIParameterListProperties
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
APIParameterListRequestBody
APIParameterListProperties is a class for representing the list of parameters for an API
operation's header, request or response payload.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.boolean
Return if this is a mandatory parameter.int
hashCode()
Create a hash code for this element type.void
setRequired
(boolean required) Set up if this is a mandatory parameter.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaTypeProperties
getAuthor, getEncodingStandard, getNamespace, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setNamespace, setUsage, setVersionNumber
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
-
APIParameterListProperties
public APIParameterListProperties()Default constructor -
APIParameterListProperties
Copy/clone constructor.- Parameters:
template
- object to copy
-
-
Method Details
-
getRequired
public boolean getRequired()Return if this is a mandatory parameter.- Returns:
- boolean flag
-
setRequired
public void setRequired(boolean required) Set up if this is a mandatory parameter.- Parameters:
required
- boolean flag
-
toString
Standard toString method.- Overrides:
toString
in classComplexSchemaTypeProperties
- 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 classSchemaTypeProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classSchemaTypeProperties
- Returns:
- int hash code
-