Package io.swagger.v3.oas.models

Class Components

java.lang.Object

io.swagger.v3.oas.models.Components

public class Components
extends Object

Components

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENTS_SCHEMAS_REF

Constructor Summary

Constructors

Constructor	Description
Components()

Method Summary

Modifier and Type	Method	Description
Components	addCallbacks(String key, Callback callbacksItem)
Components	addExamples(String key, Example examplesItem)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
Components	addHeaders(String key, Header headersItem)
Components	addLinks(String key, Link linksItem)
Components	addParameters(String key, Parameter parametersItem)
Components	addPathItem(String key, PathItem pathItem)
Components	addRequestBodies(String key, RequestBody requestBodiesItem)
Components	addResponses(String key, ApiResponse responsesItem)
Components	addSchemas(String key, Schema schemasItem)
Components	addSecuritySchemes(String key, SecurityScheme securitySchemesItem)
Components	callbacks(Map<String,Callback> callbacks)
boolean	equals(Object o)
Components	examples(Map<String,Example> examples)
Components	extensions(Map<String,Object> extensions)
Map<String,Callback>	getCallbacks()	returns the callbacks property from a Components instance.
Map<String,Example>	getExamples()	returns the examples property from a Components instance.
Map<String,Object>	getExtensions()
Map<String,Header>	getHeaders()	returns the headers property from a Components instance.
Map<String,Link>	getLinks()	returns the links property from a Components instance.
Map<String,Parameter>	getParameters()	returns the parameters property from a Components instance.
Map<String,PathItem>	getPathItems()	returns the path items property from a Components instance.
Map<String,RequestBody>	getRequestBodies()	returns the requestBodies property from a Components instance.
Map<String,ApiResponse>	getResponses()	returns the responses property from a Components instance.
Map<String,Schema>	getSchemas()	returns the schemas property from a Components instance.
Map<String,SecurityScheme>	getSecuritySchemes()	returns the securitySchemes property from a Components instance.
int	hashCode()
Components	headers(Map<String,Header> headers)
Components	links(Map<String,Link> links)
Components	parameters(Map<String,Parameter> parameters)
Components	pathItems(Map<String,PathItem> pathItems)
Components	requestBodies(Map<String,RequestBody> requestBodies)
Components	responses(Map<String,ApiResponse> responses)
Components	schemas(Map<String,Schema> schemas)
Components	securitySchemes(Map<String,SecurityScheme> securitySchemes)
void	setCallbacks(Map<String,Callback> callbacks)
void	setExamples(Map<String,Example> examples)
void	setExtensions(Map<String,Object> extensions)
void	setHeaders(Map<String,Header> headers)
void	setLinks(Map<String,Link> links)
void	setParameters(Map<String,Parameter> parameters)
void	setPathItems(Map<String,PathItem> pathItems)
void	setRequestBodies(Map<String,RequestBody> requestBodies)
void	setResponses(Map<String,ApiResponse> responses)
void	setSchemas(Map<String,Schema> schemas)
void	setSecuritySchemes(Map<String,SecurityScheme> securitySchemes)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENTS_SCHEMAS_REF

public static final String COMPONENTS_SCHEMAS_REF

Since:

2.1.6

See Also:

Constant Field Values

Constructor Detail

Components

public Components()

Method Detail

getSchemas

public Map<String,Schema> getSchemas()

returns the schemas property from a Components instance.

Returns:

Map<String, Schema> schemas

setSchemas

public void setSchemas(Map<String,Schema> schemas)

schemas

public Components schemas(Map<String,Schema> schemas)

addSchemas

public Components addSchemas(String key,
                             Schema schemasItem)

getResponses

public Map<String,ApiResponse> getResponses()

returns the responses property from a Components instance.

Returns:

Map<String, ApiResponse> responses

setResponses

public void setResponses(Map<String,ApiResponse> responses)

responses

public Components responses(Map<String,ApiResponse> responses)

addResponses

public Components addResponses(String key,
                               ApiResponse responsesItem)

getParameters

public Map<String,Parameter> getParameters()

returns the parameters property from a Components instance.

Returns:

Map<String, Parameter> parameters

setParameters

public void setParameters(Map<String,Parameter> parameters)

parameters

public Components parameters(Map<String,Parameter> parameters)

addParameters

public Components addParameters(String key,
                                Parameter parametersItem)

getExamples

public Map<String,Example> getExamples()

returns the examples property from a Components instance.

Returns:

Map<String, Example> examples

setExamples

public void setExamples(Map<String,Example> examples)

examples

public Components examples(Map<String,Example> examples)

addExamples

public Components addExamples(String key,
                              Example examplesItem)

getRequestBodies

public Map<String,RequestBody> getRequestBodies()

returns the requestBodies property from a Components instance.

Returns:

Map<String, RequestBody> requestBodies

setRequestBodies

public void setRequestBodies(Map<String,RequestBody> requestBodies)

requestBodies

public Components requestBodies(Map<String,RequestBody> requestBodies)

addRequestBodies

public Components addRequestBodies(String key,
                                   RequestBody requestBodiesItem)

getHeaders

public Map<String,Header> getHeaders()

returns the headers property from a Components instance.

Returns:

Map<String, Header> headers

setHeaders

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

headers

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

addHeaders

public Components addHeaders(String key,
                             Header headersItem)

getSecuritySchemes

public Map<String,SecurityScheme> getSecuritySchemes()

returns the securitySchemes property from a Components instance.

Returns:

Map<String, SecurityScheme> securitySchemes

setSecuritySchemes

public void setSecuritySchemes(Map<String,SecurityScheme> securitySchemes)

securitySchemes

public Components securitySchemes(Map<String,SecurityScheme> securitySchemes)

addSecuritySchemes

public Components addSecuritySchemes(String key,
                                     SecurityScheme securitySchemesItem)

getLinks

public Map<String,Link> getLinks()

returns the links property from a Components instance.

Returns:

Map<String, Link> links

setLinks

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

links

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

addLinks

public Components addLinks(String key,
                           Link linksItem)

getCallbacks

public Map<String,Callback> getCallbacks()

returns the callbacks property from a Components instance.

Returns:

Map<String, Callback> callbacks

setCallbacks

public void setCallbacks(Map<String,Callback> callbacks)

callbacks

public Components callbacks(Map<String,Callback> callbacks)

addCallbacks

public Components addCallbacks(String key,
                               Callback callbacksItem)

getPathItems

public Map<String,PathItem> getPathItems()

returns the path items property from a Components instance.

Returns:

Map<String, PathItem> pathItems

Since:

2.2.0 (OpenAPI 3.1.0)

setPathItems

public void setPathItems(Map<String,PathItem> pathItems)

pathItems

public Components pathItems(Map<String,PathItem> pathItems)

addPathItem

public Components addPathItem(String key,
                              PathItem pathItem)

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 Components extensions(Map<String,Object> extensions)

toString

public String toString()

Overrides:

toString in class Object