Package software.amazon.smithy.openapi.model

Class ParameterObject

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.ParameterObject

All Implemented Interfaces:

ToNode, ToSmithyBuilder<ParameterObject>

public final class ParameterObject
extends Component
implements ToSmithyBuilder<ParameterObject>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParameterObject.Builder

Method Summary

Modifier and Type	Method	Description
static ParameterObject.Builder	builder()
protected ObjectNode.Builder	createNodeBuilder()
Map<String,MediaTypeObject>	getContent()
Optional<String>	getDescription()
Optional<ExampleObject>	getExample()
Map<String,ExampleObject>	getExamples()
Optional<String>	getIn()
Optional<String>	getName()
Optional<Schema>	getSchema()
Optional<String>	getStyle()
boolean	isAllowEmptyValue()
boolean	isAllowReserved()
boolean	isDeprecated()
boolean	isExplode()
boolean	isRequired()
ParameterObject.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.openapi.model.Component

equals, getExtension, getExtensions, hashCode, toNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static ParameterObject.Builder builder()

getName

public Optional<String> getName()

getIn

public Optional<String> getIn()

getExamples

public Map<String,ExampleObject> getExamples()

getContent

public Map<String,MediaTypeObject> getContent()

isRequired

public boolean isRequired()

isDeprecated

public boolean isDeprecated()

isAllowEmptyValue

public boolean isAllowEmptyValue()

isExplode

public boolean isExplode()

isAllowReserved

public boolean isAllowReserved()

getDescription

public Optional<String> getDescription()

getStyle

public Optional<String> getStyle()

getSchema

public Optional<Schema> getSchema()

getExample

public Optional<ExampleObject> getExample()

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component

toBuilder

public ParameterObject.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<ParameterObject>

Returns:

a builder for type T