Class OpenApiDocument.MediaTypeObjectBuilder
java.lang.Object
io.helidon.openapi.OpenApiDocument.MediaTypeObjectBuilder
- All Implemented Interfaces:
Builder<OpenApiDocument.MediaTypeObjectBuilder, OpenApiDocument.MediaTypeObject>, Supplier<OpenApiDocument.MediaTypeObject>
- Enclosing class:
OpenApiDocument
public static final class OpenApiDocument.MediaTypeObjectBuilder
extends Object
implements Builder<OpenApiDocument.MediaTypeObjectBuilder, OpenApiDocument.MediaTypeObject>
OpenAPI media type builder.
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Build the instance from this builder.description(String description) Set reference description.encoding(String name, OpenApiDocument.Encoding encoding) Add encoding.Set example.example(String name, OpenApiDocument.Example example) Add example.Add an extension.itemEncoding(OpenApiDocument.Encoding itemEncoding) Set OpenAPI 3.2 item encoding.itemSchema(JsonValue schema) Set OpenAPI 3.2 item schema.prefixEncoding(JsonArray prefixEncoding) Set OpenAPI 3.2 prefix encodings.Set reference.Set schema.Set reference summary.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Builder
get, identity, updateModifier and TypeMethodDescriptiondefault OpenApiDocument.MediaTypeObjectget()identity()Instance of this builder as the correct type.update(Consumer<OpenApiDocument.MediaTypeObjectBuilder> consumer) Update the builder in a fluent API way.
-
Method Details
-
ref
Set reference.- Parameters:
ref- reference- Returns:
- updated builder
-
summary
Set reference summary.- Parameters:
summary- summary- Returns:
- updated builder
-
description
Set reference description.- Parameters:
description- description- Returns:
- updated builder
-
schema
Set schema.- Parameters:
schema- schema- Returns:
- updated builder
-
itemSchema
Set OpenAPI 3.2 item schema.- Parameters:
schema- item schema- Returns:
- updated builder
-
example
Set example.- Parameters:
example- example value- Returns:
- updated builder
-
example
Add example.- Parameters:
name- example nameexample- example- Returns:
- updated builder
-
encoding
public OpenApiDocument.MediaTypeObjectBuilder encoding(String name, OpenApiDocument.Encoding encoding) Add encoding.- Parameters:
name- encoding nameencoding- encoding- Returns:
- updated builder
-
prefixEncoding
Set OpenAPI 3.2 prefix encodings.- Parameters:
prefixEncoding- prefix encodings- Returns:
- updated builder
-
itemEncoding
Set OpenAPI 3.2 item encoding.- Parameters:
itemEncoding- item encoding- Returns:
- updated builder
-
extension
Add an extension.Extension names must start with
x-.- Parameters:
name- extension namevalue- extension value- Returns:
- updated builder
-
build
Description copied from interface:BuilderBuild the instance from this builder.- Specified by:
buildin interfaceBuilder<OpenApiDocument.MediaTypeObjectBuilder, OpenApiDocument.MediaTypeObject>- Returns:
- instance of the built type
-