CodegenParameter (openapi-generator (core library) 5.0.1 API)

java.lang.Object
- org.openapitools.codegen.CodegenParameter

All Implemented Interfaces:

IJsonSchemaValidationProperties
```
public class CodegenParameter
extends Object
implements IJsonSchemaValidationProperties
```
Describes a single operation parameter in the OAS specification. A unique parameter is defined by a combination of a name and location. Parameters may be located in a path, query, header or cookie.

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`_enum`
`CodegenProperty`	`additionalProperties`
`Map<String,Object>`	`allowableValues`
`String`	`baseName`
`String`	`baseType`
`String`	`collectionFormat`
`String`	`contentType`
`String`	`dataFormat`
`String`	`dataType`
`String`	`datatypeWithEnum`
`String`	`defaultValue`
`String`	`description`
`String`	`enumName`
`String`	`example`
`boolean`	`exclusiveMaximum` See http://json-schema.org/latest/json-schema-validation.html#anchor17
`boolean`	`exclusiveMinimum` See http://json-schema.org/latest/json-schema-validation.html#anchor21
`boolean`	`hasValidation`
`boolean`	`isAnyType`
`boolean`	`isArray`
`boolean`	`isBinary`
`boolean`	`isBodyParam`
`boolean`	`isBoolean`
`boolean`	`isByteArray`
`boolean`	`isCollectionFormatMulti`
`boolean`	`isContainer`
`boolean`	`isCookieParam`
`boolean`	`isDate`
`boolean`	`isDateTime`
`boolean`	`isDecimal`
`boolean`	`isDouble`
`boolean`	`isEmail`
`boolean`	`isEnum`
`boolean`	`isExplode`
`boolean`	`isFile`
`boolean`	`isFloat`
`boolean`	`isFormParam`
`boolean`	`isFreeFormObject`
`boolean`	`isHeaderParam`
`boolean`	`isInteger`
`boolean`	`isLong`
`boolean`	`isMap`
`boolean`	`isModel`
`boolean`	`isNull`
`boolean`	`isNullable`
`boolean`	`isNumber`
`boolean`	`isNumeric`
`boolean`	`isPathParam`
`boolean`	`isPrimitiveType`
`boolean`	`isQueryParam`
`boolean`	`isString`
`boolean`	`isUri`
`boolean`	`isUuid`
`CodegenProperty`	`items`
`String`	`jsonSchema`
`String`	`maximum` See http://json-schema.org/latest/json-schema-validation.html#anchor17.
`Integer`	`maxItems` See http://json-schema.org/latest/json-schema-validation.html#anchor42
`Integer`	`maxLength` See http://json-schema.org/latest/json-schema-validation.html#anchor26
`String`	`minimum` See http://json-schema.org/latest/json-schema-validation.html#anchor21
`Integer`	`minItems` See http://json-schema.org/latest/json-schema-validation.html#anchor45
`Integer`	`minLength` See http://json-schema.org/latest/json-schema-validation.html#anchor29
`CodegenProperty`	`mostInnerItems`
`Number`	`multipleOf` See http://json-schema.org/latest/json-schema-validation.html#anchor14
`String`	`nameInLowerCase`
`String`	`paramName`
`String`	`pattern` See http://json-schema.org/latest/json-schema-validation.html#anchor33
`boolean`	`required` Determines whether this parameter is mandatory.
`List<CodegenProperty>`	`requiredVars`
`String`	`style`
`String`	`unescapedDescription`
`boolean`	`uniqueItems` See http://json-schema.org/latest/json-schema-validation.html#anchor49
`List<CodegenProperty>`	`vars`
`Map<String,Object>`	`vendorExtensions`

Constructor Summary

Constructors
Constructor and Description

CodegenParameter()

Constructors
Constructor and Description
`CodegenParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodegenParameter`	`copy()`
`boolean`	`equals(Object o)`
`CodegenProperty`	`getAdditionalProperties()`
`boolean`	`getExclusiveMaximum()`
`boolean`	`getExclusiveMinimum()`
`boolean`	`getHasValidation()`
`boolean`	`getIsArray()`
`boolean`	`getIsDate()`
`boolean`	`getIsDateTime()`
`boolean`	`getIsMap()`
`boolean`	`getIsModel()`
`boolean`	`getIsNull()`
`CodegenProperty`	`getItems()`
`String`	`getMaximum()`
`Integer`	`getMaxItems()`
`Integer`	`getMaxLength()`
`Integer`	`getMaxProperties()`
`String`	`getMinimum()`
`Integer`	`getMinItems()`
`Integer`	`getMinLength()`
`Integer`	`getMinProperties()`
`Number`	`getMultipleOf()`
`String`	`getPattern()`
`List<CodegenProperty>`	`getRequiredVars()`
`boolean`	`getUniqueItems()`
`List<CodegenProperty>`	`getVars()`
`int`	`hashCode()`
`void`	`setAdditionalProperties(CodegenProperty additionalProperties)`
`void`	`setExclusiveMaximum(boolean exclusiveMaximum)`
`void`	`setExclusiveMinimum(boolean exclusiveMinimum)`
`void`	`setHasValidation(boolean hasValidation)`
`void`	`setIsArray(boolean isArray)`
`void`	`setIsDate(boolean isDate)`
`void`	`setIsDateTime(boolean isDateTime)`
`void`	`setIsMap(boolean isMap)`
`void`	`setIsModel(boolean isModel)`
`void`	`setIsNull(boolean isNull)`
`void`	`setItems(CodegenProperty items)`
`void`	`setMaximum(String maximum)`
`void`	`setMaxItems(Integer maxItems)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMaxProperties(Integer maxProperties)`
`void`	`setMinimum(String minimum)`
`void`	`setMinItems(Integer minItems)`
`void`	`setMinLength(Integer minLength)`
`void`	`setMinProperties(Integer minProperties)`
`void`	`setMultipleOf(Number multipleOf)`
`void`	`setPattern(String pattern)`
`void`	`setRequiredVars(List<CodegenProperty> requiredVars)`
`void`	`setUniqueItems(boolean uniqueItems)`
`void`	`setVars(List<CodegenProperty> vars)`
`String`	`toString()`

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

- Field Detail
  - isFormParam
```
public boolean isFormParam
```
  - isQueryParam
```
public boolean isQueryParam
```
  - isPathParam
```
public boolean isPathParam
```
  - isHeaderParam
```
public boolean isHeaderParam
```
  - isCookieParam
```
public boolean isCookieParam
```
  - isBodyParam
```
public boolean isBodyParam
```
  - isContainer
```
public boolean isContainer
```
  - isCollectionFormatMulti
```
public boolean isCollectionFormatMulti
```
  - isPrimitiveType
```
public boolean isPrimitiveType
```
  - isModel
```
public boolean isModel
```
  - isExplode
```
public boolean isExplode
```
  - baseName
```
public String baseName
```
  - paramName
```
public String paramName
```
  - dataType
```
public String dataType
```
  - datatypeWithEnum
```
public String datatypeWithEnum
```
  - dataFormat
```
public String dataFormat
```
  - contentType
```
public String contentType
```
  - collectionFormat
```
public String collectionFormat
```
  - description
```
public String description
```
  - unescapedDescription
```
public String unescapedDescription
```
  - baseType
```
public String baseType
```
  - defaultValue
```
public String defaultValue
```
  - enumName
```
public String enumName
```
  - style
```
public String style
```
  - nameInLowerCase
```
public String nameInLowerCase
```
  - example
```
public String example
```
  - jsonSchema
```
public String jsonSchema
```
  - isString
```
public boolean isString
```
  - isNumeric
```
public boolean isNumeric
```
  - isInteger
```
public boolean isInteger
```
  - isLong
```
public boolean isLong
```
  - isNumber
```
public boolean isNumber
```
  - isFloat
```
public boolean isFloat
```
  - isDouble
```
public boolean isDouble
```
  - isDecimal
```
public boolean isDecimal
```
  - isByteArray
```
public boolean isByteArray
```
  - isBinary
```
public boolean isBinary
```
  - isBoolean
```
public boolean isBoolean
```
  - isDate
```
public boolean isDate
```
  - isDateTime
```
public boolean isDateTime
```
  - isUuid
```
public boolean isUuid
```
  - isUri
```
public boolean isUri
```
  - isEmail
```
public boolean isEmail
```
  - isFreeFormObject
```
public boolean isFreeFormObject
```
  - isAnyType
```
public boolean isAnyType
```
  - isArray
```
public boolean isArray
```
  - isMap
```
public boolean isMap
```
  - isFile
```
public boolean isFile
```
  - isEnum
```
public boolean isEnum
```
  - _enum
```
public List<String> _enum
```
  - allowableValues
```
public Map<String,Object> allowableValues
```
  - items
```
public CodegenProperty items
```
  - additionalProperties
```
public CodegenProperty additionalProperties
```
  - vars
```
public List<CodegenProperty> vars
```
  - requiredVars
```
public List<CodegenProperty> requiredVars
```
  - mostInnerItems
```
public CodegenProperty mostInnerItems
```
  - vendorExtensions
```
public Map<String,Object> vendorExtensions
```
  - hasValidation
```
public boolean hasValidation
```
  - isNullable
```
public boolean isNullable
```
  - required
```
public boolean required
```
    Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
  - maximum
```
public String maximum
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor17.
  - exclusiveMaximum
```
public boolean exclusiveMaximum
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor17
  - minimum
```
public String minimum
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor21
  - exclusiveMinimum
```
public boolean exclusiveMinimum
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor21
  - maxLength
```
public Integer maxLength
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor26
  - minLength
```
public Integer minLength
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor29
  - pattern
```
public String pattern
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor33
  - maxItems
```
public Integer maxItems
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor42
  - minItems
```
public Integer minItems
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor45
  - uniqueItems
```
public boolean uniqueItems
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor49
  - multipleOf
```
public Number multipleOf
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor14
  - isNull
```
public boolean isNull
```
- Constructor Detail
  - CodegenParameter
```
public CodegenParameter()
```
- Method Detail
  - copy
```
public CodegenParameter copy()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPattern
```
public String getPattern()
```
    Specified by:
    
    getPattern in interface IJsonSchemaValidationProperties
  - setPattern
```
public void setPattern(String pattern)
```
    Specified by:
    
    setPattern in interface IJsonSchemaValidationProperties
  - getMaximum
```
public String getMaximum()
```
    Specified by:
    
    getMaximum in interface IJsonSchemaValidationProperties
  - setMaximum
```
public void setMaximum(String maximum)
```
    Specified by:
    
    setMaximum in interface IJsonSchemaValidationProperties
  - getMinimum
```
public String getMinimum()
```
    Specified by:
    
    getMinimum in interface IJsonSchemaValidationProperties
  - setMinimum
```
public void setMinimum(String minimum)
```
    Specified by:
    
    setMinimum in interface IJsonSchemaValidationProperties
  - getExclusiveMaximum
```
public boolean getExclusiveMaximum()
```
    Specified by:
    
    getExclusiveMaximum in interface IJsonSchemaValidationProperties
  - setExclusiveMaximum
```
public void setExclusiveMaximum(boolean exclusiveMaximum)
```
    Specified by:
    
    setExclusiveMaximum in interface IJsonSchemaValidationProperties
  - getExclusiveMinimum
```
public boolean getExclusiveMinimum()
```
    Specified by:
    
    getExclusiveMinimum in interface IJsonSchemaValidationProperties
  - setExclusiveMinimum
```
public void setExclusiveMinimum(boolean exclusiveMinimum)
```
    Specified by:
    
    setExclusiveMinimum in interface IJsonSchemaValidationProperties
  - getMinLength
```
public Integer getMinLength()
```
    Specified by:
    
    getMinLength in interface IJsonSchemaValidationProperties
  - setMinLength
```
public void setMinLength(Integer minLength)
```
    Specified by:
    
    setMinLength in interface IJsonSchemaValidationProperties
  - getMaxLength
```
public Integer getMaxLength()
```
    Specified by:
    
    getMaxLength in interface IJsonSchemaValidationProperties
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
    Specified by:
    
    setMaxLength in interface IJsonSchemaValidationProperties
  - getMinItems
```
public Integer getMinItems()
```
    Specified by:
    
    getMinItems in interface IJsonSchemaValidationProperties
  - setMinItems
```
public void setMinItems(Integer minItems)
```
    Specified by:
    
    setMinItems in interface IJsonSchemaValidationProperties
  - getMaxItems
```
public Integer getMaxItems()
```
    Specified by:
    
    getMaxItems in interface IJsonSchemaValidationProperties
  - setMaxItems
```
public void setMaxItems(Integer maxItems)
```
    Specified by:
    
    setMaxItems in interface IJsonSchemaValidationProperties
  - getUniqueItems
```
public boolean getUniqueItems()
```
    Specified by:
    
    getUniqueItems in interface IJsonSchemaValidationProperties
  - setUniqueItems
```
public void setUniqueItems(boolean uniqueItems)
```
    Specified by:
    
    setUniqueItems in interface IJsonSchemaValidationProperties
  - getMinProperties
```
public Integer getMinProperties()
```
    Specified by:
    
    getMinProperties in interface IJsonSchemaValidationProperties
  - setMinProperties
```
public void setMinProperties(Integer minProperties)
```
    Specified by:
    
    setMinProperties in interface IJsonSchemaValidationProperties
  - getMaxProperties
```
public Integer getMaxProperties()
```
    Specified by:
    
    getMaxProperties in interface IJsonSchemaValidationProperties
  - setMaxProperties
```
public void setMaxProperties(Integer maxProperties)
```
    Specified by:
    
    setMaxProperties in interface IJsonSchemaValidationProperties
  - getMultipleOf
```
public Number getMultipleOf()
```
    Specified by:
    
    getMultipleOf in interface IJsonSchemaValidationProperties
  - setMultipleOf
```
public void setMultipleOf(Number multipleOf)
```
    Specified by:
    
    setMultipleOf in interface IJsonSchemaValidationProperties
  - getItems
```
public CodegenProperty getItems()
```
    Specified by:
    
    getItems in interface IJsonSchemaValidationProperties
  - setItems
```
public void setItems(CodegenProperty items)
```
    Specified by:
    
    setItems in interface IJsonSchemaValidationProperties
  - getIsModel
```
public boolean getIsModel()
```
    Specified by:
    
    getIsModel in interface IJsonSchemaValidationProperties
  - setIsModel
```
public void setIsModel(boolean isModel)
```
    Specified by:
    
    setIsModel in interface IJsonSchemaValidationProperties
  - getIsDate
```
public boolean getIsDate()
```
    Specified by:
    
    getIsDate in interface IJsonSchemaValidationProperties
  - setIsDate
```
public void setIsDate(boolean isDate)
```
    Specified by:
    
    setIsDate in interface IJsonSchemaValidationProperties
  - getIsDateTime
```
public boolean getIsDateTime()
```
    Specified by:
    
    getIsDateTime in interface IJsonSchemaValidationProperties
  - setIsDateTime
```
public void setIsDateTime(boolean isDateTime)
```
    Specified by:
    
    setIsDateTime in interface IJsonSchemaValidationProperties
  - getIsMap
```
public boolean getIsMap()
```
    Specified by:
    
    getIsMap in interface IJsonSchemaValidationProperties
  - setIsMap
```
public void setIsMap(boolean isMap)
```
    Specified by:
    
    setIsMap in interface IJsonSchemaValidationProperties
  - getIsArray
```
public boolean getIsArray()
```
    Specified by:
    
    getIsArray in interface IJsonSchemaValidationProperties
  - setIsArray
```
public void setIsArray(boolean isArray)
```
    Specified by:
    
    setIsArray in interface IJsonSchemaValidationProperties
  - getAdditionalProperties
```
public CodegenProperty getAdditionalProperties()
```
    Specified by:
    
    getAdditionalProperties in interface IJsonSchemaValidationProperties
  - setAdditionalProperties
```
public void setAdditionalProperties(CodegenProperty additionalProperties)
```
    Specified by:
    
    setAdditionalProperties in interface IJsonSchemaValidationProperties
  - getVars
```
public List<CodegenProperty> getVars()
```
    Specified by:
    
    getVars in interface IJsonSchemaValidationProperties
  - setVars
```
public void setVars(List<CodegenProperty> vars)
```
    Specified by:
    
    setVars in interface IJsonSchemaValidationProperties
  - getRequiredVars
```
public List<CodegenProperty> getRequiredVars()
```
    Specified by:
    
    getRequiredVars in interface IJsonSchemaValidationProperties
  - setRequiredVars
```
public void setRequiredVars(List<CodegenProperty> requiredVars)
```
    Specified by:
    
    setRequiredVars in interface IJsonSchemaValidationProperties
  - getIsNull
```
public boolean getIsNull()
```
    Specified by:
    
    getIsNull in interface IJsonSchemaValidationProperties
  - setIsNull
```
public void setIsNull(boolean isNull)
```
    Specified by:
    
    setIsNull in interface IJsonSchemaValidationProperties
  - getHasValidation
```
public boolean getHasValidation()
```
    Specified by:
    
    getHasValidation in interface IJsonSchemaValidationProperties
  - setHasValidation
```
public void setHasValidation(boolean hasValidation)
```
    Specified by:
    
    setHasValidation in interface IJsonSchemaValidationProperties

Class CodegenParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isFormParam

isQueryParam

isPathParam

isHeaderParam

isCookieParam

isBodyParam

isContainer

isCollectionFormatMulti

isPrimitiveType

isModel

isExplode

baseName

paramName

dataType

datatypeWithEnum

dataFormat

contentType

collectionFormat

description

unescapedDescription

baseType

defaultValue

enumName

style

nameInLowerCase

example

jsonSchema

isString

isNumeric

isInteger

isLong

isNumber

isFloat

isDouble

isDecimal

isByteArray

isBinary

isBoolean

isDate

isDateTime

isUuid

isUri

isEmail

isFreeFormObject

isAnyType

isArray

isMap

isFile

isEnum

_enum

allowableValues

items

additionalProperties

vars

requiredVars

mostInnerItems

vendorExtensions

hasValidation

isNullable

required

maximum

exclusiveMaximum

minimum

exclusiveMinimum

maxLength

minLength

pattern

maxItems

minItems

uniqueItems

multipleOf

isNull

Constructor Detail

CodegenParameter