Package io.swagger.codegen.v3
Class CodegenParameter
- 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 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#anchor17boolean
exclusiveMinimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21boolean
isJson
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#anchor42Integer
maxLength
See http://json-schema.org/latest/json-schema-validation.html#anchor26String
minimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21Integer
minItems
See http://json-schema.org/latest/json-schema-validation.html#anchor45Integer
minLength
See http://json-schema.org/latest/json-schema-validation.html#anchor29Number
multipleOf
See http://json-schema.org/latest/json-schema-validation.html#anchor14boolean
nullable
String
paramName
String
pattern
See http://json-schema.org/latest/json-schema-validation.html#anchor33boolean
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 Description CodegenParameter()
-
Method Summary
-
Methods inherited from class io.swagger.codegen.v3.CodegenObject
getBooleanValue, getHasHeaders, getHasInnerObject, getHasMore, getIsAlias, getIsArrayModel, getIsBinary, getIsBoolean, getIsByteArray, getIsCollectionFormatMulti, getIsContainer, getIsDate, getIsDateTime, getIsDefault, getIsDouble, getIsEnum, getIsFile, getIsFloat, getIsInteger, getIsListContainer, getIsLong, getIsMapContainer, getIsMultipart, getIsNotContainer, getIsNullable, getIsNumber, getIsNumeric, getIsObject, getIsPrimitiveType, getIsReadOnly, getIsResponseBinary, getIsResponseFile, getIsString, getIsUuid, getVendorExtensions, setVendorExtensions
-
-
-
-
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
-
items
public CodegenProperty items
-
nullable
public boolean nullable
-
isJson
public boolean isJson
-
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
-
-
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()
-
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()
-
getItems
public CodegenProperty getItems()
-
getNullable
public boolean getNullable()
-
getIsJson
public boolean getIsJson()
-
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()
-
-