Package software.amazon.smithy.openapi.model

Class PathItem.Builder

java.lang.Object

software.amazon.smithy.openapi.model.Component.Builder<PathItem.Builder,PathItem>

software.amazon.smithy.openapi.model.PathItem.Builder

All Implemented Interfaces:

SmithyBuilder<PathItem>

Enclosing class:

PathItem

public static final class PathItem.Builder
extends Component.Builder<PathItem.Builder,PathItem>

Method Summary

Modifier and Type	Method	Description
PathItem.Builder	addParameter(ParameterObject parameter)
PathItem.Builder	addParameter(Ref<ParameterObject> parameter)
PathItem.Builder	addServer(ServerObject server)
PathItem	build()	Creates an immutable object that is created from the properties that have been set on the builder.
PathItem.Builder	delete(OperationObject delete)
PathItem.Builder	description(String description)
PathItem.Builder	get(OperationObject get)
PathItem.Builder	head(OperationObject head)
PathItem.Builder	options(OperationObject options)
PathItem.Builder	parameters(List<Ref<ParameterObject>> parameters)
PathItem.Builder	patch(OperationObject patch)
PathItem.Builder	post(OperationObject post)
PathItem.Builder	put(OperationObject put)
PathItem.Builder	servers(List<ServerObject> servers)
PathItem.Builder	summary(String summary)
PathItem.Builder	trace(OperationObject trace)

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

extensions, extensions, getExtensions, putExtension, putExtension, putExtension, putExtension, removeExtension

Methods inherited from class java.lang.Object

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

Method Details

build

public PathItem build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Returns:

an instance of T

summary

public PathItem.Builder summary(String summary)

description

public PathItem.Builder description(String description)

servers

public PathItem.Builder servers(List<ServerObject> servers)

addServer

public PathItem.Builder addServer(ServerObject server)

parameters

public PathItem.Builder parameters(List<Ref<ParameterObject>> parameters)

addParameter

public PathItem.Builder addParameter(ParameterObject parameter)

addParameter

public PathItem.Builder addParameter(Ref<ParameterObject> parameter)

get

public PathItem.Builder get(OperationObject get)

put

public PathItem.Builder put(OperationObject put)

post

public PathItem.Builder post(OperationObject post)

delete

public PathItem.Builder delete(OperationObject delete)

options

public PathItem.Builder options(OperationObject options)

head

public PathItem.Builder head(OperationObject head)

patch

public PathItem.Builder patch(OperationObject patch)

trace

public PathItem.Builder trace(OperationObject trace)