Package io.swagger.v3.oas.models.responses

Class ApiResponse

java.lang.Object

io.swagger.v3.oas.models.responses.ApiResponse

public class ApiResponse
extends Object

ApiResponse

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#responseObject", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#responseObject"

Constructor Summary

Constructors

Constructor	Description
ApiResponse()

Method Summary

Modifier and Type	Method	Description
ApiResponse	$ref(String $ref)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
ApiResponse	addHeaderObject(String name, Header header)
ApiResponse	addLink(String name, Link link)
ApiResponse	content(Content content)
ApiResponse	description(String description)
boolean	equals(Object o)
ApiResponse	extensions(Map<String,Object> extensions)
String	get$ref()	returns the $ref property from an ApiResponse instance.
Content	getContent()	returns the content property from a ApiResponse instance.
String	getDescription()	returns the description property from a ApiResponse instance.
Map<String,Object>	getExtensions()
Map<String,Header>	getHeaders()	returns the headers property from a ApiResponse instance.
Map<String,Link>	getLinks()	returns the links property from a ApiResponse instance.
int	hashCode()
ApiResponse	headers(Map<String,Header> headers)
ApiResponse	link(String name, Link link)
ApiResponse	links(Map<String,Link> links)
void	set$ref(String $ref)
void	setContent(Content content)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setHeaders(Map<String,Header> headers)
void	setLinks(Map<String,Link> links)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiResponse

public ApiResponse()

Method Detail

getDescription

public String getDescription()

returns the description property from a ApiResponse instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public ApiResponse description(String description)

getHeaders

public Map<String,Header> getHeaders()

returns the headers property from a ApiResponse instance.

Returns:

headers

setHeaders

public void setHeaders(Map<String,Header> headers)

headers

public ApiResponse headers(Map<String,Header> headers)

addHeaderObject

public ApiResponse addHeaderObject(String name,
                                   Header header)

getContent

public Content getContent()

returns the content property from a ApiResponse instance.

Returns:

Content content

setContent

public void setContent(Content content)

content

public ApiResponse content(Content content)

getLinks

public Map<String,Link> getLinks()

returns the links property from a ApiResponse instance.

Returns:

Link links

setLinks

public void setLinks(Map<String,Link> links)

links

public ApiResponse links(Map<String,Link> links)

addLink

public ApiResponse addLink(String name,
                           Link link)

link

public ApiResponse link(String name,
                        Link link)

get$ref

public String get$ref()

returns the $ref property from an ApiResponse instance.

Returns:

String $ref

set$ref

public void set$ref(String $ref)

$ref

public ApiResponse $ref(String $ref)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public ApiResponse extensions(Map<String,Object> extensions)

toString

public String toString()

Overrides:

toString in class Object