Package software.amazon.smithy.openapi.model

Class PathItem

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.PathItem

All Implemented Interfaces:

ToNode, ToSmithyBuilder<PathItem>

public final class PathItem
extends Component
implements ToSmithyBuilder<PathItem>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PathItem.Builder

Method Summary

Modifier and Type	Method	Description
static PathItem.Builder	builder()
protected ObjectNode.Builder	createNodeBuilder()
Optional<OperationObject>	getDelete()
Optional<String>	getDescription()
Optional<OperationObject>	getGet()
Optional<OperationObject>	getHead()
Map<String,OperationObject>	getOperations()
Optional<OperationObject>	getOptions()
List<Ref<ParameterObject>>	getParameters()
Optional<OperationObject>	getPatch()
Optional<OperationObject>	getPost()
Optional<OperationObject>	getPut()
List<ServerObject>	getServers()
Optional<String>	getSummary()
Optional<OperationObject>	getTrace()
Stream<OperationObject>	operations()
PathItem.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 PathItem.Builder builder()

getSummary

public Optional<String> getSummary()

getDescription

public Optional<String> getDescription()

getServers

public List<ServerObject> getServers()

getParameters

public List<Ref<ParameterObject>> getParameters()

getGet

public Optional<OperationObject> getGet()

getPut

public Optional<OperationObject> getPut()

getPost

public Optional<OperationObject> getPost()

getDelete

public Optional<OperationObject> getDelete()

getOptions

public Optional<OperationObject> getOptions()

getHead

public Optional<OperationObject> getHead()

getPatch

public Optional<OperationObject> getPatch()

getTrace

public Optional<OperationObject> getTrace()

getOperations

public Map<String,OperationObject> getOperations()

operations

public Stream<OperationObject> operations()

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component

toBuilder

public PathItem.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<PathItem>

Returns:

a builder for type T