Package io.swagger.v3.oas.models.links

Class Link

java.lang.Object

io.swagger.v3.oas.models.links.Link

public class Link
extends Object

Link

See Also:

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

Constructor Summary

Constructors

Constructor	Description
Link()

Method Summary

Modifier and Type	Method	Description
Link	$ref(String $ref)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
Link	addHeaderObject(String name, Header header)	Deprecated. as it's not part of OpenAPI specification
Link	addParameter(String name, String parameter)
Link	description(String description)
boolean	equals(Object o)
Link	extensions(Map<String,Object> extensions)
String	get$ref()
String	getDescription()	returns the description property from a Link instance.
Map<String,Object>	getExtensions()
Map<String,Header>	getHeaders()	Deprecated. as it's not part of OpenAPI specification
String	getOperationId()
String	getOperationRef()	returns the operationRef property from a Link instance.
Map<String,String>	getParameters()	returns the parameters property from a Link instance.
Object	getRequestBody()	returns the requestBody property from a Link instance.
Server	getServer()	returns the server property from a Link instance.
int	hashCode()
Link	headers(Map<String,Header> headers)	Deprecated. as it's not part of OpenAPI specification
Link	operationId(String operationId)
Link	operationRef(String operationRef)
Link	parameters(String name, String parameter)	Deprecated.
Link	requestBody(Object requestBody)
Link	server(Server server)
void	set$ref(String $ref)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setHeaders(Map<String,Header> headers)	Deprecated. as it's not part of OpenAPI specification
void	setOperationId(String operationId)
void	setOperationRef(String operationRef)
void	setParameters(Map<String,String> parameters)
void	setRequestBody(Object requestBody)
void	setServer(Server server)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link()

Method Detail

getServer

public Server getServer()

returns the server property from a Link instance.

Returns:

Server server

setServer

public void setServer(Server server)

server

public Link server(Server server)

getOperationRef

public String getOperationRef()

returns the operationRef property from a Link instance.

Returns:

String operationRef

setOperationRef

public void setOperationRef(String operationRef)

operationRef

public Link operationRef(String operationRef)

getRequestBody

public Object getRequestBody()

returns the requestBody property from a Link instance.

Returns:

Object requestBody

setRequestBody

public void setRequestBody(Object requestBody)

requestBody

public Link requestBody(Object requestBody)

getOperationId

public String getOperationId()

setOperationId

public void setOperationId(String operationId)

operationId

public Link operationId(String operationId)

getParameters

public Map<String,String> getParameters()

returns the parameters property from a Link instance.

Returns:

LinkParameters parameters

setParameters

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

parameters

@Deprecated
public Link parameters(String name,
                       String parameter)

Deprecated.

addParameter

public Link addParameter(String name,
                         String parameter)

getHeaders

@Deprecated
public Map<String,Header> getHeaders()

Deprecated.

as it's not part of OpenAPI specification

setHeaders

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

Deprecated.

as it's not part of OpenAPI specification

headers

@Deprecated
public Link headers(Map<String,Header> headers)

Deprecated.

as it's not part of OpenAPI specification

addHeaderObject

@Deprecated
public Link addHeaderObject(String name,
                            Header header)

Deprecated.

as it's not part of OpenAPI specification

getDescription

public String getDescription()

returns the description property from a Link instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Link description(String description)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get$ref

public String get$ref()

set$ref

public void set$ref(String $ref)

$ref

public Link $ref(String $ref)

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

toString

public String toString()

Overrides:

toString in class Object