ApiGatewayEvent class

Inheritance
Annotations
  • @JsonSerializable()

Constructors

ApiGatewayEvent({required String version, required String routeKey, required String rawPath, required String rawQueryString, required List<String> cookies, required Map<String, String> headers, required Map<String, String> queryStringParameters, required ApiGatewayRequestContext requestContext, required String body, required Map<String, String> pathParameters, required bool isBase64Encoded, required Map<String, String> stageVariables})
ApiGatewayEvent.fromJson(Map<String, dynamic> json)
factory

Properties

body → String
final
cookies → List<String>
final
environment ↔ UnmodifiableMapView<String, String>
latefinal
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
final
isBase64Encoded → bool
final
pathParameters → Map<String, String>
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setterinherited
queryStringParameters → Map<String, String>
final
rawPath → String
final
rawQueryString → String
final
requestContext → ApiGatewayRequestContext
final
routeKey → String
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageVariables → Map<String, String>
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
version → String
final

Methods

attach<T>(T value) → T
Attaches a contextual value to this instance and returns the value. The type of T is the signature/key, attaching more than one thing of the same will only store the last one.
inherited
detach<T>() → T?
Detaches a contextual value from this instance and returns it, or null if it didn't exist. The type of T is the signature/key of what will be removed if it exists. This won't throw if the value was NOT previously attached.
inherited
get<T>([MissingValueHandler? handler]) → T
Gets a contextual value from this instance. The type of T is the signature/key of what will be returned if it exists. If the value doesn't exist, it invoke the handler for a return value, if one was provided, or throws a BadContextError.
inherited
getEnv(String key, [String? fallback]) → String?
getEnvBool(String key, [bool? fallback]) → bool?
getEnvNum(String key, [num? fallback]) → num?
getHeader(String key, [String? fallback]) → String?
hasEnv(String key) → bool
hasHeader(String key) → bool
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts this instance to JSON.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited