org.eclipse.microprofile.openapi.models.servers

Interface Server

All Superinterfaces:

Constructible, Extensible

public interface Server
extends Constructible, Extensible

An object representing a server.

See Also:

Server Object

Method Summary

Modifier and Type	Method and Description
Server	description(String description) This method sets the description property of a Server instance to the given description parameter and returns the modified instance.
String	getDescription() This method returns the description property of Server instance.
String	getUrl() This method returns the url property of Server instance, which is a URL to the target host.
ServerVariables	getVariables() This method returns the variables property of Server instance.
void	setDescription(String description) This method sets the description property of a Server instance to the given description parameter.
void	setUrl(String url) This method sets the url property of Server instance to the given url argument, representing a URL to the target host.
void	setVariables(ServerVariables variables) This method sets the variables property of Server instance to the given variables argument.
Server	url(String url) This method sets the url property of Server instance to the given url argument, representing a URL to the target host, and returns the modified instance.
Server	variables(ServerVariables variables) This method sets the variables property of Server instance to the given variables argument and returns the modified instance.

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, getExtensions, setExtensions

Method Detail

getUrl

String getUrl()

This method returns the url property of Server instance, which is a URL to the target host.

This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named enclosed in curly brackets.

This is a REQUIRED property.

Returns:

String url

setUrl

void setUrl(String url)

This method sets the url property of Server instance to the given url argument, representing a URL to the target host.

This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named enclosed in curly brackets.

This is a REQUIRED property.

Parameters:

url - a URL to the target host

url

Server url(String url)

This method sets the url property of Server instance to the given url argument, representing a URL to the target host, and returns the modified instance.

This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named enclosed in curly brackets.

This is a REQUIRED property.

Parameters:

url - a URL to the target host

Returns:

Server instance with the set url property.

getDescription

String getDescription()

This method returns the description property of Server instance. The decsription property is an optional string describing the host designated by the URL.

Returns:

String description

setDescription

void setDescription(String description)

This method sets the description property of a Server instance to the given description parameter.

Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be used for rich text representation.

Parameters:

description - an optional string describing the host designated by the URL

description

Server description(String description)

This method sets the description property of a Server instance to the given description parameter and returns the modified instance.

Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be used for rich text representation.

Parameters:

description - an optional string describing the host designated by the URL

Returns:

Server instance with the set description property.

getVariables

ServerVariables getVariables()

This method returns the variables property of Server instance.

Variables are represented as a map between variable name and its value. The value is used for substitution in the server's URL template.

Returns:

ServerVariables variables

setVariables

void setVariables(ServerVariables variables)

This method sets the variables property of Server instance to the given variables argument.

Variables property is a map between variable name and its value. The value is used for substitution in the server's URL template.

Parameters:

variables - a map between variable name and its value

variables

Server variables(ServerVariables variables)

This method sets the variables property of Server instance to the given variables argument and returns the modified instance.

Variables property is a map between variable name and its value. The value is used for substitution in the server's URL template.

Parameters:

variables - a map between variable name and its value

Returns:

Server instance with the set variables property.