CodegenOperation (openapi-generator (core library) 4.1.0 API)

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

public class CodegenOperation
extends Object

Field Summary

Fields
Modifier and Type	Field and 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`
`CodegenDiscriminator`	`discriminator`
`List<Map<String,String>>`	`examples`
`io.swagger.v3.oas.models.ExternalDocumentation`	`externalDocs`
`List<CodegenParameter>`	`formParams`
`boolean`	`hasAuthMethods`
`boolean`	`hasConsumes`
`boolean`	`hasMore`
`boolean`	`hasOptionalParams`
`boolean`	`hasParams`
`boolean`	`hasProduces`
`boolean`	`hasReference`
`boolean`	`hasRequiredParams`
`List<CodegenParameter>`	`headerParams`
`String`	`httpMethod`
`Set<String>`	`imports`
`boolean`	`isCallbackRequest`
`boolean`	`isDeprecated`
`boolean`	`isListContainer`
`boolean`	`isMapContainer`
`boolean`	`isMultipart`
`boolean`	`isResponseBinary`
`boolean`	`isResponseFile`
`boolean`	`isRestful`
`boolean`	`isRestfulCreate`
`boolean`	`isRestfulDestroy`
`boolean`	`isRestfulIndex`
`boolean`	`isRestfulShow`
`boolean`	`isRestfulUpdate`
`String`	`nickname`
`String`	`notes`
`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>`	`requiredParams`
`List<CodegenProperty>`	`responseHeaders`
`List<CodegenResponse>`	`responses`
`String`	`returnBaseType`
`String`	`returnContainer`
`boolean`	`returnSimpleType`
`String`	`returnType`
`boolean`	`returnTypeIsPrimitive`
`List<CodegenServer>`	`servers`
`boolean`	`subresourceOperation`
`String`	`summary`
`List<io.swagger.v3.oas.models.tags.Tag>`	`tags`
`String`	`unescapedNotes`
`Map<String,Object>`	`vendorExtensions`

Constructor Summary

Constructors
Constructor and Description

CodegenOperation()

Constructors
Constructor and Description
`CodegenOperation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`boolean`	`getHasBodyParam()` Check if there's at least one body parameter
`boolean`	`getHasCookieParams()` Check if there's at least one form parameter
`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`	`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`	`getHasRequiredParams()` Check if there's at least one required parameter
`boolean`	`getHasResponseHeaders()` Check if there's at least one response header
`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
```

isMapContainer
```
public boolean isMapContainer
```

isListContainer
```
public boolean isListContainer
```

isMultipart
```
public boolean isMultipart
```

hasMore
```
public boolean hasMore
```

isResponseBinary
```
public boolean isResponseBinary
```

isResponseFile
```
public boolean isResponseFile
```

hasReference
```
public boolean hasReference
```

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
```

path
```
public String path
```

operationId
```
public String operationId
```

returnType
```
public String returnType
```

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

formParams

public List<CodegenParameter> formParams

cookieParams

public List<CodegenParameter> cookieParams

requiredParams

public List<CodegenParameter> requiredParams

optionalParams

public List<CodegenParameter> optionalParams

authMethods

public List<CodegenSecurity> authMethods

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
- 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
- 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
- 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
- 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

isMapContainer

isListContainer

isMultipart

hasMore

isResponseBinary

isResponseFile

hasReference

isRestfulIndex

isRestfulShow

isRestfulCreate

isRestfulUpdate

isRestfulDestroy

isRestful

isDeprecated

isCallbackRequest

path

operationId

returnType

httpMethod

returnBaseType

returnContainer

summary

unescapedNotes

notes

baseName

defaultResponse

discriminator

consumes

produces

prioritizedContentTypes

servers

bodyParam

allParams

bodyParams

pathParams

queryParams

headerParams

formParams

cookieParams

requiredParams

optionalParams

authMethods

tags

responses

callbacks

imports

examples

requestBodyExamples

externalDocs

vendorExtensions

nickname

operationIdOriginal

operationIdLowerCase

operationIdCamelCase

operationIdSnakeCase

Constructor Detail

CodegenOperation

Method Detail

getHasBodyParam

getHasQueryParams

getHasHeaderParams

getHasPathParams

getHasFormParams

getHasCookieParams