HttpSinkOptions class

Built-in HTTP sink options (Segment HTTP Tracking API wire contract).

Constructors

HttpSinkOptions({required String endpoint, required String writeKey, int maxRetries = 3, int backoffBaseMs = 500, HttpTransport? transport, List<String> consentCategories = const ['analytics'], int maxBatchBytes = 500000, int maxEventBytes = 32000, Future<void> sleep(Duration)?})

const

Properties

backoffBaseMs → int

Base backoff delay in ms. Default 500.

final

consentCategories → List<String>

Consent categories this sink requires. Default ['analytics'].

final

endpoint → String

Base endpoint; events POST to {endpoint}/v{schemaVersion}/batch.

final

hashCode → int

The hash code for this object.

no setter, inherited

maxBatchBytes → int

Soft per-batch byte cap (Segment ≈ 500KB). Default 500000.

final

maxEventBytes → int

Soft per-event byte cap (Segment ≈ 32KB). Default 32000.

final

maxRetries → int

Max retries for 429/5xx (exponential backoff). Default 3.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sleep → Future<void> Function(Duration)?

Injected sleep (for deterministic backoff tests).

final

transport → HttpTransport?

Injected transport (defaults to the resolved platform transport).

final

writeKey → String

Write key — sent as Authorization: Basic base64(writeKey:).

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