Package io.servicetalk.grpc.api

Class GrpcStatus

java.lang.Object

io.servicetalk.grpc.api.GrpcStatus

public final class GrpcStatus
extends Object

Class representing gRPC statuses.

See Also:

• GrpcStatusCode

Constructor Summary

Constructors

Constructor	Description
GrpcStatus(GrpcStatusCode code)	Constructs a status with no cause or description.
GrpcStatus(GrpcStatusCode code, String description)	Constructs a status with cause and additional description.
GrpcStatus(GrpcStatusCode code, Throwable cause)	Deprecated. Use GrpcStatusException if there is a Throwable cause.
GrpcStatus(GrpcStatusCode code, Throwable cause, CharSequence description)	Deprecated. Use GrpcStatusException if there is a cause or GrpcStatus(GrpcStatusCode, String).

Method Summary

Modifier and Type	Method	Description
GrpcStatusException	asException()	Deprecated. Use GrpcStatusException(GrpcStatus).
GrpcStatusException	asException(Supplier<com.google.rpc.Status> applicationStatusSupplier)	Deprecated. Use GrpcStatusException.of(Status).
Throwable	cause()	Deprecated. Use GrpcStatusException.fromThrowable(Throwable) to create a GrpcStatusException then Throwable.getCause().
GrpcStatusCode	code()	Returns the status code.
String	description()	Returns additional descriptions, can be null.
boolean	equals(Object o)
static GrpcStatus	fromCodeValue(int codeValue)	Obtains the status given an integer code value.
static GrpcStatus	fromCodeValue(String codeValue)	Obtains the status given a code value string.
static GrpcStatus	fromThrowable(Throwable t)	Deprecated. Use GrpcStatusException.fromThrowable(Throwable).
static GrpcStatus	fromThrowableNullable(Throwable t)	Deprecated. Use GrpcStatusException.fromThrowable(Throwable).
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GrpcStatus

public GrpcStatus(GrpcStatusCode code)

Constructs a status with no cause or description.

Parameters:

code - status code.

GrpcStatus

@Deprecated
public GrpcStatus(GrpcStatusCode code,
 @Nullable
 Throwable cause)

Deprecated.

Use GrpcStatusException if there is a Throwable cause.

Constructs a status with cause but no additional description.

Parameters:

code - status code.

cause - cause.

GrpcStatus

@Deprecated
public GrpcStatus(GrpcStatusCode code,
 @Nullable
 Throwable cause,
 @Nullable
 CharSequence description)

Deprecated.

Use GrpcStatusException if there is a cause or GrpcStatus(GrpcStatusCode, String).

Constructs a status with cause and additional description.

Parameters:

code - status code.

cause - cause.

description - additional description.

GrpcStatus

public GrpcStatus(GrpcStatusCode code,
 @Nullable
 String description)

Constructs a status with cause and additional description.

Parameters:

code - status code.

description - additional description.

Method Details

fromCodeValue

public static GrpcStatus fromCodeValue(String codeValue)

Obtains the status given a code value string.

Parameters:

codeValue - code value string.

Returns:

status associated with the code value, or GrpcStatusCode.UNKNOWN.

fromCodeValue

public static GrpcStatus fromCodeValue(int codeValue)

Obtains the status given an integer code value.

Parameters:

codeValue - integer code value.

Returns:

status associated with the code value, or GrpcStatusCode.UNKNOWN.

fromThrowable

@Deprecated
public static GrpcStatus fromThrowable(Throwable t)

Deprecated.

Use GrpcStatusException.fromThrowable(Throwable).

Translates a throwable into a status.

Parameters:

t - the throwable.

Returns:

embedded status if the throwable is a GrpcStatusException, or an GrpcStatusCode.UNKNOWN status with the throwable as the cause.

fromThrowableNullable

@Nullable
@Deprecated
public static GrpcStatus fromThrowableNullable(Throwable t)

Deprecated.

Use GrpcStatusException.fromThrowable(Throwable).

Translates a throwable into a status.

Parameters:

t - the throwable.

Returns:

embedded status if the throwable is a GrpcStatusException, or null.

asException

@Deprecated
public GrpcStatusException asException()

Deprecated.

Use GrpcStatusException(GrpcStatus).

Returns the current status wrapped in a GrpcStatusException.

Returns:

the current status wrapped in a GrpcStatusException.

asException

@Deprecated
public GrpcStatusException asException(Supplier<com.google.rpc.Status> applicationStatusSupplier)

Deprecated.

Use GrpcStatusException.of(Status).

Returns the current status wrapped in a GrpcStatusException including the supplied details. The status code used by Status and the one of the GrpcStatus must be the same. Users should usually use GrpcStatusException.of(Status).

Parameters:

applicationStatusSupplier - the Supplier for the Status.

Returns:

the current status wrapped in a GrpcStatusException.

code

public GrpcStatusCode code()

Returns the status code.

Returns:

the status code.

cause

@Nullable
@Deprecated
public Throwable cause()

Deprecated.

Use GrpcStatusException.fromThrowable(Throwable) to create a GrpcStatusException then Throwable.getCause().

Returns the cause, can be null.

Returns:

the cause, can be null.

description

@Nullable
public String description()

Returns additional descriptions, can be null.

Returns:

additional descriptions, can be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object