software.amazon.awscdk.services.apigateway

Class ErrorModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.ErrorModel

All Implemented Interfaces:

IModel, software.amazon.jsii.JsiiSerializable

Deprecated.

You should use Model.ERROR_MODEL

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.727Z")
 @Stability(value=Deprecated)
 @Deprecated
public class ErrorModel
extends software.amazon.jsii.JsiiObject
implements IModel

(deprecated) Represents a reference to a REST API's Error model, which is available as part of the model collection by default.

This can be used for mapping error JSON responses from an integration to a client, where a simple generic message field is sufficient to map and return an error payload.

Definition { "$schema" : "http://json-schema.org/draft-04/schema#", "title" : "Error Schema", "type" : "object", "properties" : { "message" : { "type" : "string" } } }

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 ErrorModel errorModel = new ErrorModel();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IModel

IModel.Jsii$Default, IModel.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ErrorModel() Deprecated.
protected	ErrorModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	ErrorModel(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getModelId() Deprecated.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ErrorModel

protected ErrorModel(software.amazon.jsii.JsiiObjectRef objRef)

Deprecated.

ErrorModel

protected ErrorModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Deprecated.

ErrorModel

@Stability(value=Experimental)
public ErrorModel()

Deprecated.

Method Detail

getModelId

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public String getModelId()

Deprecated.

(deprecated) Returns the model name, such as 'myModel'.

Specified by:

getModelId in interface IModel