S3Health class

Constructors

S3Health({String? error, bool? presign, bool? ready, String? service, String? status})
Returns a new S3Health instance.

Properties

error ↔ String?
Error is why the probe is degraded, in plain words. Absent when it is not.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
presign ↔ bool?
Presign is whether presigned upload and download URLs can be minted, which needs a PUBLIC endpoint on top of the credentials. False does not make the surface degraded — listing and creating still work. NOT omitempty. On the ready path the untyped probe wrote this key unconditionally, and omitting a false one would turn what a healthy-but-presignless deployment reports from "presign: false" into silence — two different facts. The degraded body now carries it too, which is the one delta of typing this: the probe answers ONE shape under both of its statuses, which is what makes a single declared Out honest.
getter/setter pair
ready ↔ bool?
Ready is whether this deployment can serve object operations at all: true only when admin credentials are configured.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service ↔ String?
Service names the subsystem this probe is for. Always "s3".
getter/setter pair
status ↔ String?
Status is "ok" when the store is reachable in principle, "degraded" when it is not. It is the field to read; the HTTP status carries the same fact for a caller that only looks at the code.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

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

Static Methods

fromJson(dynamic value) → S3Health?
Returns a new S3Health instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) → List<S3Health>
mapFromJson(dynamic json) → Map<String, S3Health>
mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<S3Health>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.