APIParameterListProperties (Data Manager OMAS API 3.0 API)

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
```
public class APIParameterListProperties
extends ComplexSchemaTypeProperties
```
APIParameterListProperties is a class for representing the list of parameters for an API operation's header, request or response payload.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

APIParameterListProperties()
Default constructor

APIParameterListProperties(APIParameterListProperties template)
Copy/clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	Compare the values of the supplied object with those stored in the current object.
`boolean`	`getRequired()`	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.
`String`	`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, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - APIParameterListProperties
```
public APIParameterListProperties()
```
    Default constructor
  - APIParameterListProperties
```
public APIParameterListProperties(APIParameterListProperties template)
```
    Copy/clone constructor.
    
    Parameters:
    
    template - object to copy
- Method Detail
  - 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
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class ComplexSchemaTypeProperties
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class SchemaTypeProperties
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Create a hash code for this element type.
    
    Overrides:
    
    hashCode in class SchemaTypeProperties
    
    Returns:
    
    int hash code