AWSStreamedHttpRequest class

A streaming HTTP request.

Inheritance

• Object
• AWSBaseHttpRequest
• AWSStreamedHttpRequest

Constructors

AWSStreamedHttpRequest({required AWSHttpMethod method, required Uri uri, Map<String, String>? headers, Stream<List<int>>? body, int? contentLength, bool? followRedirects, int? maxRedirects})

@{macro aws_common.aws_http_streamed_request}

AWSStreamedHttpRequest.delete(Uri uri, {Stream<List<int>>? body, int? contentLength, Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a DELETE request for uri.

AWSStreamedHttpRequest.get(Uri uri, {Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a GET request for uri.

AWSStreamedHttpRequest.head(Uri uri, {Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a HEAD request for uri.

AWSStreamedHttpRequest.patch(Uri uri, {Stream<List<int>>? body, int? contentLength, Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a PATCH request for uri.

AWSStreamedHttpRequest.post(Uri uri, {Stream<List<int>>? body, int? contentLength, Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a POST request for uri.

AWSStreamedHttpRequest.put(Uri uri, {Stream<List<int>>? body, int? contentLength, Map<String, String>? headers, bool? followRedirects, int? maxRedirects})

Creates a PUT request for uri.

AWSStreamedHttpRequest.raw({required AWSHttpMethod method, String scheme = 'https', required String host, int? port, required String path, Map<String, Object>? queryParameters, Map<String, String>? headers, Stream<List<int>>? body, int? contentLength, bool? followRedirects, int? maxRedirects})

Creates a "raw", or unprocessed, streaming HTTP request. Since the Uri constructor will normalize paths by default, this constructor provides an escape hatch for situations when paths are already normalized and further processing could interfere with downstream activities like signing.

Properties

body → Stream<List<int>>

The request's body stream.

no setter, override

bodyBytes → Future<Uint8List>

The collected bytes of the body stream.

no setter, override

contentLength → FutureOr<int>

The request's content length.

late, final

debugNumSplits ↔ int

The number of times the body stream has been split.

getter/setter pair

followRedirects → bool

Whether to automatically follow redirects.

final, inherited

hasContentLength → bool

Whether the request has a known content length.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>

The case-insensitive headers of the request.

final, inherited

host → String

The host for the request.

final, inherited

maxRedirects → int

If followRedirects is true, sets the maximum number of redirects before the request is terminated and an exception is thrown.

final, inherited

method → AWSHttpMethod

The method of the request.

final, inherited

path → String

The path of the request.

final, inherited

port → int?

The port of the request.

final, inherited

queryParameters → Map<String, String>

Query parameters for the request.

no setter, inherited

queryParametersAll → Map<String, List<String>>

All query parameters for the request.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheme → String

The scheme of the request, e.g. https.

final, inherited

uri → Uri

The URI of the request.

late, final, inherited

Methods

close() → Future<void>

Indicates that no more branches will be requested via split.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

read() → Future<AWSHttpRequest>

Reads body fully and returns a flattened AWSHttpRequest.

override

send({AWSHttpClient? client, FutureOr<void> onCancel()?}) → AWSHttpOperation<AWSBaseHttpResponse>

Sends the HTTP request.

inherited

split() → Stream<List<int>>

Returns a copy of body in cases where the stream must be read multiple times, e.g. when contentLength is not provided and the service requires it.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited