Package software.amazon.smithy.openapi.model

Class OperationObject

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.OperationObject

All Implemented Interfaces:

ToNode, ToSmithyBuilder<OperationObject>

public final class OperationObject
extends Component
implements ToSmithyBuilder<OperationObject>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OperationObject.Builder

Method Summary

Modifier and Type	Method	Description
static OperationObject.Builder	builder()
protected ObjectNode.Builder	createNodeBuilder()
Map<String,CallbackObject>	getCallbacks()
Optional<String>	getDescription()
Optional<ExternalDocumentation>	getExternalDocs()
Optional<String>	getOperationId()
List<ParameterObject>	getParameters()
Optional<RequestBodyObject>	getRequestBody()
Map<String,ResponseObject>	getResponses()
Optional<List<Map<String,List<String>>>>	getSecurity()
List<ServerObject>	getServers()
Optional<String>	getSummary()
List<String>	getTags()
boolean	isDeprecated()
OperationObject.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.openapi.model.Component

equals, getExtension, getExtensions, hashCode, toNode

Methods inherited from class java.lang.Object

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

Method Details

builder

public static OperationObject.Builder builder()

getTags

public List<String> getTags()

getSummary

public Optional<String> getSummary()

getDescription

public Optional<String> getDescription()

getExternalDocs

public Optional<ExternalDocumentation> getExternalDocs()

getOperationId

public Optional<String> getOperationId()

getParameters

public List<ParameterObject> getParameters()

getRequestBody

public Optional<RequestBodyObject> getRequestBody()

getResponses

public Map<String,ResponseObject> getResponses()

getCallbacks

public Map<String,CallbackObject> getCallbacks()

isDeprecated

public boolean isDeprecated()

getSecurity

public Optional<List<Map<String,List<String>>>> getSecurity()

getServers

public List<ServerObject> getServers()

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component

toBuilder

public OperationObject.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<OperationObject>

Returns:

a builder for type T