ResponseObject (Smithy API 1.47.0)

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 class ResponseObject.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ResponseObject.Builder`	`builder()`
`protected ObjectNode.Builder`	`createNodeBuilder()`
`java.util.Map<java.lang.String,MediaTypeObject>`	`getContent()`
`java.lang.String`	`getDescription()`
`java.util.Optional<Ref<ParameterObject>>`	`getHeader(java.lang.String header)`	Gets a header by case-insensitive header name.
`java.util.Map<java.lang.String,Ref<ParameterObject>>`	`getHeaders()`
`java.util.Map<java.lang.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 Detail
  - builder
```
public static ResponseObject.Builder builder()
```
  - getDescription
```
public java.lang.String getDescription()
```
  - getHeader
```
public java.util.Optional<Ref<ParameterObject>> getHeader(java.lang.String header)
```
    Gets a header by case-insensitive header name.
    
    Parameters:
    
    header - Header to retrieve.
    
    Returns:
    
    Returns the optionally found header.
  - getHeaders
```
public java.util.Map<java.lang.String,Ref<ParameterObject>> getHeaders()
```
  - getContent
```
public java.util.Map<java.lang.String,MediaTypeObject> getContent()
```
  - getLinks
```
public java.util.Map<java.lang.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