Class RealtimeError.Builder
-
- All Implemented Interfaces:
public final class RealtimeError.Builder
A builder for RealtimeError.
-
-
Method Summary
Modifier and Type Method Description final RealtimeError.Builder
message(String message)
A human-readable error message. final RealtimeError.Builder
message(JsonField<String> message)
Sets Builder.message to an arbitrary JSON value. final RealtimeError.Builder
type(String type)
The type of error (e.g., "invalid_request_error", "server_error"). final RealtimeError.Builder
type(JsonField<String> type)
Sets Builder.type to an arbitrary JSON value. final RealtimeError.Builder
code(String code)
Error code, if any. final RealtimeError.Builder
code(Optional<String> code)
Alias for calling Builder.code with code.orElse(null)
.final RealtimeError.Builder
code(JsonField<String> code)
Sets Builder.code to an arbitrary JSON value. final RealtimeError.Builder
eventId(String eventId)
The event_id of the client event that caused the error, if applicable. final RealtimeError.Builder
eventId(Optional<String> eventId)
Alias for calling Builder.eventId with eventId.orElse(null)
.final RealtimeError.Builder
eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value. final RealtimeError.Builder
param(String param)
Parameter related to the error, if any. final RealtimeError.Builder
param(Optional<String> param)
Alias for calling Builder.param with param.orElse(null)
.final RealtimeError.Builder
param(JsonField<String> param)
Sets Builder.param to an arbitrary JSON value. final RealtimeError.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final RealtimeError.Builder
putAdditionalProperty(String key, JsonValue value)
final RealtimeError.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final RealtimeError.Builder
removeAdditionalProperty(String key)
final RealtimeError.Builder
removeAllAdditionalProperties(Set<String> keys)
final RealtimeError
build()
Returns an immutable instance of RealtimeError. -
-
Method Detail
-
message
final RealtimeError.Builder message(String message)
A human-readable error message.
-
message
final RealtimeError.Builder message(JsonField<String> message)
Sets Builder.message to an arbitrary JSON value.
You should usually call Builder.message with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
type
final RealtimeError.Builder type(String type)
The type of error (e.g., "invalid_request_error", "server_error").
-
type
final RealtimeError.Builder type(JsonField<String> type)
Sets Builder.type to an arbitrary JSON value.
You should usually call Builder.type with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
code
final RealtimeError.Builder code(String code)
Error code, if any.
-
code
final RealtimeError.Builder code(Optional<String> code)
Alias for calling Builder.code with
code.orElse(null)
.
-
code
final RealtimeError.Builder code(JsonField<String> code)
Sets Builder.code to an arbitrary JSON value.
You should usually call Builder.code with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
eventId
final RealtimeError.Builder eventId(String eventId)
The event_id of the client event that caused the error, if applicable.
-
eventId
final RealtimeError.Builder eventId(Optional<String> eventId)
Alias for calling Builder.eventId with
eventId.orElse(null)
.
-
eventId
final RealtimeError.Builder eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value.
You should usually call Builder.eventId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
param
final RealtimeError.Builder param(String param)
Parameter related to the error, if any.
-
param
final RealtimeError.Builder param(Optional<String> param)
Alias for calling Builder.param with
param.orElse(null)
.
-
param
final RealtimeError.Builder param(JsonField<String> param)
Sets Builder.param to an arbitrary JSON value.
You should usually call Builder.param with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final RealtimeError.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final RealtimeError.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final RealtimeError.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final RealtimeError.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final RealtimeError.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final RealtimeError build()
Returns an immutable instance of RealtimeError.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.message() .type()
-
-
-
-