Stage class

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

Constructors

Stage({AccessLogSettings? accessLogSettings, bool? cacheClusterEnabled, CacheClusterSize? cacheClusterSize, CacheClusterStatus? cacheClusterStatus, CanarySettings? canarySettings, String? clientCertificateId, DateTime? createdDate, String? deploymentId, String? description, String? documentationVersion, DateTime? lastUpdatedDate, Map<String, MethodSetting>? methodSettings, String? stageName, Map<String, String>? tags, bool? tracingEnabled, Map<String, String>? variables, String? webAclArn})
Stage.fromJson(Map<String, dynamic> json)
factory

Properties

accessLogSettings → AccessLogSettings?
Settings for logging access in this stage.
final
cacheClusterEnabled → bool?
Specifies whether a cache cluster is enabled for the stage.
final
cacheClusterSize → CacheClusterSize?
The size of the cache cluster for the stage, if enabled.
final
cacheClusterStatus → CacheClusterStatus?
The status of the cache cluster for the stage, if enabled.
final
canarySettings → CanarySettings?
Settings for the canary deployment in this stage.
final
clientCertificateId → String?
The identifier of a client certificate for an API stage.
final
createdDate → DateTime?
The timestamp when the stage was created.
final
deploymentId → String?
The identifier of the Deployment that the stage points to.
final
description → String?
The stage's description.
final
documentationVersion → String?
The version of the associated API documentation.
final
hashCode → int
The hash code for this object.
no setterinherited
lastUpdatedDate → DateTime?
The timestamp when the stage last updated.
final
methodSettings → Map<String, MethodSetting>?
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /*/* for overriding all methods in the stage.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageName → String?
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
final
tags → Map<String, String>?
The collection of tags. Each tag element is associated with a given resource.
final
tracingEnabled → bool?
Specifies whether active tracing with X-ray is enabled for the Stage.
final
variables → Map<String, String>?
A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match A-Za-z0-9-._~:/?#&amp;=,+.
final
webAclArn → String?
The ARN of the WebAcl associated with the Stage.
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