CodegenParameter (swagger-codegen (core library) 3.0.32 API)

java.lang.Object
- io.swagger.codegen.v3.CodegenObject
- - io.swagger.codegen.v3.CodegenParameter

All Implemented Interfaces:: VendorExtendable

public class CodegenParameter
extends CodegenObject

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`_enum`
`Map<String,Object>`	`allowableValues`
`String`	`baseName`
`String`	`baseType`
`String`	`collectionFormat`
`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
`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
`Number`	`multipleOf` See http://json-schema.org/latest/json-schema-validation.html#anchor14
`boolean`	`nullable`
`String`	`paramName`
`String`	`pattern` See http://json-schema.org/latest/json-schema-validation.html#anchor33
`boolean`	`required` Determines whether this parameter is mandatory.
`boolean`	`secondaryParam`
`String`	`testExample`
`String`	`unescapedDescription`
`boolean`	`uniqueItems` See http://json-schema.org/latest/json-schema-validation.html#anchor49

Fields inherited from class io.swagger.codegen.v3.CodegenObject
vendorExtensions

Fields inherited from interface io.swagger.codegen.v3.VendorExtendable
PREFIX_HAS, PREFIX_IS

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)`
`List<String>`	`get_enum()`
`Map<String,Object>`	`getAllowableValues()`
`String`	`getBaseName()`
`String`	`getBaseType()`
`String`	`getCollectionFormat()`
`String`	`getDataFormat()`
`String`	`getDataType()`
`String`	`getDatatypeWithEnum()`
`String`	`getDefaultValue()`
`String`	`getDescription()`
`String`	`getEnumName()`
`String`	`getExample()`
`boolean`	`getExclusiveMaximum()`
`boolean`	`getExclusiveMinimum()`
`Boolean`	`getIsBodyParam()`
`Boolean`	`getIsCookieParam()`
`Boolean`	`getIsFormParam()`
`Boolean`	`getIsHeaderParam()`
`Boolean`	`getIsPathParam()`
`Boolean`	`getIsQueryParam()`
`CodegenProperty`	`getItems()`
`String`	`getJsonSchema()`
`String`	`getMaximum()`
`Integer`	`getMaxItems()`
`Integer`	`getMaxLength()`
`String`	`getMinimum()`
`Integer`	`getMinItems()`
`Integer`	`getMinLength()`
`Number`	`getMultipleOf()`
`boolean`	`getNotFile()`
`boolean`	`getNullable()`
`String`	`getParamName()`
`String`	`getPattern()`
`boolean`	`getRequired()`
`boolean`	`getSecondaryParam()`
`String`	`getTestExample()`
`String`	`getUnescapedDescription()`
`boolean`	`getUniqueItems()`
`int`	`hashCode()`
`String`	`toString()`

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

Field Detail
- secondaryParam
```
public boolean secondaryParam
```
- baseName
```
public String baseName
```
- paramName
```
public String paramName
```
- dataType
```
public String dataType
```
- datatypeWithEnum
```
public String datatypeWithEnum
```
- dataFormat
```
public String dataFormat
```
- collectionFormat
```
public String collectionFormat
```
- description
```
public String description
```
- unescapedDescription
```
public String unescapedDescription
```
- baseType
```
public String baseType
```
- defaultValue
```
public String defaultValue
```
- enumName
```
public String enumName
```
- example
```
public String example
```
- testExample
```
public String testExample
```
- jsonSchema
```
public String jsonSchema
```
- _enum
```
public List<String> _enum
```
- allowableValues
```
public Map<String,Object> allowableValues
```
- items
```
public CodegenProperty items
```
- nullable
```
public boolean nullable
```
- 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

Constructor Detail
- CodegenParameter
```
public CodegenParameter()
```

Method Detail

getIsFormParam
```
public Boolean getIsFormParam()
```

getIsQueryParam
```
public Boolean getIsQueryParam()
```

getIsPathParam
```
public Boolean getIsPathParam()
```

getIsHeaderParam
```
public Boolean getIsHeaderParam()
```

getIsCookieParam
```
public Boolean getIsCookieParam()
```

getIsBodyParam
```
public Boolean getIsBodyParam()
```

copy
```
public CodegenParameter copy()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getSecondaryParam
```
public boolean getSecondaryParam()
```

getBaseName
```
public String getBaseName()
```

getParamName
```
public String getParamName()
```

getDataType
```
public String getDataType()
```

getDatatypeWithEnum
```
public String getDatatypeWithEnum()
```

getDataFormat
```
public String getDataFormat()
```

getCollectionFormat
```
public String getCollectionFormat()
```

getDescription
```
public String getDescription()
```

getUnescapedDescription

public String getUnescapedDescription()

getBaseType
```
public String getBaseType()
```

getDefaultValue
```
public String getDefaultValue()
```

getEnumName
```
public String getEnumName()
```

getExample
```
public String getExample()
```

getTestExample
```
public String getTestExample()
```

getJsonSchema
```
public String getJsonSchema()
```

getNotFile
```
public boolean getNotFile()
```

get_enum
```
public List<String> get_enum()
```

getAllowableValues

public Map<String,Object> getAllowableValues()

getItems
```
public CodegenProperty getItems()
```

getNullable
```
public boolean getNullable()
```

getRequired
```
public boolean getRequired()
```

getMaximum
```
public String getMaximum()
```

getExclusiveMaximum
```
public boolean getExclusiveMaximum()
```

getMinimum
```
public String getMinimum()
```

getExclusiveMinimum
```
public boolean getExclusiveMinimum()
```

getMaxLength
```
public Integer getMaxLength()
```

getMinLength
```
public Integer getMinLength()
```

getPattern
```
public String getPattern()
```

getMaxItems
```
public Integer getMaxItems()
```

getMinItems
```
public Integer getMinItems()
```

getUniqueItems
```
public boolean getUniqueItems()
```

getMultipleOf
```
public Number getMultipleOf()
```

Class CodegenParameter

Field Summary

Fields inherited from class io.swagger.codegen.v3.CodegenObject

Fields inherited from interface io.swagger.codegen.v3.VendorExtendable

Constructor Summary

Method Summary

Methods inherited from class io.swagger.codegen.v3.CodegenObject

Methods inherited from class java.lang.Object

Field Detail

secondaryParam

baseName

paramName

dataType

datatypeWithEnum

dataFormat

collectionFormat

description

unescapedDescription

baseType

defaultValue

enumName

example

testExample

jsonSchema

_enum

allowableValues

items

nullable

required

maximum

exclusiveMaximum

minimum

exclusiveMinimum

maxLength

minLength

pattern

maxItems

minItems

uniqueItems

multipleOf

Constructor Detail

CodegenParameter

Method Detail

getIsFormParam

getIsQueryParam

getIsPathParam

getIsHeaderParam

getIsCookieParam

getIsBodyParam

copy

toString

equals

hashCode

getSecondaryParam

getBaseName

getParamName

getDataType

getDatatypeWithEnum

getDataFormat

getCollectionFormat

getDescription

getUnescapedDescription

getBaseType

getDefaultValue

getEnumName

getExample

getTestExample

getJsonSchema

getNotFile

get_enum

getAllowableValues

getItems

getNullable

getRequired

getMaximum

getExclusiveMaximum

getMinimum

getExclusiveMinimum

getMaxLength

getMinLength