Package software.amazon.smithy.openapi.model

Class OpenApi.Builder

java.lang.Object

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

software.amazon.smithy.openapi.model.OpenApi.Builder

All Implemented Interfaces:

SmithyBuilder<OpenApi>

Enclosing class:

OpenApi

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

Method Summary

Modifier and Type	Method	Description
OpenApi.Builder	addSecurity(Map<String,List<String>> requirement)
OpenApi.Builder	addServer(ServerObject server)
OpenApi.Builder	addTag(TagObject tag)
OpenApi	build()	Creates an immutable object that is created from the properties that have been set on the builder.
OpenApi.Builder	clearSecurity()
OpenApi.Builder	clearServer()
OpenApi.Builder	clearTags()
OpenApi.Builder	components(ComponentsObject components)
OpenApi.Builder	externalDocs(ExternalDocumentation externalDocs)
OpenApi.Builder	info(InfoObject info)
OpenApi.Builder	openapi(String openapi)
OpenApi.Builder	paths(Map<String,PathItem> paths)
OpenApi.Builder	putPath(String path, PathItem item)
OpenApi.Builder	removePath(String path)
OpenApi.Builder	security(Collection<Map<String,List<String>>> security)

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 OpenApi 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

openapi

public OpenApi.Builder openapi(String openapi)

info

public OpenApi.Builder info(InfoObject info)

paths

public OpenApi.Builder paths(Map<String,PathItem> paths)

putPath

public OpenApi.Builder putPath(String path,
 PathItem item)

removePath

public OpenApi.Builder removePath(String path)

components

public OpenApi.Builder components(ComponentsObject components)

externalDocs

public OpenApi.Builder externalDocs(ExternalDocumentation externalDocs)

addServer

public OpenApi.Builder addServer(ServerObject server)

clearServer

public OpenApi.Builder clearServer()

addSecurity

public OpenApi.Builder addSecurity(Map<String,List<String>> requirement)

security

public OpenApi.Builder security(Collection<Map<String,List<String>>> security)

clearSecurity

public OpenApi.Builder clearSecurity()

addTag

public OpenApi.Builder addTag(TagObject tag)

clearTags

public OpenApi.Builder clearTags()