WebSocketError (Pulsar WebSocket 2.11.0-rc-202204232205 API)

java.lang.Object
- java.lang.Enum<WebSocketError>
- - org.apache.pulsar.websocket.WebSocketError

All Implemented Interfaces:

Serializable, Comparable<WebSocketError>
```
public enum WebSocketError
extends Enum<WebSocketError>
```
Enum for possible errors in the proxy
Enum has error code and description of the error.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AuthenticationError`
`FailedToCreateProducer`
`FailedToDeserializeFromJSON`
`FailedToSerializeToJSON`
`FailedToSubscribe`
`NotAuthorizedError`
`PayloadEncodingError`
`UnknownError`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCode()`
`String`	`getDescription()`
`String`	`toString()`
`static WebSocketError`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WebSocketError[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - FailedToCreateProducer
```
public static final WebSocketError FailedToCreateProducer
```
  - FailedToSubscribe
```
public static final WebSocketError FailedToSubscribe
```
  - FailedToDeserializeFromJSON
```
public static final WebSocketError FailedToDeserializeFromJSON
```
  - FailedToSerializeToJSON
```
public static final WebSocketError FailedToSerializeToJSON
```
  - AuthenticationError
```
public static final WebSocketError AuthenticationError
```
  - NotAuthorizedError
```
public static final WebSocketError NotAuthorizedError
```
  - PayloadEncodingError
```
public static final WebSocketError PayloadEncodingError
```
  - UnknownError
```
public static final WebSocketError UnknownError
```
- Method Detail
  - values
```
public static WebSocketError[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (WebSocketError c : WebSocketError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WebSocketError valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getDescription
```
public String getDescription()
```
  - getCode
```
public int getCode()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<WebSocketError>

Enum WebSocketError

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FailedToCreateProducer

FailedToSubscribe

FailedToDeserializeFromJSON

FailedToSerializeToJSON

AuthenticationError

NotAuthorizedError

PayloadEncodingError

UnknownError

Method Detail

values

valueOf

getDescription

getCode

toString