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 the ExternalDocumentation OpenAPI model interface.

Constructor Summary

Constructors

Constructor and Description
OperationImpl()

Method Summary

Modifier and Type	Method and 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)
org.eclipse.microprofile.openapi.models.Operation	callbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)
org.eclipse.microprofile.openapi.models.Operation	deprecated(Boolean deprecated)
org.eclipse.microprofile.openapi.models.Operation	description(String description)
org.eclipse.microprofile.openapi.models.Operation	externalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)
Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>	getCallbacks()
Boolean	getDeprecated()
String	getDescription()
org.eclipse.microprofile.openapi.models.ExternalDocumentation	getExternalDocs()
String	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()
org.eclipse.microprofile.openapi.models.Operation	operationId(String operationId)
org.eclipse.microprofile.openapi.models.Operation	parameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)
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)
org.eclipse.microprofile.openapi.models.Operation	requestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
org.eclipse.microprofile.openapi.models.Operation	responses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)
org.eclipse.microprofile.openapi.models.Operation	security(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)
org.eclipse.microprofile.openapi.models.Operation	servers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
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	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)
org.eclipse.microprofile.openapi.models.Operation	summary(String summary)
org.eclipse.microprofile.openapi.models.Operation	tags(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

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, extensions, getExtensions, removeExtension, setExtensions

Constructor Detail

OperationImpl

public OperationImpl()

Method Detail

getTags

public List<String> getTags()

Specified by:

getTags in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getTags()

setTags

public void setTags(List<String> tags)

Specified by:

setTags in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setTags(java.util.List)

tags

public org.eclipse.microprofile.openapi.models.Operation tags(List<String> tags)

Specified by:

tags in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.tags(java.util.List)

addTag

public org.eclipse.microprofile.openapi.models.Operation addTag(String tag)

Specified by:

addTag in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.addTag(java.lang.String)

removeTag

public void removeTag(String tag)

Specified by:

removeTag in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.removeTag(String)

getSummary

public String getSummary()

Specified by:

getSummary in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getSummary()

setSummary

public void setSummary(String summary)

Specified by:

setSummary in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setSummary(java.lang.String)

summary

public org.eclipse.microprofile.openapi.models.Operation summary(String summary)

Specified by:

summary in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.summary(java.lang.String)

getDescription

public String getDescription()

Specified by:

getDescription in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getDescription()

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setDescription(java.lang.String)

description

public org.eclipse.microprofile.openapi.models.Operation description(String description)

Specified by:

description in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.description(java.lang.String)

getExternalDocs

public org.eclipse.microprofile.openapi.models.ExternalDocumentation getExternalDocs()

Specified by:

getExternalDocs in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getExternalDocs()

setExternalDocs

public void setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)

Specified by:

setExternalDocs in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setExternalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation)

externalDocs

public org.eclipse.microprofile.openapi.models.Operation externalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)

Specified by:

externalDocs in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.externalDocs(org.eclipse.microprofile.openapi.models.ExternalDocumentation)

getOperationId

public String getOperationId()

Specified by:

getOperationId in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getOperationId()

setOperationId

public void setOperationId(String operationId)

Specified by:

setOperationId in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setOperationId(java.lang.String)

operationId

public org.eclipse.microprofile.openapi.models.Operation operationId(String operationId)

Specified by:

operationId in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.operationId(java.lang.String)

getParameters

public List<org.eclipse.microprofile.openapi.models.parameters.Parameter> getParameters()

Specified by:

getParameters in interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setParameters(java.util.List)

parameters

public org.eclipse.microprofile.openapi.models.Operation parameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> parameters)

Specified by:

parameters in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.parameters(java.util.List)

addParameter

public org.eclipse.microprofile.openapi.models.Operation addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)

Specified by:

addParameter in interface org.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 interface org.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 interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody)

requestBody

public org.eclipse.microprofile.openapi.models.Operation requestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)

Specified by:

requestBody in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.requestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody)

getResponses

public org.eclipse.microprofile.openapi.models.responses.APIResponses getResponses()

Specified by:

getResponses in interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses)

responses

public org.eclipse.microprofile.openapi.models.Operation responses(org.eclipse.microprofile.openapi.models.responses.APIResponses responses)

Specified by:

responses in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.responses(org.eclipse.microprofile.openapi.models.responses.APIResponses)

getCallbacks

public Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> getCallbacks()

Specified by:

getCallbacks in interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setCallbacks(java.util.Map)

callbacks

public org.eclipse.microprofile.openapi.models.Operation callbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> callbacks)

Specified by:

callbacks in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.callbacks(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 interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.removeCallback(java.lang.String)

getDeprecated

public Boolean getDeprecated()

Specified by:

getDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.getDeprecated()

setDeprecated

public void setDeprecated(Boolean deprecated)

Specified by:

setDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setDeprecated(java.lang.Boolean)

deprecated

public org.eclipse.microprofile.openapi.models.Operation deprecated(Boolean deprecated)

Specified by:

deprecated in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.deprecated(java.lang.Boolean)

getSecurity

public List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()

Specified by:

getSecurity in interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setSecurity(java.util.List)

security

public org.eclipse.microprofile.openapi.models.Operation security(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)

Specified by:

security in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.security(java.util.List)

addSecurityRequirement

public org.eclipse.microprofile.openapi.models.Operation addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)

Specified by:

addSecurityRequirement in interface org.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 interface org.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 interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.setServers(java.util.List)

servers

public org.eclipse.microprofile.openapi.models.Operation servers(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)

Specified by:

servers in interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.servers(java.util.List)

addServer

public org.eclipse.microprofile.openapi.models.Operation addServer(org.eclipse.microprofile.openapi.models.servers.Server server)

Specified by:

addServer in interface org.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 interface org.eclipse.microprofile.openapi.models.Operation

See Also:

Operation.removeServer(org.eclipse.microprofile.openapi.models.servers.Server)