software.amazon.awscdk.services.apigateway

Class Model.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Model.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Model>

Enclosing class:

Model

@Stability(value=Experimental)
public static final class Model.Builder
extends Object
implements software.amazon.jsii.Builder<Model>

(experimental) A fluent builder for Model.

Method Summary

Modifier and Type	Method and Description
Model	build()
Model.Builder	contentType(String contentType) (experimental) The content type for the model.
static Model.Builder	create(software.constructs.Construct scope, String id)
Model.Builder	description(String description) (experimental) A description that identifies this model.
Model.Builder	modelName(String modelName) (experimental) A name for the model.
Model.Builder	restApi(IRestApi restApi) (experimental) The rest API that this model is part of.
Model.Builder	schema(JsonSchema schema) (experimental) The schema to use to transform data to one or more output formats.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Model.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Model.Builder.

schema

@Stability(value=Experimental)
public Model.Builder schema(JsonSchema schema)

(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.

Parameters:

schema - The schema to use to transform data to one or more output formats. This parameter is required.

Returns:

this

contentType

@Stability(value=Experimental)
public Model.Builder contentType(String contentType)

(experimental) The content type for the model.

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

Default: 'application/json'

Parameters:

contentType - The content type for the model. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public Model.Builder description(String description)

(experimental) A description that identifies this model.

Default: None

Parameters:

description - A description that identifies this model. This parameter is required.

Returns:

this

modelName

@Stability(value=Experimental)
public Model.Builder modelName(String modelName)

(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.

Parameters:

modelName - A name for the model. This parameter is required.

Returns:

this

restApi

@Stability(value=Experimental)
public Model.Builder restApi(IRestApi restApi)

(experimental) The rest API that this model is part of.

The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.

Parameters:

restApi - The rest API that this model is part of. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Model build()

Specified by:

build in interface software.amazon.jsii.Builder<Model>