Class RealtimeResponseStatus
- 
                    
                    
- All Implemented Interfaces:
 
public final class RealtimeResponseStatusAdditional details about the status.
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeResponseStatus.BuilderA builder for RealtimeResponseStatus.
public final classRealtimeResponseStatus.ErrorA description of the error that caused the response to fail, populated when the
statusisfailed.public final classRealtimeResponseStatus.ReasonThe reason the Response did not complete. For a
cancelledResponse, one ofturn_detected(the server VAD detected a new start of speech) orclient_cancelled(the client sent a cancel event). For anincompleteResponse, one ofmax_output_tokensorcontent_filter(the server-side safety filter activated and cut off the response).public final classRealtimeResponseStatus.TypeThe type of error that caused the response to fail, corresponding with the
statusfield (completed,cancelled,incomplete,failed). 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final Optional<RealtimeResponseStatus.Error>error()A description of the error that caused the response to fail, populated when the statusisfailed.final Optional<RealtimeResponseStatus.Reason>reason()The reason the Response did not complete. final Optional<RealtimeResponseStatus.Type>type()The type of error that caused the response to fail, corresponding with the statusfield (completed,cancelled,incomplete,failed).final JsonField<RealtimeResponseStatus.Error>_error()Returns the raw JSON value of error. final JsonField<RealtimeResponseStatus.Reason>_reason()Returns the raw JSON value of reason. final JsonField<RealtimeResponseStatus.Type>_type()Returns the raw JSON value of type. final Map<String, JsonValue>_additionalProperties()final RealtimeResponseStatus.BuildertoBuilder()final RealtimeResponseStatusvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeResponseStatus.Builderbuilder()Returns a mutable builder for constructing an instance of RealtimeResponseStatus. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
error
final Optional<RealtimeResponseStatus.Error> error()
A description of the error that caused the response to fail, populated when the
statusisfailed. 
- 
                                        
reason
final Optional<RealtimeResponseStatus.Reason> reason()
The reason the Response did not complete. For a
cancelledResponse, one ofturn_detected(the server VAD detected a new start of speech) orclient_cancelled(the client sent a cancel event). For anincompleteResponse, one ofmax_output_tokensorcontent_filter(the server-side safety filter activated and cut off the response). 
- 
                                        
type
final Optional<RealtimeResponseStatus.Type> type()
The type of error that caused the response to fail, corresponding with the
statusfield (completed,cancelled,incomplete,failed). 
- 
                                        
_error
final JsonField<RealtimeResponseStatus.Error> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_reason
final JsonField<RealtimeResponseStatus.Reason> _reason()
Returns the raw JSON value of reason.
Unlike reason, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_type
final JsonField<RealtimeResponseStatus.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final RealtimeResponseStatus.Builder toBuilder()
 
- 
                                        
validate
final RealtimeResponseStatus validate()
 
- 
                                        
builder
final static RealtimeResponseStatus.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeResponseStatus.
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -