public interface Server extends Constructible, Extensible<Server>
Modifier and Type | Method and Description |
---|---|
default 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(Map<String,ServerVariable> variables)
This method sets the variables property of Server instance to the given variables argument.
|
void |
setVariables(ServerVariables variables)
Deprecated.
since 1.1, use
setVariables(Map) instead |
default 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.
|
default Server |
variables(Map<String,ServerVariable> variables)
This method sets the variables property of Server instance to the given variables argument and returns the modified instance.
|
default Server |
variables(ServerVariables variables)
Deprecated.
since 1.1, use
variables(Map) instead |
addExtension, extensions, getExtensions, removeExtension, setExtensions
String getUrl()
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.
void setUrl(String url)
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.
url
- a URL to the target hostdefault Server url(String url)
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.
url
- a URL to the target hostString getDescription()
void setDescription(String description)
Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be used for rich text representation.
description
- an optional string describing the host designated by the URLdefault Server description(String description)
Description of a server is an optional string describing the host designated by the URL. CommonMark syntax can be used for rich text representation.
description
- an optional string describing the host designated by the URLServerVariables getVariables()
Variables are represented as a map between variable name and its value. The value is used for substitution in the server's URL template.
Map<String, ServerVariable>
).@Deprecated void setVariables(ServerVariables variables)
setVariables(Map)
insteadVariables property is a map between variable name and its value. The value is used for substitution in the server's URL template.
variables
- a map between variable name and its valuevoid setVariables(Map<String,ServerVariable> variables)
Variables property is a map between variable name and its value. The value is used for substitution in the server's URL template.
variables
- a map between variable name and its value@Deprecated default Server variables(ServerVariables variables)
variables(Map)
insteadVariables property is a map between variable name and its value. The value is used for substitution in the server's URL template.
variables
- a map between variable name and its valuedefault Server variables(Map<String,ServerVariable> variables)
Variables property is a map between variable name and its value. The value is used for substitution in the server's URL template.
variables
- a map between variable name and its valueCopyright © 2017 – 2021 Eclipse Foundation. All rights reserved.
Use is subject to license terms.