Package org.eclipse.microprofile.openapi.models.servers

Interface ServerVariable

All Superinterfaces:

Constructible, Extensible

public interface ServerVariable
extends Constructible, Extensible

An object representing a Server Variable for server URL template substitution.

See Also:

ServerVariable Object

Method Summary

Modifier and Type	Method	Description
ServerVariable	addEnumeration(java.lang.String enumeration)	This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
ServerVariable	defaultValue(java.lang.String defaultValue)	The default value to use for substitution, and to send, if an alternate value is not supplied.
ServerVariable	description(java.lang.String description)	This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
ServerVariable	enumeration(java.util.List<java.lang.String> enumeration)	This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
java.lang.String	getDefaultValue()	The default value to use for substitution, and to send, if an alternate value is not supplied.
java.lang.String	getDescription()	This method returns the description property of ServerVariable instance.
java.util.List<java.lang.String>	getEnumeration()	This method returns the enumeration property of ServerVariable instance.
void	setDefaultValue(java.lang.String defaultValue)	The default value to use for substitution, and to send, if an alternate value is not supplied.
void	setDescription(java.lang.String description)	This method sets the description property of ServerVariable instance to the given description argument.
void	setEnumeration(java.util.List<java.lang.String> enumeration)	This method sets the enumeration property of ServerVariable instance to the given enumeration argument.

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

addExtension, getExtensions, setExtensions

Method Detail

getEnumeration

java.util.List<java.lang.String> getEnumeration()

This method returns the enumeration property of ServerVariable instance.

This property represents an enumeration of string values to be used if the substitution options are from a limited set

Returns:

List<String> enumeration

setEnumeration

void setEnumeration(java.util.List<java.lang.String> enumeration)

This method sets the enumeration property of ServerVariable instance to the given enumeration argument.

This property represents an enumeration of string values to be used if the substitution options are from a limited set

Parameters:

enumeration - an list of string values to be used if the substitution options are from a limited set

enumeration

ServerVariable enumeration(java.util.List<java.lang.String> enumeration)

This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.

This property represents an enum of string values to be used if the substitution options are from a limited set.

Parameters:

enumeration - an list of string values to be used if the substitution options are from a limited set

Returns:

ServerVariable instance with the set enumeration property

addEnumeration

ServerVariable addEnumeration(java.lang.String enumeration)

This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.

If the enumeration list is null, this method should create a new ArrayList and add the item.

Parameters:

enumeration - an item to be added to enum list

Returns:

ServerVariable instance with the added enum item.

getDefaultValue

java.lang.String getDefaultValue()

The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and is REQUIRED.

This method returns the defaultValue property from ServerVariable instance.

Returns:

String defaultValue

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and is REQUIRED.

This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument.

Parameters:

defaultValue - the value to use for substitution, and to send, if an alternate value is not supplied

defaultValue

ServerVariable defaultValue(java.lang.String defaultValue)

The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and is REQUIRED.

This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument and returns the modified instance.

Parameters:

defaultValue - the value to use for substitution, and to send, if an alternate value is not supplied

Returns:

ServerVariable instance with the set defaultValue property

getDescription

java.lang.String getDescription()

This method returns the description property of ServerVariable instance. Description property is optional for server variable.

Returns:

String description

setDescription

void setDescription(java.lang.String description)

This method sets the description property of ServerVariable instance to the given description argument.

Description property is optional for server variable. CommonMark syntax can be used for rich text representation.

Parameters:

description - a short description of the server variable

description

ServerVariable description(java.lang.String description)

This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.

Description property is optional for server variable. CommonMark syntax can be used for rich text representation.

Parameters:

description - a short description of the server variable

Returns:

ServerVariable instance with the set description property