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 class
ParameterObject.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ParameterObject.Builder
builder()
protected ObjectNode.Builder
createNodeBuilder()
java.util.Map<java.lang.String,MediaTypeObject>
getContent()
java.util.Optional<java.lang.String>
getDescription()
java.util.Optional<ExampleObject>
getExample()
java.util.Map<java.lang.String,ExampleObject>
getExamples()
java.util.Optional<java.lang.String>
getIn()
java.util.Optional<java.lang.String>
getName()
java.util.Optional<Schema>
getSchema()
java.util.Optional<java.lang.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
-
-
-
-
Method Detail
-
builder
public static ParameterObject.Builder builder()
-
getName
public java.util.Optional<java.lang.String> getName()
-
getIn
public java.util.Optional<java.lang.String> getIn()
-
getExamples
public java.util.Map<java.lang.String,ExampleObject> getExamples()
-
getContent
public java.util.Map<java.lang.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 java.util.Optional<java.lang.String> getDescription()
-
getStyle
public java.util.Optional<java.lang.String> getStyle()
-
getSchema
public java.util.Optional<Schema> getSchema()
-
getExample
public java.util.Optional<ExampleObject> getExample()
-
createNodeBuilder
protected ObjectNode.Builder createNodeBuilder()
- Specified by:
createNodeBuilder
in classComponent
-
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 interfaceToSmithyBuilder<ParameterObject>
- Returns:
- a builder for type T
-
-