Class RealtimeErrorEvent
-
- All Implemented Interfaces:
public final class RealtimeErrorEventReturned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeErrorEvent.BuilderA builder for RealtimeErrorEvent.
-
Method Summary
Modifier and Type Method Description final RealtimeErrorerror()Details of the error. final StringeventId()The unique ID of the server event. final JsonValue_type()The event type, must be error.final JsonField<RealtimeError>_error()Returns the raw JSON value of error. final JsonField<String>_eventId()Returns the raw JSON value of eventId. final Map<String, JsonValue>_additionalProperties()final RealtimeErrorEvent.BuildertoBuilder()final RealtimeErrorEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeErrorEvent.Builderbuilder()Returns a mutable builder for constructing an instance of RealtimeErrorEvent. -
-
Method Detail
-
error
final RealtimeError error()
Details of the error.
-
_type
final JsonValue _type()
The event type, must be
error.Expected to always return the following:
JsonValue.from("error")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_error
final JsonField<RealtimeError> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_eventId
final JsonField<String> _eventId()
Returns the raw JSON value of eventId.
Unlike eventId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeErrorEvent.Builder toBuilder()
-
validate
final RealtimeErrorEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static RealtimeErrorEvent.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeErrorEvent.
The following fields are required:
.error() .eventId()
-
-
-
-