software.amazon.smithy.openapi.model

Class OperationObject.Builder

java.lang.Object

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

software.amazon.smithy.openapi.model.OperationObject.Builder

All Implemented Interfaces:

SmithyBuilder<OperationObject>

Enclosing class:

OperationObject

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

Method Summary

Modifier and Type	Method and Description
OperationObject.Builder	addParameter(ParameterObject parameter)
OperationObject.Builder	addSecurity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> security)
OperationObject.Builder	addServer(ServerObject server)
OperationObject.Builder	addTag(java.lang.String tag)
OperationObject	build() Creates an immutable object that is created from the properties that have been set on the builder.
OperationObject.Builder	callbacks(java.util.Map<java.lang.String,CallbackObject> callbacks)
OperationObject.Builder	deprecated(boolean deprecated)
OperationObject.Builder	description(java.lang.String description)
OperationObject.Builder	externalDocs(ExternalDocumentation externalDocs)
OperationObject.Builder	operationId(java.lang.String operationId)
OperationObject.Builder	parameters(java.util.Collection<ParameterObject> parameters)
OperationObject.Builder	putCallback(java.lang.String expression, CallbackObject callback)
OperationObject.Builder	putResponse(java.lang.String statusCode, ResponseObject response)
OperationObject.Builder	requestBody(RequestBodyObject requestBody)
OperationObject.Builder	responses(java.util.Map<java.lang.String,ResponseObject> responses)
OperationObject.Builder	security(java.util.Collection<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> security)
OperationObject.Builder	servers(java.util.Collection<ServerObject> servers)
OperationObject.Builder	summary(java.lang.String summary)
OperationObject.Builder	tags(java.util.Collection<java.lang.String> tags)

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

Methods inherited from interface software.amazon.smithy.utils.SmithyBuilder

requiredState

Method Detail

build

public OperationObject 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

tags

public OperationObject.Builder tags(java.util.Collection<java.lang.String> tags)

addTag

public OperationObject.Builder addTag(java.lang.String tag)

summary

public OperationObject.Builder summary(java.lang.String summary)

description

public OperationObject.Builder description(java.lang.String description)

externalDocs

public OperationObject.Builder externalDocs(ExternalDocumentation externalDocs)

operationId

public OperationObject.Builder operationId(java.lang.String operationId)

parameters

public OperationObject.Builder parameters(java.util.Collection<ParameterObject> parameters)

addParameter

public OperationObject.Builder addParameter(ParameterObject parameter)

requestBody

public OperationObject.Builder requestBody(RequestBodyObject requestBody)

responses

public OperationObject.Builder responses(java.util.Map<java.lang.String,ResponseObject> responses)

putResponse

public OperationObject.Builder putResponse(java.lang.String statusCode,
                                           ResponseObject response)

callbacks

public OperationObject.Builder callbacks(java.util.Map<java.lang.String,CallbackObject> callbacks)

putCallback

public OperationObject.Builder putCallback(java.lang.String expression,
                                           CallbackObject callback)

deprecated

public OperationObject.Builder deprecated(boolean deprecated)

security

public OperationObject.Builder security(java.util.Collection<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> security)

addSecurity

public OperationObject.Builder addSecurity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> security)

servers

public OperationObject.Builder servers(java.util.Collection<ServerObject> servers)

addServer

public OperationObject.Builder addServer(ServerObject server)