software.amazon.awscdk.services.apigateway

Interface ModelOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ModelProps

All Known Implementing Classes:

ModelOptions.Jsii$Proxy, ModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:46.065Z")
 @Stability(value=Experimental)
public interface ModelOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModelOptions.Builder A builder for ModelOptions
static class	ModelOptions.Jsii$Proxy An implementation for ModelOptions

Method Summary

Modifier and Type	Method and Description
static ModelOptions.Builder	builder()
default String	getContentType() (experimental) The content type for the model.
default String	getDescription() (experimental) A description that identifies this model.
default String	getModelName() (experimental) A name for the model.
JsonSchema	getSchema() (experimental) The schema to use to transform data to one or more output formats.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSchema

@Stability(value=Experimental)
 @NotNull
JsonSchema getSchema()

(experimental) The schema to use to transform data to one or more output formats.

Specify null ({}) if you don't want to specify a schema.

getContentType

@Stability(value=Experimental)
 @Nullable
default String getContentType()

(experimental) The content type for the model.

You can also force a content type in the request or response model mapping.

Default: 'application/json'

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) A description that identifies this model.

Default: None

getModelName

@Stability(value=Experimental)
 @Nullable
default String getModelName()

(experimental) A name for the model.

Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Default: If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type.

builder

@Stability(value=Experimental)
static ModelOptions.Builder builder()

Returns:

a ModelOptions.Builder of ModelOptions