Package io.swagger.codegen.v3

Class CodegenOperation

java.lang.Object

io.swagger.codegen.v3.CodegenObject

io.swagger.codegen.v3.CodegenOperation

All Implemented Interfaces:

VendorExtendable

public class CodegenOperation
extends CodegenObject

Field Summary

Fields

Modifier and Type	Field	Description
List<CodegenParameter>	allParams
List<CodegenSecurity>	authMethods
String	baseName
CodegenParameter	bodyParam
List<CodegenParameter>	bodyParams
List<Map<String,String>>	consumes
List<CodegenContent>	contents
List<CodegenParameter>	cookieParams
String	defaultResponse
io.swagger.v3.oas.models.media.Discriminator	discriminator
List<Map<String,String>>	examples
io.swagger.v3.oas.models.ExternalDocumentation	externalDocs
List<CodegenParameter>	formParams
List<CodegenParameter>	headerParams
String	httpMethod
Set<String>	imports
String	nickname
String	notes
String	operationId
String	operationIdCamelCase
String	operationIdLowerCase
String	operationIdSnakeCase
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
boolean	subresourceOperation
String	summary
List<io.swagger.v3.oas.models.tags.Tag>	tags
String	testPath
String	unescapedNotes

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
CodegenOperation()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<CodegenParameter>	getAllParams()
List<CodegenSecurity>	getAuthMethods()
String	getBaseName()
CodegenParameter	getBodyParam()
List<CodegenParameter>	getBodyParams()
List<Map<String,String>>	getConsumes()
List<CodegenContent>	getContents()
List<CodegenParameter>	getCookieParams()
String	getDefaultResponse()
io.swagger.v3.oas.models.media.Discriminator	getDiscriminator()
List<Map<String,String>>	getExamples()
io.swagger.v3.oas.models.ExternalDocumentation	getExternalDocs()
List<CodegenParameter>	getFormParams()
Boolean	getHasAuthMethods()
boolean	getHasBodyParam()	Check if there's at least one body parameter
Boolean	getHasConsumes()
boolean	getHasCookieParams()	Check if there's at least one cookie 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()
Boolean	getHasParams()
boolean	getHasPathParams()	Check if there's at least one path parameter
Boolean	getHasProduces()
boolean	getHasQueryParams()	Check if there's at least one query parameter
Boolean	getHasReference()
Boolean	getHasRequiredParams()
List<CodegenParameter>	getHeaderParams()
String	getHttpMethod()
Set<String>	getImports()
boolean	getIsBodyAllowed()	Check if body param is allowed for the request method
Boolean	getIsDeprecated()
boolean	getIsRestful()	Check if Restful-style
boolean	getIsRestfulCreate()	Check if act as Restful create method
boolean	getIsRestfulDestroy()	Check if act as Restful destroy method
boolean	getIsRestfulIndex()	Check if act as Restful index method
boolean	getIsRestfulShow()	Check if act as Restful show method
boolean	getIsRestfulUpdate()	Check if act as Restful update method
String	getNickname()
String	getNotes()
String	getOperationId()
String	getOperationIdCamelCase()
String	getOperationIdLowerCase()
String	getOperationIdSnakeCase()
String	getPath()
List<CodegenParameter>	getPathParams()
List<Map<String,String>>	getPrioritizedContentTypes()
List<Map<String,String>>	getProduces()
List<CodegenParameter>	getQueryParams()
List<Map<String,String>>	getRequestBodyExamples()
List<CodegenParameter>	getRequiredParams()
List<CodegenProperty>	getResponseHeaders()
List<CodegenResponse>	getResponses()
String	getReturnBaseType()
String	getReturnContainer()
boolean	getReturnSimpleType()
String	getReturnType()
boolean	getReturnTypeIsPrimitive()
boolean	getSubresourceOperation()
String	getSummary()
List<io.swagger.v3.oas.models.tags.Tag>	getTags()
String	getTestPath()
String	getUnescapedNotes()
int	hashCode()
String	toString()

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

responseHeaders

public final List<CodegenProperty> responseHeaders

returnTypeIsPrimitive

public boolean returnTypeIsPrimitive

returnSimpleType

public boolean returnSimpleType

subresourceOperation

public boolean subresourceOperation

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

testPath

public String testPath

discriminator

public io.swagger.v3.oas.models.media.Discriminator discriminator

consumes

public List<Map<String,String>> consumes

produces

public List<Map<String,String>> produces

prioritizedContentTypes

public List<Map<String,String>> prioritizedContentTypes

bodyParam

public CodegenParameter bodyParam

contents

public List<CodegenContent> contents

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

cookieParams

public List<CodegenParameter> cookieParams

formParams

public List<CodegenParameter> formParams

requiredParams

public List<CodegenParameter> requiredParams

authMethods

public List<CodegenSecurity> authMethods

tags

public List<io.swagger.v3.oas.models.tags.Tag> tags

responses

public List<CodegenResponse> responses

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

nickname

public String nickname

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

getHasCookieParams

public boolean getHasCookieParams()

Check if there's at least one cookie parameter

Returns:

true if cookie 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

getHasExamples

public boolean getHasExamples()

Check if there's at least one example parameter

Returns:

true if examples parameter exists, false otherwise

getIsRestfulIndex

public boolean getIsRestfulIndex()

Check if act as Restful index method

Returns:

true if act as Restful index method, false otherwise

getIsRestfulShow

public boolean getIsRestfulShow()

Check if act as Restful show method

Returns:

true if act as Restful show method, false otherwise

getIsRestfulCreate

public boolean getIsRestfulCreate()

Check if act as Restful create method

Returns:

true if act as Restful create method, false otherwise

getIsRestfulUpdate

public boolean getIsRestfulUpdate()

Check if act as Restful update method

Returns:

true if act as Restful update method, false otherwise

getIsBodyAllowed

public boolean getIsBodyAllowed()

Check if body param is allowed for the request method

Returns:

true request method is PUT, PATCH or POST; false otherwise

getIsRestfulDestroy

public boolean getIsRestfulDestroy()

Check if act as Restful destroy method

Returns:

true if act as Restful destroy method, false otherwise

getIsRestful

public boolean getIsRestful()

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

getResponseHeaders

public List<CodegenProperty> getResponseHeaders()

getPath

public String getPath()

getOperationId

public String getOperationId()

getReturnType

public String getReturnType()

getHttpMethod

public String getHttpMethod()

getReturnBaseType

public String getReturnBaseType()

getReturnContainer

public String getReturnContainer()

getSummary

public String getSummary()

getUnescapedNotes

public String getUnescapedNotes()

getNotes

public String getNotes()

getBaseName

public String getBaseName()

getDefaultResponse

public String getDefaultResponse()

getTestPath

public String getTestPath()

getDiscriminator

public io.swagger.v3.oas.models.media.Discriminator getDiscriminator()

getConsumes

public List<Map<String,String>> getConsumes()

getProduces

public List<Map<String,String>> getProduces()

getPrioritizedContentTypes

public List<Map<String,String>> getPrioritizedContentTypes()

getBodyParam

public CodegenParameter getBodyParam()

getContents

public List<CodegenContent> getContents()

getAllParams

public List<CodegenParameter> getAllParams()

getBodyParams

public List<CodegenParameter> getBodyParams()

getPathParams

public List<CodegenParameter> getPathParams()

getQueryParams

public List<CodegenParameter> getQueryParams()

getHeaderParams

public List<CodegenParameter> getHeaderParams()

getCookieParams

public List<CodegenParameter> getCookieParams()

getFormParams

public List<CodegenParameter> getFormParams()

getReturnTypeIsPrimitive

public boolean getReturnTypeIsPrimitive()

getReturnSimpleType

public boolean getReturnSimpleType()

getSubresourceOperation

public boolean getSubresourceOperation()

getRequiredParams

public List<CodegenParameter> getRequiredParams()

getAuthMethods

public List<CodegenSecurity> getAuthMethods()

getTags

public List<io.swagger.v3.oas.models.tags.Tag> getTags()

getResponses

public List<CodegenResponse> getResponses()

getImports

public Set<String> getImports()

getExamples

public List<Map<String,String>> getExamples()

getRequestBodyExamples

public List<Map<String,String>> getRequestBodyExamples()

getExternalDocs

public io.swagger.v3.oas.models.ExternalDocumentation getExternalDocs()

getNickname

public String getNickname()

getOperationIdLowerCase

public String getOperationIdLowerCase()

getOperationIdCamelCase

public String getOperationIdCamelCase()

getOperationIdSnakeCase

public String getOperationIdSnakeCase()

getIsDeprecated

public Boolean getIsDeprecated()

getHasAuthMethods

public Boolean getHasAuthMethods()

getHasConsumes

public Boolean getHasConsumes()

getHasProduces

public Boolean getHasProduces()

getHasParams

public Boolean getHasParams()

getHasOptionalParams

public Boolean getHasOptionalParams()

getHasRequiredParams

public Boolean getHasRequiredParams()

getHasReference

public Boolean getHasReference()