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 and Description
static class	PathItem.Builder

Method Summary

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

builder

public static PathItem.Builder builder()

getSummary

public java.util.Optional<java.lang.String> getSummary()

getDescription

public java.util.Optional<java.lang.String> getDescription()

getServers

public java.util.List<ServerObject> getServers()

getParameters

public java.util.List<Ref<ParameterObject>> getParameters()

getGet

public java.util.Optional<OperationObject> getGet()

getPut

public java.util.Optional<OperationObject> getPut()

getPost

public java.util.Optional<OperationObject> getPost()

getDelete

public java.util.Optional<OperationObject> getDelete()

getOptions

public java.util.Optional<OperationObject> getOptions()

getHead

public java.util.Optional<OperationObject> getHead()

getPatch

public java.util.Optional<OperationObject> getPatch()

getTrace

public java.util.Optional<OperationObject> getTrace()

getOperations

public java.util.Map<java.lang.String,OperationObject> getOperations()

operations

public java.util.stream.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