All Implemented Interfaces:


public final class Operation

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Set<Parameter>`	`securityParameters`
`private final List<HttpRequestSchema>`	`requestSchemas`
`private final ObjectType`	`multipartFormDataRequestBody`
`private final HttpRequestSchema`	`requestSchema`
`private final DataSchema`	`requestBodySchema`
`private final Boolean`	`hasManyRequestSchemas`
`private final String`	`description`
`private final HttpResponse`	`defaultResponse`
`private final HttpResponse`	`successResponse`
`private final List<HttpResponse>`	`successResponses`
`private final DataSchema`	`successResponseSchema`
`private final Collection<String>`	`successResponseHeaders`
`private final Collection<HttpResponse>`	`errorResponses`
`private final Boolean`	`isMultipart`
`private final Boolean`	`isConsumeJson`
`private final List<String>`	`consumes`
`private final List<String>`	`produces`
`private final RestApi`	`api`
`private String`	`group`
`private String`	`code`
`private String`	`path`
`private HttpMethod`	`method`
`private HttpRequestBody`	`requestBody`
`private final List<Parameter>`	`parameters`
`private final List<HttpResponse>`	`responses`
`private final List<SecurityConstraint>`	`security`
`private final Map<String, Object>`	`additives`

Constructor Summary

Constructors
Constructor	Description
`Operation(RestApi api, String group, String code, String path, HttpMethod method)`
`Operation(RestApi api, String group, String code, String path, HttpMethod method, HttpRequestBody requestBody, List<Parameter> parameters, List<HttpResponse> responses, List<SecurityConstraint> security, Map<String, Object> additives)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Set<Parameter>`	`getSecurityParameters()`
`final List<HttpRequestSchema>`	`getRequestSchemas()`
`final ObjectType`	`getMultipartFormDataRequestBody()`
`final HttpRequestSchema`	`getRequestSchema()`
`final DataSchema`	`getRequestBodySchema()`
`final Boolean`	`hasManyRequestSchemas()`
`final String`	`getDescription()`
`final HttpResponse`	`getDefaultResponse()`
`final HttpResponse`	`getSuccessResponse()`
`final List<HttpResponse>`	`getSuccessResponses()`
`final DataSchema`	`getSuccessResponseSchema()`
`final Collection<String>`	`getSuccessResponseHeaders()`
`final Collection<HttpResponse>`	`getErrorResponses()`
`final Boolean`	`isMultipart()`
`final Boolean`	`isConsumeJson()`
`final List<String>`	`getConsumes()`
`final List<String>`	`getProduces()`
`final RestApi`	`getApi()`
`final String`	`getGroup()`
`final Unit`	`setGroup(String group)`
`final String`	`getCode()`
`final Unit`	`setCode(String code)`
`final String`	`getPath()`
`final Unit`	`setPath(String path)`
`final HttpMethod`	`getMethod()`
`final Unit`	`setMethod(HttpMethod method)`
`final HttpRequestBody`	`getRequestBody()`
`final Unit`	`setRequestBody(HttpRequestBody requestBody)`
`final List<Parameter>`	`getParameters()`
`final List<HttpResponse>`	`getResponses()`
`final List<SecurityConstraint>`	`getSecurity()`
`final Map<String, Object>`	`getAdditives()`
`String`	`toString()`
`final Boolean`	`isBodySchema(DataSchema schema)`
`final List<Parameter>`	`getParameters(ParamLocation location)`
`final SecurityConstraint`	`getSecurity(Parameter parameter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operation

Operation(RestApi api, String group, String code, String path, HttpMethod method)

Operation

Operation(RestApi api, String group, String code, String path, HttpMethod method, HttpRequestBody requestBody, List<Parameter> parameters, List<HttpResponse> responses, List<SecurityConstraint> security, Map<String, Object> additives)

Method Detail

getSecurityParameters

 final Set<Parameter> getSecurityParameters()

getRequestSchemas

 final List<HttpRequestSchema> getRequestSchemas()

getMultipartFormDataRequestBody

 final ObjectType getMultipartFormDataRequestBody()

getRequestSchema

 final HttpRequestSchema getRequestSchema()

getRequestBodySchema

 final DataSchema getRequestBodySchema()

hasManyRequestSchemas
```
 final Boolean hasManyRequestSchemas()
```

getDescription
```
 final String getDescription()
```

getDefaultResponse

 final HttpResponse getDefaultResponse()

getSuccessResponse

 final HttpResponse getSuccessResponse()

getSuccessResponses

 final List<HttpResponse> getSuccessResponses()

getSuccessResponseSchema

 final DataSchema getSuccessResponseSchema()

getSuccessResponseHeaders

 final Collection<String> getSuccessResponseHeaders()

getErrorResponses

 final Collection<HttpResponse> getErrorResponses()

isMultipart
```
 final Boolean isMultipart()
```

isConsumeJson
```
 final Boolean isConsumeJson()
```

getConsumes
```
 final List<String> getConsumes()
```

getProduces
```
 final List<String> getProduces()
```

getApi
```
 final RestApi getApi()
```

getGroup
```
 final String getGroup()
```

setGroup
```
 final Unit setGroup(String group)
```

getCode
```
 final String getCode()
```

setCode
```
 final Unit setCode(String code)
```

getPath
```
 final String getPath()
```

setPath
```
 final Unit setPath(String path)
```

getMethod
```
 final HttpMethod getMethod()
```

setMethod

 final Unit setMethod(HttpMethod method)

getRequestBody
```
 final HttpRequestBody getRequestBody()
```

setRequestBody

 final Unit setRequestBody(HttpRequestBody requestBody)

getParameters
```
 final List<Parameter> getParameters()
```

getResponses

 final List<HttpResponse> getResponses()

getSecurity

 final List<SecurityConstraint> getSecurity()

getAdditives

 final Map<String, Object> getAdditives()

toString
```
 String toString()
```

isBodySchema

 final Boolean isBodySchema(DataSchema schema)

getParameters

 final List<Parameter> getParameters(ParamLocation location)

getSecurity

 final SecurityConstraint getSecurity(Parameter parameter)

Class Operation

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Operation

Operation

Method Detail

getSecurityParameters

getRequestSchemas

getMultipartFormDataRequestBody

getRequestSchema

getRequestBodySchema

hasManyRequestSchemas

getDescription

getDefaultResponse

getSuccessResponse

getSuccessResponses

getSuccessResponseSchema

getSuccessResponseHeaders

getErrorResponses

isMultipart

isConsumeJson

getConsumes

getProduces

getApi

getGroup

setGroup

getCode

setCode

getPath

setPath

getMethod

setMethod

getRequestBody

setRequestBody

getParameters

getResponses

getSecurity

getAdditives

toString

isBodySchema

getParameters

getSecurity