Package io.smallrye.openapi.api.models
Class OperationImpl
- java.lang.Object
-
- io.smallrye.openapi.api.models.ExtensibleImpl<org.eclipse.microprofile.openapi.models.Operation>
-
- io.smallrye.openapi.api.models.OperationImpl
-
- All Implemented Interfaces:
ModelImpl
,org.eclipse.microprofile.openapi.models.Constructible
,org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.Operation>
,org.eclipse.microprofile.openapi.models.Operation
public class OperationImpl extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.Operation> implements org.eclipse.microprofile.openapi.models.Operation, ModelImpl
An implementation of theOperation
OpenAPI model interface.
-
-
Constructor Summary
Constructors Constructor Description OperationImpl()
OperationImpl(String methodRef)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.eclipse.microprofile.openapi.models.Operation
addCallback(String key, org.eclipse.microprofile.openapi.models.callbacks.Callback callback)
org.eclipse.microprofile.openapi.models.Operation
addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
org.eclipse.microprofile.openapi.models.Operation
addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
org.eclipse.microprofile.openapi.models.Operation
addServer(org.eclipse.microprofile.openapi.models.servers.Server server)
org.eclipse.microprofile.openapi.models.Operation
addTag(String tag)
Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>
getCallbacks()
Boolean
getDeprecated()
String
getDescription()
org.eclipse.microprofile.openapi.models.ExternalDocumentation
getExternalDocs()
String
getMethodRef()
Implementation specific, set a reference to the Java Method, so that we can bind back to it later if neededString
getOperationId()
List<org.eclipse.microprofile.openapi.models.parameters.Parameter>
getParameters()
org.eclipse.microprofile.openapi.models.parameters.RequestBody
getRequestBody()
org.eclipse.microprofile.openapi.models.responses.APIResponses
getResponses()
List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>
getSecurity()
List<org.eclipse.microprofile.openapi.models.servers.Server>
getServers()
String
getSummary()
List<String>
getTags()
void
removeCallback(String key)
void
removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
void
removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
void
removeServer(org.eclipse.microprofile.openapi.models.servers.Server server)
void
removeTag(String tag)
void
setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)
void
setDeprecated(Boolean deprecated)
void
setDescription(String description)
void
setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)
void
setMethodRef(String methodRef)
void
setOperationId(String operationId)
void
setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)
void
setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
void
setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)
void
setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)
void
setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
void
setSummary(String summary)
void
setTags(List<String> tags)
-
Methods inherited from class io.smallrye.openapi.api.models.ExtensibleImpl
addExtension, getExtensions, removeExtension, setExtensions
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Constructor Detail
-
OperationImpl
public OperationImpl()
-
OperationImpl
public OperationImpl(String methodRef)
-
-
Method Detail
-
getTags
public List<String> getTags()
- Specified by:
getTags
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getTags()
-
setTags
public void setTags(List<String> tags)
- Specified by:
setTags
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setTags(java.util.List)
-
addTag
public org.eclipse.microprofile.openapi.models.Operation addTag(String tag)
- Specified by:
addTag
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.addTag(java.lang.String)
-
removeTag
public void removeTag(String tag)
- Specified by:
removeTag
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.removeTag(String)
-
getSummary
public String getSummary()
- Specified by:
getSummary
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getSummary()
-
setSummary
public void setSummary(String summary)
- Specified by:
setSummary
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setSummary(java.lang.String)
-
getDescription
public String getDescription()
- Specified by:
getDescription
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getDescription()
-
setDescription
public void setDescription(String description)
- Specified by:
setDescription
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setDescription(java.lang.String)
-
getExternalDocs
public org.eclipse.microprofile.openapi.models.ExternalDocumentation getExternalDocs()
- Specified by:
getExternalDocs
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getExternalDocs()
-
setExternalDocs
public void setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)
- Specified by:
setExternalDocs
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation)
-
getOperationId
public String getOperationId()
- Specified by:
getOperationId
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getOperationId()
-
setOperationId
public void setOperationId(String operationId)
- Specified by:
setOperationId
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setOperationId(java.lang.String)
-
getParameters
public List<org.eclipse.microprofile.openapi.models.parameters.Parameter> getParameters()
- Specified by:
getParameters
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getParameters()
-
setParameters
public void setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)
- Specified by:
setParameters
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setParameters(java.util.List)
-
addParameter
public org.eclipse.microprofile.openapi.models.Operation addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
- Specified by:
addParameter
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter)
-
removeParameter
public void removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
- Specified by:
removeParameter
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter)
-
getRequestBody
public org.eclipse.microprofile.openapi.models.parameters.RequestBody getRequestBody()
- Specified by:
getRequestBody
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getRequestBody()
-
setRequestBody
public void setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
- Specified by:
setRequestBody
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody)
-
getResponses
public org.eclipse.microprofile.openapi.models.responses.APIResponses getResponses()
- Specified by:
getResponses
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getResponses()
-
setResponses
public void setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)
- Specified by:
setResponses
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses)
-
getCallbacks
public Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> getCallbacks()
- Specified by:
getCallbacks
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getCallbacks()
-
setCallbacks
public void setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)
- Specified by:
setCallbacks
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setCallbacks(java.util.Map)
-
addCallback
public org.eclipse.microprofile.openapi.models.Operation addCallback(String key, org.eclipse.microprofile.openapi.models.callbacks.Callback callback)
- Specified by:
addCallback
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.addCallback(java.lang.String, org.eclipse.microprofile.openapi.models.callbacks.Callback)
-
removeCallback
public void removeCallback(String key)
- Specified by:
removeCallback
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.removeCallback(java.lang.String)
-
getDeprecated
public Boolean getDeprecated()
- Specified by:
getDeprecated
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getDeprecated()
-
setDeprecated
public void setDeprecated(Boolean deprecated)
- Specified by:
setDeprecated
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setDeprecated(java.lang.Boolean)
-
getSecurity
public List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()
- Specified by:
getSecurity
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getSecurity()
-
setSecurity
public void setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)
- Specified by:
setSecurity
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setSecurity(java.util.List)
-
addSecurityRequirement
public org.eclipse.microprofile.openapi.models.Operation addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
- Specified by:
addSecurityRequirement
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement)
-
removeSecurityRequirement
public void removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
- Specified by:
removeSecurityRequirement
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement)
-
getServers
public List<org.eclipse.microprofile.openapi.models.servers.Server> getServers()
- Specified by:
getServers
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.getServers()
-
setServers
public void setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
- Specified by:
setServers
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.setServers(java.util.List)
-
addServer
public org.eclipse.microprofile.openapi.models.Operation addServer(org.eclipse.microprofile.openapi.models.servers.Server server)
- Specified by:
addServer
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.addServer(org.eclipse.microprofile.openapi.models.servers.Server)
-
removeServer
public void removeServer(org.eclipse.microprofile.openapi.models.servers.Server server)
- Specified by:
removeServer
in interfaceorg.eclipse.microprofile.openapi.models.Operation
- See Also:
Operation.removeServer(org.eclipse.microprofile.openapi.models.servers.Server)
-
getMethodRef
public String getMethodRef()
Implementation specific, set a reference to the Java Method, so that we can bind back to it later if needed- Returns:
- reference to the method that we scanned this on
-
setMethodRef
public void setMethodRef(String methodRef)
-
-