Package io.muserver.openapi
Class ServerVariableObjectBuilder
- java.lang.Object
-
- io.muserver.openapi.ServerVariableObjectBuilder
-
public class ServerVariableObjectBuilder extends java.lang.Object
An object representing a Server Variable for server URL template substitution.
-
-
Constructor Summary
Constructors Constructor Description ServerVariableObjectBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ServerVariableObject
build()
static ServerVariableObjectBuilder
serverVariableObject()
Creates a builder for aServerVariableObjectBuilder
ServerVariableObjectBuilder
withDefaultValue(java.lang.String defaultValue)
ServerVariableObjectBuilder
withDescription(java.lang.String description)
ServerVariableObjectBuilder
withEnumValues(java.util.List<java.lang.String> enumValues)
-
-
-
Method Detail
-
withEnumValues
public ServerVariableObjectBuilder withEnumValues(java.util.List<java.lang.String> enumValues)
- Parameters:
enumValues
- An enumeration of string values to be used if the substitution options are from a limited set.- Returns:
- The current builder
-
withDefaultValue
public ServerVariableObjectBuilder withDefaultValue(java.lang.String defaultValue)
- Parameters:
defaultValue
- REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.- Returns:
- The current builder
-
withDescription
public ServerVariableObjectBuilder withDescription(java.lang.String description)
- Parameters:
description
- An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.- Returns:
- The current builder
-
build
public ServerVariableObject build()
- Returns:
- A new object
-
serverVariableObject
public static ServerVariableObjectBuilder serverVariableObject()
Creates a builder for aServerVariableObjectBuilder
- Returns:
- A new builder
-
-