Package software.amazon.smithy.openapi.model

Class ResponseObject

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.ResponseObject

All Implemented Interfaces:

ToNode, ToSmithyBuilder<ResponseObject>

public final class ResponseObject
extends Component
implements ToSmithyBuilder<ResponseObject>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResponseObject.Builder

Method Summary

Modifier and Type	Method	Description
static ResponseObject.Builder	builder()
protected ObjectNode.Builder	createNodeBuilder()
Map<String,MediaTypeObject>	getContent()
String	getDescription()
Optional<Ref<ParameterObject>>	getHeader(String header)	Gets a header by case-insensitive header name.
Map<String,Ref<ParameterObject>>	getHeaders()
Map<String,Ref<LinkObject>>	getLinks()
ResponseObject.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 ResponseObject.Builder builder()

getDescription

public String getDescription()

getHeader

public Optional<Ref<ParameterObject>> getHeader(String header)

Gets a header by case-insensitive header name.

Parameters:

header - Header to retrieve.

Returns:

Returns the optionally found header.

getHeaders

public Map<String,Ref<ParameterObject>> getHeaders()

getContent

public Map<String,MediaTypeObject> getContent()

getLinks

public Map<String,Ref<LinkObject>> getLinks()

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component

toBuilder

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

Returns:

a builder for type T