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

public class CodegenOperation
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`List<CodegenParameter>`	`allParams`
`List<CodegenSecurity>`	`authMethods`
`String`	`baseName`
`CodegenParameter`	`bodyParam`
`List<CodegenParameter>`	`bodyParams`
`List<CodegenCallback>`	`callbacks`
`List<Map<String,String>>`	`consumes`
`List<CodegenParameter>`	`cookieParams`
`String`	`defaultResponse`
`boolean`	`defaultReturnType`
`CodegenDiscriminator`	`discriminator`
`List<Map<String,String>>`	`examples`
`io.swagger.v3.oas.models.ExternalDocumentation`	`externalDocs`
`List<CodegenParameter>`	`formParams`
`boolean`	`hasAuthMethods`
`boolean`	`hasConsumes`
`boolean`	`hasDefaultResponse`
`boolean`	`hasErrorResponseObject`
`boolean`	`hasOptionalParams`
`boolean`	`hasParams`
`boolean`	`hasProduces`
`boolean`	`hasReference`
`boolean`	`hasRequiredParams`
`boolean`	`hasVersionHeaders`
`boolean`	`hasVersionQueryParams`
`List<CodegenParameter>`	`headerParams`
`String`	`httpMethod`
`List<CodegenParameter>`	`implicitHeadersParams`
`Set<String>`	`imports`
`boolean`	`isArray`
`boolean`	`isCallbackRequest`
`boolean`	`isDeprecated`
`boolean`	`isMap`
`boolean`	`isMultipart`
`boolean`	`isResponseBinary`
`boolean`	`isResponseFile`
`boolean`	`isResponseOptional`
`boolean`	`isRestful`
`boolean`	`isRestfulCreate`
`boolean`	`isRestfulDestroy`
`boolean`	`isRestfulIndex`
`boolean`	`isRestfulShow`
`boolean`	`isRestfulUpdate`
`boolean`	`isVoid`
`String`	`nickname`
`String`	`notes`
`List<CodegenParameter>`	`notNullableParams`
`String`	`operationId`
`String`	`operationIdCamelCase`
`String`	`operationIdLowerCase`
`String`	`operationIdOriginal`
`String`	`operationIdSnakeCase`
`List<CodegenParameter>`	`optionalParams`
`String`	`path`
`List<CodegenParameter>`	`pathParams`
`List<Map<String,String>>`	`prioritizedContentTypes`
`List<Map<String,String>>`	`produces`
`List<CodegenParameter>`	`queryParams`
`List<Map<String,String>>`	`requestBodyExamples`
`List<CodegenParameter>`	`requiredAndNotNullableParams`
`List<CodegenParameter>`	`requiredParams`
`List<CodegenProperty>`	`responseHeaders`
`List<CodegenResponse>`	`responses`
`String`	`returnBaseType`
`String`	`returnContainer`
`String`	`returnFormat`
`CodegenProperty`	`returnProperty`
`boolean`	`returnSimpleType`
`String`	`returnType`
`boolean`	`returnTypeIsPrimitive`
`List<CodegenServer>`	`servers`
`boolean`	`subresourceOperation`
`String`	`summary`
`List<io.swagger.v3.oas.models.tags.Tag>`	`tags`
`String`	`unescapedNotes`
`boolean`	`uniqueItems`
`Map<String,Object>`	`vendorExtensions`

Constructor Summary

Constructors
Constructor Description

CodegenOperation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,CodegenOperation>`	`contentTypeToOperation()`
`boolean`	`equals(Object o)`
`boolean`	`getAllResponsesAreErrors()`
`boolean`	`getHasBodyOrFormParams()`	Check if there's at least one body parameter or at least one form parameter
`boolean`	`getHasBodyParam()`	Check if there's at least one body parameter
`boolean`	`getHasCookieParams()`	Check if there's at least one form parameter
`boolean`	`getHasDefaultResponse()`	Check if there's a default response
`boolean`	`getHasExamples()`	Check if there's at least one example parameter
`boolean`	`getHasFormParams()`	Check if there's at least one form parameter
`boolean`	`getHasHeaderParams()`	Check if there's at least one header parameter
`boolean`	`getHasNotNullableParams()`
`boolean`	`getHasOptionalParams()`	Check if there's at least one optional parameter
`boolean`	`getHasPathParams()`	Check if there's at least one path parameter
`boolean`	`getHasQueryParams()`	Check if there's at least one query parameter
`boolean`	`getHasQueryParamsOrAuth()`	Check if there's at least one query parameter or passing API keys in query
`boolean`	`getHasRequiredAndNotNullableParams()`
`boolean`	`getHasRequiredParams()`	Check if there's at least one required parameter
`boolean`	`getHasResponseHeaders()`	Check if there's at least one response header
`boolean`	`getHasVendorExtensions()`	Check if there's at least one vendor extension
`int`	`hashCode()`
`boolean`	`isBodyAllowed()`	Check if body param is allowed for the request method
`boolean`	`isRestful()`	Check if Restful-style
`boolean`	`isRestfulCreate()`	Check if act as Restful create method
`boolean`	`isRestfulDestroy()`	Check if act as Restful destroy method
`boolean`	`isRestfulIndex()`	Check if act as Restful index method
`boolean`	`isRestfulShow()`	Check if act as Restful show method
`boolean`	`isRestfulUpdate()`	Check if act as Restful update method
`String`	`toString()`

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

- Field Detail
  - responseHeaders
```
public final List<CodegenProperty> responseHeaders
```
  - hasAuthMethods
```
public boolean hasAuthMethods
```
  - hasConsumes
```
public boolean hasConsumes
```
  - hasProduces
```
public boolean hasProduces
```
  - hasParams
```
public boolean hasParams
```
  - hasOptionalParams
```
public boolean hasOptionalParams
```
  - hasRequiredParams
```
public boolean hasRequiredParams
```
  - returnTypeIsPrimitive
```
public boolean returnTypeIsPrimitive
```
  - returnSimpleType
```
public boolean returnSimpleType
```
  - subresourceOperation
```
public boolean subresourceOperation
```
  - isMap
```
public boolean isMap
```
  - isArray
```
public boolean isArray
```
  - isMultipart
```
public boolean isMultipart
```
  - isVoid
```
public boolean isVoid
```
  - hasVersionHeaders
```
public boolean hasVersionHeaders
```
  - hasVersionQueryParams
```
public boolean hasVersionQueryParams
```
  - isResponseBinary
```
public boolean isResponseBinary
```
  - isResponseFile
```
public boolean isResponseFile
```
  - isResponseOptional
```
public boolean isResponseOptional
```
  - hasReference
```
public boolean hasReference
```
  - defaultReturnType
```
public boolean defaultReturnType
```
  - isRestfulIndex
```
public boolean isRestfulIndex
```
  - isRestfulShow
```
public boolean isRestfulShow
```
  - isRestfulCreate
```
public boolean isRestfulCreate
```
  - isRestfulUpdate
```
public boolean isRestfulUpdate
```
  - isRestfulDestroy
```
public boolean isRestfulDestroy
```
  - isRestful
```
public boolean isRestful
```
  - isDeprecated
```
public boolean isDeprecated
```
  - isCallbackRequest
```
public boolean isCallbackRequest
```
  - uniqueItems
```
public boolean uniqueItems
```
  - hasDefaultResponse
```
public boolean hasDefaultResponse
```
  - hasErrorResponseObject
```
public boolean hasErrorResponseObject
```
  - returnProperty
```
public CodegenProperty returnProperty
```
  - path
```
public String path
```
  - operationId
```
public String operationId
```
  - returnType
```
public String returnType
```
  - returnFormat
```
public String returnFormat
```
  - httpMethod
```
public String httpMethod
```
  - returnBaseType
```
public String returnBaseType
```
  - returnContainer
```
public String returnContainer
```
  - summary
```
public String summary
```
  - unescapedNotes
```
public String unescapedNotes
```
  - notes
```
public String notes
```
  - baseName
```
public String baseName
```
  - defaultResponse
```
public String defaultResponse
```
  - discriminator
```
public CodegenDiscriminator discriminator
```
  - consumes
```
public List<Map<String,String>> consumes
```
  - produces
```
public List<Map<String,String>> produces
```
  - prioritizedContentTypes
```
public List<Map<String,String>> prioritizedContentTypes
```
  - servers
```
public List<CodegenServer> servers
```
  - bodyParam
```
public CodegenParameter bodyParam
```
  - allParams
```
public List<CodegenParameter> allParams
```
  - bodyParams
```
public List<CodegenParameter> bodyParams
```
  - pathParams
```
public List<CodegenParameter> pathParams
```
  - queryParams
```
public List<CodegenParameter> queryParams
```
  - headerParams
```
public List<CodegenParameter> headerParams
```
  - implicitHeadersParams
```
public List<CodegenParameter> implicitHeadersParams
```
  - formParams
```
public List<CodegenParameter> formParams
```
  - cookieParams
```
public List<CodegenParameter> cookieParams
```
  - requiredParams
```
public List<CodegenParameter> requiredParams
```
  - optionalParams
```
public List<CodegenParameter> optionalParams
```
  - requiredAndNotNullableParams
```
public List<CodegenParameter> requiredAndNotNullableParams
```
  - notNullableParams
```
public List<CodegenParameter> notNullableParams
```
  - authMethods
```
public List<CodegenSecurity> authMethods
```
  - tags
```
public List<io.swagger.v3.oas.models.tags.Tag> tags
```
  - responses
```
public List<CodegenResponse> responses
```
  - callbacks
```
public List<CodegenCallback> callbacks
```
  - imports
```
public Set<String> imports
```
  - examples
```
public List<Map<String,String>> examples
```
  - requestBodyExamples
```
public List<Map<String,String>> requestBodyExamples
```
  - externalDocs
```
public io.swagger.v3.oas.models.ExternalDocumentation externalDocs
```
  - vendorExtensions
```
public Map<String,Object> vendorExtensions
```
  - nickname
```
public String nickname
```
  - operationIdOriginal
```
public String operationIdOriginal
```
  - operationIdLowerCase
```
public String operationIdLowerCase
```
  - operationIdCamelCase
```
public String operationIdCamelCase
```
  - operationIdSnakeCase
```
public String operationIdSnakeCase
```
- Constructor Detail
  - CodegenOperation
```
public CodegenOperation()
```
- Method Detail
  - getHasBodyParam
```
public boolean getHasBodyParam()
```
    Check if there's at least one body parameter
    
    Returns:
    
    true if body parameter exists, false otherwise
  - getHasQueryParams
```
public boolean getHasQueryParams()
```
    Check if there's at least one query parameter
    
    Returns:
    
    true if query parameter exists, false otherwise
  - getHasQueryParamsOrAuth
```
public boolean getHasQueryParamsOrAuth()
```
    Check if there's at least one query parameter or passing API keys in query
    
    Returns:
    
    true if query parameter exists or passing API keys in query, false otherwise
  - getHasHeaderParams
```
public boolean getHasHeaderParams()
```
    Check if there's at least one header parameter
    
    Returns:
    
    true if header parameter exists, false otherwise
  - getHasPathParams
```
public boolean getHasPathParams()
```
    Check if there's at least one path parameter
    
    Returns:
    
    true if path parameter exists, false otherwise
  - getHasFormParams
```
public boolean getHasFormParams()
```
    Check if there's at least one form parameter
    
    Returns:
    
    true if any form parameter exists, false otherwise
  - getHasBodyOrFormParams
```
public boolean getHasBodyOrFormParams()
```
    Check if there's at least one body parameter or at least one form parameter
    
    Returns:
    
    true if body or form parameter exists, false otherwise
  - getHasCookieParams
```
public boolean getHasCookieParams()
```
    Check if there's at least one form parameter
    
    Returns:
    
    true if any cookie parameter exists, false otherwise
  - getHasOptionalParams
```
public boolean getHasOptionalParams()
```
    Check if there's at least one optional parameter
    
    Returns:
    
    true if any optional parameter exists, false otherwise
  - getHasRequiredAndNotNullableParams
```
public boolean getHasRequiredAndNotNullableParams()
```
  - getHasNotNullableParams
```
public boolean getHasNotNullableParams()
```
  - getHasRequiredParams
```
public boolean getHasRequiredParams()
```
    Check if there's at least one required parameter
    
    Returns:
    
    true if any optional parameter exists, false otherwise
  - getHasResponseHeaders
```
public boolean getHasResponseHeaders()
```
    Check if there's at least one response header
    
    Returns:
    
    true if header response exists, false otherwise
  - getHasExamples
```
public boolean getHasExamples()
```
    Check if there's at least one example parameter
    
    Returns:
    
    true if examples parameter exists, false otherwise
  - getHasDefaultResponse
```
public boolean getHasDefaultResponse()
```
    Check if there's a default response
    
    Returns:
    
    true if responses contain a default response, false otherwise
  - getAllResponsesAreErrors
```
public boolean getAllResponsesAreErrors()
```
  - contentTypeToOperation
```
public Map<String,CodegenOperation> contentTypeToOperation()
```
    Returns:
    
    contentTypeToOperation returns a map where the key is the request body content type and the value is the current CodegenOperation this is needed by templates when a different signature is needed for each request body content type
  - getHasVendorExtensions
```
public boolean getHasVendorExtensions()
```
    Check if there's at least one vendor extension
    
    Returns:
    
    true if vendor extensions exists, false otherwise
  - isRestfulIndex
```
public boolean isRestfulIndex()
```
    Check if act as Restful index method
    
    Returns:
    
    true if act as Restful index method, false otherwise
  - isRestfulShow
```
public boolean isRestfulShow()
```
    Check if act as Restful show method
    
    Returns:
    
    true if act as Restful show method, false otherwise
  - isRestfulCreate
```
public boolean isRestfulCreate()
```
    Check if act as Restful create method
    
    Returns:
    
    true if act as Restful create method, false otherwise
  - isRestfulUpdate
```
public boolean isRestfulUpdate()
```
    Check if act as Restful update method
    
    Returns:
    
    true if act as Restful update method, false otherwise
  - isBodyAllowed
```
public boolean isBodyAllowed()
```
    Check if body param is allowed for the request method
    
    Returns:
    
    true request method is PUT, PATCH or POST; false otherwise
  - isRestfulDestroy
```
public boolean isRestfulDestroy()
```
    Check if act as Restful destroy method
    
    Returns:
    
    true if act as Restful destroy method, false otherwise
  - isRestful
```
public boolean isRestful()
```
    Check if Restful-style
    
    Returns:
    
    true if Restful-style, false otherwise
  - 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

Class CodegenOperation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

responseHeaders

hasAuthMethods

hasConsumes

hasProduces

hasParams

hasOptionalParams

hasRequiredParams

returnTypeIsPrimitive

returnSimpleType

subresourceOperation

isMap

isArray

isMultipart

isVoid

hasVersionHeaders

hasVersionQueryParams

isResponseBinary

isResponseFile

isResponseOptional

hasReference

defaultReturnType

isRestfulIndex

isRestfulShow

isRestfulCreate

isRestfulUpdate

isRestfulDestroy

isRestful

isDeprecated

isCallbackRequest

uniqueItems

hasDefaultResponse

hasErrorResponseObject

returnProperty

path

operationId

returnType

returnFormat

httpMethod

returnBaseType

returnContainer

summary

unescapedNotes

notes

baseName

defaultResponse

discriminator

consumes

produces

prioritizedContentTypes

servers

bodyParam

allParams

bodyParams

pathParams

queryParams

headerParams

implicitHeadersParams

formParams

cookieParams

requiredParams

optionalParams

requiredAndNotNullableParams

notNullableParams

authMethods

tags

responses

callbacks

imports

examples

requestBodyExamples

externalDocs

vendorExtensions

nickname

operationIdOriginal