Class Operation
- java.lang.Object
-
- io.vertx.rxjava3.openapi.contract.Operation
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Operation extends Object implements io.vertx.lang.rx.RxDelegate
This interface represents the most important attributes of an OpenAPI Operation.
Operation V3.1
Operation V3.0NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Operation>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetAbsoluteOpenAPIPath()ResponsegetDefaultResponse()OperationgetDelegate()HttpMethodgetHttpMethod()StringgetOpenAPIPath()StringgetOperationId()List<Parameter>getParameters()RequestBodygetRequestBody()ResponsegetResponse(int responseCode)Returns the response to the passed response code or null.List<SecurityRequirement>getSecurityRequirements()Returns the applicable list of security requirements (scopes) or empty list.List<String>getTags()inthashCode()static OperationnewInstance(Operation arg)StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<Operation> __TYPE_ARG
-
-
Method Detail
-
getDelegate
public Operation getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
getOperationId
public String getOperationId()
- Returns:
- operationId of this operation
-
getHttpMethod
public HttpMethod getHttpMethod()
- Returns:
- http method of this operation
-
getOpenAPIPath
public String getOpenAPIPath()
- Returns:
- path in OpenAPI style
-
getAbsoluteOpenAPIPath
public String getAbsoluteOpenAPIPath()
- Returns:
- absolute path in OpenAPI style
-
getRequestBody
public RequestBody getRequestBody()
- Returns:
- request body of the operation, or null if no request body is defined
-
getDefaultResponse
public Response getDefaultResponse()
- Returns:
- the default response, or null if no default response is defined.
-
getResponse
public Response getResponse(int responseCode)
Returns the response to the passed response code or null.- Parameters:
responseCode- The related response code- Returns:
- The related response, or null.
-
getSecurityRequirements
public List<SecurityRequirement> getSecurityRequirements()
Returns the applicable list of security requirements (scopes) or empty list.- Returns:
- The related security requirement.
-
-