RestApi class

Represents a REST API.

Create an API

Constructors

RestApi({ApiKeySourceType? apiKeySource, List<String>? binaryMediaTypes, DateTime? createdDate, String? description, bool? disableExecuteApiEndpoint, EndpointConfiguration? endpointConfiguration, String? id, int? minimumCompressionSize, String? name, String? policy, Map<String, String>? tags, String? version, List<String>? warnings})

RestApi.fromJson(Map<String, dynamic> json)

factory

Properties

apiKeySource → ApiKeySourceType?

The source of the API key for metering requests according to a usage plan. Valid values are:

final

binaryMediaTypes → List<String>?

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

final

createdDate → DateTime?

The timestamp when the API was created.

final

description → String?

The API's description.

final

disableExecuteApiEndpoint → bool?

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

final

endpointConfiguration → EndpointConfiguration?

The endpoint configuration of this RestApi showing the endpoint types of the API.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

final

minimumCompressionSize → int?

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

final

name → String?

The API's name.

final

policy → String?

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tags → Map<String, String>?

The collection of tags. Each tag element is associated with a given resource.

final

version → String?

A version identifier for the API.

final

warnings → List<String>?

The warning messages reported when failonwarnings is turned on during API import.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited