Interface Operation
-
- All Superinterfaces:
Constructible
,Extensible
public interface Operation extends Constructible, Extensible
OperationDescribes a single API operation on a path.
- See Also:
- OpenAPI Specification Operation Object
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Operation
addParameter(Parameter parameter)
Adds the given parameter item to this Operation's list of parameters.Operation
addSecurityRequirement(SecurityRequirement securityRequirement)
Adds the given security requirement item to this Operation's list of security mechanisms.Operation
addServer(Server server)
Adds the given server to this Operation's list of servers.Operation
addTag(java.lang.String tag)
Adds the given tag to this Operation's list of tags.Operation
callbacks(java.util.Map<java.lang.String,Callback> callbacks)
Sets this Operation's callbacks property to the given map.Operation
deprecated(java.lang.Boolean deprecated)
Sets this Operation's deprecated property to the given value.Operation
description(java.lang.String description)
Sets this Operation's description property to the given string.Operation
externalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.java.util.Map<java.lang.String,Callback>
getCallbacks()
Returns the callbacks property from an Operation instance.java.lang.Boolean
getDeprecated()
Returns the deprecated property from an Operation instance.java.lang.String
getDescription()
Returns the description property from an Operation instance.ExternalDocumentation
getExternalDocs()
Returns the externalDocs property from an Operation instance.java.lang.String
getOperationId()
Returns the operationId property from an Operation instance.java.util.List<Parameter>
getParameters()
Returns the parameters property from an Operation instance.RequestBody
getRequestBody()
Returns the requestBody property from an Operation instance.APIResponses
getResponses()
Returns the responses property from an Operation instance.java.util.List<SecurityRequirement>
getSecurity()
Returns the security property from an Operation instance.java.util.List<Server>
getServers()
Returns the servers property from an Operation instance.java.lang.String
getSummary()
Returns the summary property from an Operation instance.java.util.List<java.lang.String>
getTags()
Returns the tags property from an Operation instance.Operation
operationId(java.lang.String operationId)
Sets this Operation's operationId property to the given string.Operation
parameters(java.util.List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.Operation
requestBody(RequestBody requestBody)
Sets this Operation's requestBody property to the given object.Operation
responses(APIResponses responses)
Sets this Operation's responses property to the given responses.Operation
security(java.util.List<SecurityRequirement> security)
Sets this Operation's security property to the given list.Operation
servers(java.util.List<Server> servers)
Sets this Operation's servers property to the given list.void
setCallbacks(java.util.Map<java.lang.String,Callback> callbacks)
Sets this Operation's callbacks property to the given map.void
setDeprecated(java.lang.Boolean deprecated)
Sets this Operation's deprecated property to the given value.void
setDescription(java.lang.String description)
Sets this Operation's description property to the given string.void
setExternalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.void
setOperationId(java.lang.String operationId)
Sets this Operation's operationId property to the given string.void
setParameters(java.util.List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.void
setRequestBody(RequestBody requestBody)
Sets this Operation's requestBody property to the given object.void
setResponses(APIResponses responses)
Sets this Operation's responses property to the given responses.void
setSecurity(java.util.List<SecurityRequirement> security)
Sets this Operation's security property to the given list.void
setServers(java.util.List<Server> servers)
Sets this Operation's servers property to the given list.void
setSummary(java.lang.String summary)
Sets this Operation's summary property to the given string.void
setTags(java.util.List<java.lang.String> tags)
Sets this Operation's tags property to the given tags.Operation
summary(java.lang.String summary)
Sets this Operation's summary property to the given string.Operation
tags(java.util.List<java.lang.String> tags)
Sets this Operation's tags property to the given tags.-
Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, getExtensions, setExtensions
-
-
-
-
Method Detail
-
getTags
java.util.List<java.lang.String> getTags()
Returns the tags property from an Operation instance.- Returns:
- a list of the operation's tags
-
setTags
void setTags(java.util.List<java.lang.String> tags)
Sets this Operation's tags property to the given tags.- Parameters:
tags
- a list of tags for API documentation control
-
tags
Operation tags(java.util.List<java.lang.String> tags)
Sets this Operation's tags property to the given tags.- Parameters:
tags
- a list of tags for API documentation control- Returns:
- the current Operation object
-
addTag
Operation addTag(java.lang.String tag)
Adds the given tag to this Operation's list of tags.- Parameters:
tag
- a tag for API documentation control- Returns:
- the current Operation object
-
getSummary
java.lang.String getSummary()
Returns the summary property from an Operation instance.- Returns:
- a short summary of what the operation does
-
setSummary
void setSummary(java.lang.String summary)
Sets this Operation's summary property to the given string.- Parameters:
summary
- a short summary of what the operation does
-
summary
Operation summary(java.lang.String summary)
Sets this Operation's summary property to the given string.- Parameters:
summary
- a short summary of what the operation does- Returns:
- the current Operation object
-
getDescription
java.lang.String getDescription()
Returns the description property from an Operation instance.- Returns:
- a verbose explanation of the operation behavior
-
setDescription
void setDescription(java.lang.String description)
Sets this Operation's description property to the given string.- Parameters:
description
- a verbose explanation of the operation behavior
-
description
Operation description(java.lang.String description)
Sets this Operation's description property to the given string.- Parameters:
description
- a verbose explanation of the operation behavior- Returns:
- the current Operation object
-
getExternalDocs
ExternalDocumentation getExternalDocs()
Returns the externalDocs property from an Operation instance.- Returns:
- additional external documentation for this operation
-
setExternalDocs
void setExternalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.- Parameters:
externalDocs
- additional external documentation for this operation
-
externalDocs
Operation externalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.- Parameters:
externalDocs
- additional external documentation for this operation- Returns:
- the current Operation object
-
getOperationId
java.lang.String getOperationId()
Returns the operationId property from an Operation instance.- Returns:
- unique string used to identify the operation
-
setOperationId
void setOperationId(java.lang.String operationId)
Sets this Operation's operationId property to the given string.- Parameters:
operationId
- unique string used to identify the operation
-
operationId
Operation operationId(java.lang.String operationId)
Sets this Operation's operationId property to the given string.- Parameters:
operationId
- unique string used to identify the operation- Returns:
- the current Operation object
-
getParameters
java.util.List<Parameter> getParameters()
Returns the parameters property from an Operation instance.- Returns:
- a list of parameters that are applicable for this operation
-
setParameters
void setParameters(java.util.List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.- Parameters:
parameters
- a list of parameters that are applicable for this operation
-
parameters
Operation parameters(java.util.List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.- Parameters:
parameters
- a list of parameters that are applicable for this operation- Returns:
- the current Operation object
-
addParameter
Operation addParameter(Parameter parameter)
Adds the given parameter item to this Operation's list of parameters.- Parameters:
parameter
- a parameter that is applicable for this operation- Returns:
- the current Operation object
-
getRequestBody
RequestBody getRequestBody()
Returns the requestBody property from an Operation instance.- Returns:
- the request body applicable for this operation
-
setRequestBody
void setRequestBody(RequestBody requestBody)
Sets this Operation's requestBody property to the given object.- Parameters:
requestBody
- the request body applicable for this operation
-
requestBody
Operation requestBody(RequestBody requestBody)
Sets this Operation's requestBody property to the given object.- Parameters:
requestBody
- the request body applicable for this operation- Returns:
- the current Operation object
-
getResponses
APIResponses getResponses()
Returns the responses property from an Operation instance.- Returns:
- collection of possible responses from executing this operation
-
setResponses
void setResponses(APIResponses responses)
Sets this Operation's responses property to the given responses.- Parameters:
responses
- collection of possible responses from executing this operation
-
responses
Operation responses(APIResponses responses)
Sets this Operation's responses property to the given responses.- Parameters:
responses
- collection of possible responses from executing this operation- Returns:
- the current Operation object
-
getCallbacks
java.util.Map<java.lang.String,Callback> getCallbacks()
Returns the callbacks property from an Operation instance.- Returns:
- map of possible out-of-band callbacks related to the operation
-
setCallbacks
void setCallbacks(java.util.Map<java.lang.String,Callback> callbacks)
Sets this Operation's callbacks property to the given map.- Parameters:
callbacks
- map of possible out-of-band callbacks related to the operation. The key value must be the correct format for this field.
-
callbacks
Operation callbacks(java.util.Map<java.lang.String,Callback> callbacks)
Sets this Operation's callbacks property to the given map.- Parameters:
callbacks
- map of possible out-of-band callbacks related to the operation. The key value must be the correct format for this field.- Returns:
- the current Operation object
-
getDeprecated
java.lang.Boolean getDeprecated()
Returns the deprecated property from an Operation instance.- Returns:
- declaration whether this operation is deprecated
-
setDeprecated
void setDeprecated(java.lang.Boolean deprecated)
Sets this Operation's deprecated property to the given value.- Parameters:
deprecated
- declaration whether this operation is deprecated
-
deprecated
Operation deprecated(java.lang.Boolean deprecated)
Sets this Operation's deprecated property to the given value.- Parameters:
deprecated
- declaration whether this operation is deprecated- Returns:
- the current Operation object
-
getSecurity
java.util.List<SecurityRequirement> getSecurity()
Returns the security property from an Operation instance.- Returns:
- a list of which security mechanisms can be used for this operation
-
setSecurity
void setSecurity(java.util.List<SecurityRequirement> security)
Sets this Operation's security property to the given list.- Parameters:
security
- list of which security mechanisms can be used for this operation
-
security
Operation security(java.util.List<SecurityRequirement> security)
Sets this Operation's security property to the given list.- Parameters:
security
- list of which security mechanisms can be used for this operation- Returns:
- the current Operation object
-
addSecurityRequirement
Operation addSecurityRequirement(SecurityRequirement securityRequirement)
Adds the given security requirement item to this Operation's list of security mechanisms.- Parameters:
securityRequirement
- security mechanism which can be used for this operation- Returns:
- the current Operation object
-
getServers
java.util.List<Server> getServers()
Returns the servers property from an Operation instance.- Returns:
- a list of servers to service this operation
-
setServers
void setServers(java.util.List<Server> servers)
Sets this Operation's servers property to the given list.- Parameters:
servers
- list of servers to service this operation
-
servers
Operation servers(java.util.List<Server> servers)
Sets this Operation's servers property to the given list.- Parameters:
servers
- list of servers to service this operation- Returns:
- the current Operation object
-
-