MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.servers.ServerVariable

Method Summary

Modifier and Type	Method and Description
public ServerVariable	Returns: ServerVariable instance with the added enum item. addEnumeration(String an item to be added to enum list enumeration) This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
public default ServerVariable	Returns: ServerVariable instance with the set defaultValue property defaultValue(String the value to use for substitution, and to send, if an alternate value is not supplied defaultValue) The default value to use for substitution, and to send, if an alternate value is not supplied.
public default ServerVariable	Returns: ServerVariable instance with the set description property description(String a short description of the server variable description) This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
public default ServerVariable	Returns: ServerVariable instance with the set enumeration property enumeration(List<String> an list of string values to be used if the substitution options are from a limited set enumeration) This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
public String	Returns: String defaultValue getDefaultValue() The default value to use for substitution, and to send, if an alternate value is not supplied.
public String	Returns: String description getDescription() This method returns the description property of ServerVariable instance.
public List<String>	Returns: a copy List (potentially immutable) of possible values for this variable getEnumeration() This method returns the enumeration property of ServerVariable instance.
public void	removeEnumeration(String an item to be removed to enum list enumeration) This method removes a string item to enumeration list of a ServerVariable instance.
public void	setDefaultValue(String the value to use for substitution, and to send, if an alternate value is not supplied defaultValue) The default value to use for substitution, and to send, if an alternate value is not supplied.
public void	setDescription(String a short description of the server variable description) This method sets the description property of ServerVariable instance to the given description argument.
public void	setEnumeration(List<String> an list of string values to be used if the substitution options are from a limited set enumeration) This method sets the enumeration property of ServerVariable instance to the given enumeration argument.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions

Method Detail

addEnumeration	back to summary
public ServerVariable addEnumeration(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:String an item to be added to enum list Returns:ServerVariable ServerVariable instance with the added enum item.

addEnumeration

back to summary

public ServerVariable addEnumeration(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:String: an item to be added to enum list

Returns:ServerVariable

ServerVariable instance with the added enum item.

defaultValue back to summary

defaultValue	back to summary
public default ServerVariable defaultValue(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. If `enumeration` is set the default value MUST be one of the values in `enumeration`. This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument and returns the modified instance. Parameters defaultValue:String the value to use for substitution, and to send, if an alternate value is not supplied Returns:ServerVariable ServerVariable instance with the set defaultValue property

public default ServerVariable defaultValue(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.

If enumeration is set the default value MUST be one of the values in enumeration.

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

Parameters

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

Returns:ServerVariable

ServerVariable instance with the set defaultValue property

description	back to summary
public default ServerVariable description(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:String a short description of the server variable Returns:ServerVariable ServerVariable instance with the set description property

description

back to summary

public default ServerVariable description(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:String: a short description of the server variable

Returns:ServerVariable

ServerVariable instance with the set description property

enumeration	back to summary
public default ServerVariable enumeration(List<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:List<String> an list of string values to be used if the substitution options are from a limited set Returns:ServerVariable ServerVariable instance with the set enumeration property

enumeration

back to summary

public default ServerVariable enumeration(List<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:List<String>: an list of string values to be used if the substitution options are from a limited set

Returns:ServerVariable

ServerVariable instance with the set enumeration property

getDefaultValue	back to summary
public 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 String defaultValue

getDefaultValue

back to summary

public 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: String defaultValue

getDescription	back to summary
public String getDescription() This method returns the description property of ServerVariable instance. Description property is optional for server variable. Returns:String String description

getDescription

back to summary

public String getDescription()

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

Returns:String: String description

getEnumeration	back to summary
public List<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> a copy List (potentially immutable) of possible values for this variable

getEnumeration

back to summary

public List<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>: a copy List (potentially immutable) of possible values for this variable

removeEnumeration	back to summary
public void removeEnumeration(String enumeration) This method removes a string item to enumeration list of a ServerVariable instance. Parameters enumeration:String an item to be removed to enum list

removeEnumeration

back to summary

public void removeEnumeration(String enumeration)

This method removes a string item to enumeration list of a ServerVariable instance.

Parameters

enumeration:String: an item to be removed to enum list

setDefaultValue back to summary

setDefaultValue	back to summary
public void setDefaultValue(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. If `enumeration` is set the default value MUST be one of the values in `enumeration`. This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument. Parameters defaultValue:String the value to use for substitution, and to send, if an alternate value is not supplied

public void setDefaultValue(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.

If enumeration is set the default value MUST be one of the values in enumeration.

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

Parameters

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

setDescription	back to summary
public void setDescription(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:String a short description of the server variable

setDescription

back to summary

public void setDescription(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:String: a short description of the server variable

setEnumeration	back to summary
public void setEnumeration(List<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:List<String> an list of string values to be used if the substitution options are from a limited set

setEnumeration

back to summary

public void setEnumeration(List<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:List<String>: an list of string values to be used if the substitution options are from a limited set

public Interface ServerVariable

Method Summary

Method Detail