Class RealtimeResponseStatus.Reason
- 
                    
                    
- All Implemented Interfaces:
 - 
                            
                            
com.openai.core.Enum 
public final class RealtimeResponseStatus.Reason implements EnumThe 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). 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumRealtimeResponseStatus.Reason.KnownAn enum containing Reason's known values.
public enumRealtimeResponseStatus.Reason.ValueAn enum containing Reason's known values, as well as an _UNKNOWN member.
An instance of Reason can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
 
- 
                                
                            
                                
Field Summary
Fields Modifier and Type Field Description public final static RealtimeResponseStatus.ReasonTURN_DETECTEDpublic final static RealtimeResponseStatus.ReasonCLIENT_CANCELLEDpublic final static RealtimeResponseStatus.ReasonMAX_OUTPUT_TOKENSpublic final static RealtimeResponseStatus.ReasonCONTENT_FILTER 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final RealtimeResponseStatus.Reason.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final RealtimeResponseStatus.Reason.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final RealtimeResponseStatus.Reasonvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeResponseStatus.Reasonof(String value)- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
 
- 
                                        
value
final RealtimeResponseStatus.Reason.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
 
- 
                                        
known
final RealtimeResponseStatus.Reason.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
 
- 
                                        
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
 
- 
                                        
validate
final RealtimeResponseStatus.Reason validate()
 
- 
                                        
of
final static RealtimeResponseStatus.Reason of(String value)
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -