Package io.swagger.v3.oas.models

Class Operation

java.lang.Object

io.swagger.v3.oas.models.Operation

public class Operation
extends Object

Operation

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operation-object", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#operation-object"

Constructor Summary

Constructors

Constructor	Description
Operation()

Method Summary

Modifier and Type	Method	Description
Operation	addCallback(String key, Callback callback)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
Operation	addParametersItem(Parameter parametersItem)
Operation	addSecurityItem(SecurityRequirement securityItem)
Operation	addServersItem(Server serversItem)
Operation	addTagsItem(String tagsItem)
Operation	callbacks(Map<String,Callback> callbacks)
Operation	deprecated(Boolean deprecated)
Operation	description(String description)
boolean	equals(Object o)
Operation	extensions(Map<String,Object> extensions)
Operation	externalDocs(ExternalDocumentation externalDocs)
Map<String,Callback>	getCallbacks()	returns the callbacks property from a Operation instance.
Boolean	getDeprecated()	returns the deprecated property from a Operation instance.
String	getDescription()	returns the description property from a Operation instance.
Map<String,Object>	getExtensions()
ExternalDocumentation	getExternalDocs()	returns the externalDocs property from a Operation instance.
String	getOperationId()	returns the operationId property from a Operation instance.
List<Parameter>	getParameters()	returns the parameters property from a Operation instance.
RequestBody	getRequestBody()	returns the requestBody property from a Operation instance.
ApiResponses	getResponses()	returns the responses property from a Operation instance.
List<SecurityRequirement>	getSecurity()	returns the security property from a Operation instance.
List<Server>	getServers()	returns the servers property from a Operation instance.
String	getSummary()	returns the summary property from a Operation instance.
List<String>	getTags()	returns the tags property from a Operation instance.
int	hashCode()
Operation	operationId(String operationId)
Operation	parameters(List<Parameter> parameters)
Operation	requestBody(RequestBody requestBody)
Operation	responses(ApiResponses responses)
Operation	security(List<SecurityRequirement> security)
Operation	servers(List<Server> servers)
void	setCallbacks(Map<String,Callback> callbacks)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setExternalDocs(ExternalDocumentation externalDocs)
void	setOperationId(String operationId)
void	setParameters(List<Parameter> parameters)
void	setRequestBody(RequestBody requestBody)
void	setResponses(ApiResponses responses)
void	setSecurity(List<SecurityRequirement> security)
void	setServers(List<Server> servers)
void	setSummary(String summary)
void	setTags(List<String> tags)
Operation	summary(String summary)
Operation	tags(List<String> tags)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Operation

public Operation()

Method Detail

getTags

public List<String> getTags()

returns the tags property from a Operation instance.

Returns:

List<String> tags

setTags

public void setTags(List<String> tags)

tags

public Operation tags(List<String> tags)

addTagsItem

public Operation addTagsItem(String tagsItem)

getSummary

public String getSummary()

returns the summary property from a Operation instance.

Returns:

String summary

setSummary

public void setSummary(String summary)

summary

public Operation summary(String summary)

getDescription

public String getDescription()

returns the description property from a Operation instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Operation description(String description)

getExternalDocs

public ExternalDocumentation getExternalDocs()

returns the externalDocs property from a Operation instance.

Returns:

ExternalDocumentation externalDocs

setExternalDocs

public void setExternalDocs(ExternalDocumentation externalDocs)

externalDocs

public Operation externalDocs(ExternalDocumentation externalDocs)

getOperationId

public String getOperationId()

returns the operationId property from a Operation instance.

Returns:

String operationId

setOperationId

public void setOperationId(String operationId)

operationId

public Operation operationId(String operationId)

getParameters

public List<Parameter> getParameters()

returns the parameters property from a Operation instance.

Returns:

List<Parameter> parameters

setParameters

public void setParameters(List<Parameter> parameters)

parameters

public Operation parameters(List<Parameter> parameters)

addParametersItem

public Operation addParametersItem(Parameter parametersItem)

getRequestBody

public RequestBody getRequestBody()

returns the requestBody property from a Operation instance.

Returns:

RequestBody requestBody

setRequestBody

public void setRequestBody(RequestBody requestBody)

requestBody

public Operation requestBody(RequestBody requestBody)

getResponses

public ApiResponses getResponses()

returns the responses property from a Operation instance.

Returns:

ApiResponses responses

setResponses

public void setResponses(ApiResponses responses)

responses

public Operation responses(ApiResponses responses)

getCallbacks

public Map<String,Callback> getCallbacks()

returns the callbacks property from a Operation instance.

Returns:

Callbacks callbacks

setCallbacks

public void setCallbacks(Map<String,Callback> callbacks)

callbacks

public Operation callbacks(Map<String,Callback> callbacks)

addCallback

public Operation addCallback(String key,
                             Callback callback)

getDeprecated

public Boolean getDeprecated()

returns the deprecated property from a Operation instance.

Returns:

Boolean deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

deprecated

public Operation deprecated(Boolean deprecated)

getSecurity

public List<SecurityRequirement> getSecurity()

returns the security property from a Operation instance.

Returns:

List<SecurityRequirement> security

setSecurity

public void setSecurity(List<SecurityRequirement> security)

security

public Operation security(List<SecurityRequirement> security)

addSecurityItem

public Operation addSecurityItem(SecurityRequirement securityItem)

getServers

public List<Server> getServers()

returns the servers property from a Operation instance.

Returns:

List<Server> servers

setServers

public void setServers(List<Server> servers)

servers

public Operation servers(List<Server> servers)

addServersItem

public Operation addServersItem(Server serversItem)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public Operation extensions(Map<String,Object> extensions)

toString

public String toString()

Overrides:

toString in class Object