springfox.documentation.service

Class Operation

java.lang.Object

springfox.documentation.service.Operation

public class Operation
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

Operation(org.springframework.http.HttpMethod method, java.lang.String summary, java.lang.String notes, ModelReference responseModel, java.lang.String uniqueId, int position, java.util.Set<java.lang.String> tags, java.util.Set<java.lang.String> produces, java.util.Set<java.lang.String> consumes, java.util.Set<java.lang.String> protocol, java.util.List<SecurityReference> securityReferences, java.util.List<Parameter> parameters, java.util.Set<ResponseMessage> responseMessages, java.lang.String deprecated, boolean isHidden, java.util.Collection<VendorExtension> vendorExtensions)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getConsumes()
java.lang.String	getDeprecated()
org.springframework.http.HttpMethod	getMethod()
java.lang.String	getNotes()
java.util.List<Parameter>	getParameters()
int	getPosition()
java.util.Set<java.lang.String>	getProduces()
java.util.Set<java.lang.String>	getProtocol()
java.util.Set<ResponseMessage>	getResponseMessages()
ModelReference	getResponseModel()
java.util.Map<java.lang.String,java.util.List<AuthorizationScope>>	getSecurityReferences()
java.lang.String	getSummary()
java.util.Set<java.lang.String>	getTags()
java.lang.String	getUniqueId()
java.util.List<VendorExtension>	getVendorExtensions()
boolean	isHidden()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operation

public Operation(org.springframework.http.HttpMethod method,
         java.lang.String summary,
         java.lang.String notes,
         ModelReference responseModel,
         java.lang.String uniqueId,
         int position,
         java.util.Set<java.lang.String> tags,
         java.util.Set<java.lang.String> produces,
         java.util.Set<java.lang.String> consumes,
         java.util.Set<java.lang.String> protocol,
         java.util.List<SecurityReference> securityReferences,
         java.util.List<Parameter> parameters,
         java.util.Set<ResponseMessage> responseMessages,
         java.lang.String deprecated,
         boolean isHidden,
         java.util.Collection<VendorExtension> vendorExtensions)

Method Detail

isHidden

public boolean isHidden()

getResponseModel

public ModelReference getResponseModel()

getTags

public java.util.Set<java.lang.String> getTags()

getMethod

public org.springframework.http.HttpMethod getMethod()

getSummary

public java.lang.String getSummary()

getNotes

public java.lang.String getNotes()

getUniqueId

public java.lang.String getUniqueId()

getPosition

public int getPosition()

getProduces

public java.util.Set<java.lang.String> getProduces()

getConsumes

public java.util.Set<java.lang.String> getConsumes()

getProtocol

public java.util.Set<java.lang.String> getProtocol()

getSecurityReferences

public java.util.Map<java.lang.String,java.util.List<AuthorizationScope>> getSecurityReferences()

getParameters

public java.util.List<Parameter> getParameters()

getResponseMessages

public java.util.Set<ResponseMessage> getResponseMessages()

getDeprecated

public java.lang.String getDeprecated()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()