Uses of Class
io.grpc.Status
Packages that use Status
Package
Description
The gRPC core public API.
Interfaces and implementations that are internal to gRPC.
API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf
messages.
Utilities with advanced features in the core layer that user can optionally use.
-
Uses of Status in io.grpc
Modifier and TypeFieldDescriptionstatic final Status
Status.ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.static final Status
Status.ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.static final Status
Status.CANCELLED
The operation was cancelled (typically by the caller).static final Status
Status.DATA_LOSS
Unrecoverable data loss or corruption.static final Status
Status.DEADLINE_EXCEEDED
Deadline expired before operation could complete.static final Status
Status.FAILED_PRECONDITION
Operation was rejected because the system is not in a state required for the operation's execution.static final Status
Status.INTERNAL
Internal errors.static final Status
Status.INVALID_ARGUMENT
Client specified an invalid argument.static final Status
Status.NOT_FOUND
Some requested entity (e.g., file or directory) was not found.static final Status
Status.OK
The operation completed successfully.static final Status
Status.OUT_OF_RANGE
Operation was attempted past the valid range.static final Status
Status.PERMISSION_DENIED
The caller does not have permission to execute the specified operation.static final Status
Status.RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.static final Status
Status.UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.static final Status
Status.UNAVAILABLE
The service is currently unavailable.static final Status
Status.UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.static final Status
Status.UNKNOWN
Unknown error.Modifier and TypeFieldDescriptionstatic final Metadata.Key
<Status> InternalStatus.CODE_KEY
Key to bind status code to trailing metadata.Modifier and TypeMethodDescriptionLoadBalancer.acceptResolvedAddresses
(LoadBalancer.ResolvedAddresses resolvedAddresses) Accepts newly resolved addresses from the name resolution system.Status.augmentDescription
(String additionalDetail) Create a derived instance ofStatus
augmenting the current description with additional detail.static Status
Status.fromCode
(Status.Code code) Return aStatus
given a canonical errorStatus.Code
object.static Status
Status.fromCodeValue
(int codeValue) Return aStatus
given a canonical errorStatus.Code
value.static Status
Status.fromThrowable
(Throwable t) NameResolver.ConfigOrError.getError()
Returns error status if exists, otherwise null.ConnectivityStateInfo.getStatus()
Returns the status associated with the state.InternalConfigSelector.Result.getStatus()
Returns the status of the config selection operation.LoadBalancer.PickResult.getStatus()
The status associated with this result.final Status
StatusException.getStatus()
Returns the status code as aStatus
object.StatusOr.getStatus()
Returns the status.final Status
StatusRuntimeException.getStatus()
Returns the status code as aStatus
object.NameResolver.Listener2.onResult2
(NameResolver.ResolutionResult resolutionResult) Handles updates on resolved addresses and attributes.static Status
Contexts.statusFromCancelled
(Context context) Returns theStatus
of a cancelled context ornull
if the context is not cancelled.Status.Code.toStatus()
Returns aStatus
object corresponding to this status code.Create a derived instance ofStatus
with the given cause.Status.withDescription
(String description) Create a derived instance ofStatus
with the given description.Modifier and TypeMethodDescriptionstatic final StatusRuntimeException
InternalStatus.asRuntimeException
(Status status, Metadata trailers, boolean fillInStackTrace) Create a newStatusRuntimeException
with the internal option of skipping the filling of the stack trace.abstract void
Close the call with the provided status.abstract void
Called when there has been an error when preparing the headers.Creates aResult
with the given error status.static ConnectivityStateInfo
ConnectivityStateInfo.forTransientFailure
(Status error) Returns an instance forTRANSIENT_FAILURE
, associated with an error status.static NameResolver.ConfigOrError
Returns aNameResolver.ConfigOrError
for the failure to parse the config.static <T> StatusOr
<T> StatusOr.fromStatus
(Status status) Construct from a non-Ok status.abstract void
LoadBalancer.handleNameResolutionError
(Status error) Handles an error from the name resolution system.void
The ClientCall has been closed.void
Handles an error from the resolver.abstract void
Handles a name resolving error from the resolver.void
StreamTracer.streamClosed
(Status status) Stream is closed.static LoadBalancer.PickResult
A decision to fail an RPC immediately.static LoadBalancer.PickResult
A decision to report a connectivity error to the RPC.ModifierConstructorDescriptionErrorPicker
(Status error) Deprecated.StatusException
(Status status) Constructs an exception with both a status.StatusException
(Status status, Metadata trailers) Constructs an exception with both a status and trailers.StatusRuntimeException
(Status status) Constructs the exception with a status.StatusRuntimeException
(Status status, Metadata trailers) Constructs the exception with both a status and trailers. -
Uses of Status in io.grpc.internal
Methods in io.grpc.internal that return StatusModifier and TypeMethodDescriptionstatic Status
GrpcUtil.httpStatusToGrpcStatus
(int httpStatusCode) Maps HTTP error response status codes to transport codes, as defined in http-grpc-status-mapping.md.static Status
GrpcUtil.replaceInappropriateControlPlaneStatus
(Status status) Some status codes from the control plane are not appropritate to use in the data plane.GrpcUtil.Http2Error.status()
Gets theStatus
associated with this HTTP/2 code.static Status
GrpcUtil.Http2Error.statusForCode
(long code) Looks up theStatus
from the given HTTP/2 error code.Methods in io.grpc.internal with parameters of type StatusModifier and TypeMethodDescriptionfinal void
void
Tears down the stream, typically in the event of a timeout.final void
void
Tears down the stream, typically in the event of a timeout.void
Abnormally terminates the stream.void
void
Tears down the stream, typically in the event of a timeout.final void
void
Closes the stream for both reading and writing.void
ClientStreamListener.closed
(Status status, ClientStreamListener.RpcProgress rpcProgress, Metadata trailers) Called when the stream is fully closed.void
Called when the stream is fully closed.protected abstract void
Http2ClientStreamTransportState.http2ProcessingFailed
(Status status, boolean stopDelivery, Metadata trailers) Called to process a failure in HTTP/2 processing.protected void
AbstractClientStream.TransportState.inboundTrailersReceived
(Metadata trailers, Status status) Processes the trailers and status from the server.static Status
GrpcUtil.replaceInappropriateControlPlaneStatus
(Status status) Some status codes from the control plane are not appropritate to use in the data plane.void
Initiates an orderly shutdown of the transport.void
ManagedClientTransport.shutdownNow
(Status reason) Initiates a forceful shutdown in which preexisting and new calls are closed.void
ServerTransport.shutdownNow
(Status reason) Initiates a forceful shutdown in which preexisting and new calls are closed.void
ForwardingClientStreamTracer.streamClosed
(Status status) void
StatsTraceContext.streamClosed
(Status status) final void
AbstractClientStream.TransportState.transportReportStatus
(Status status, boolean stopDelivery, Metadata trailers) Report stream closure with status to the application layer if not already reported.final void
AbstractClientStream.TransportState.transportReportStatus
(Status status, ClientStreamListener.RpcProgress rpcProgress, boolean stopDelivery, Metadata trailers) Report stream closure with status to the application layer if not already reported.final void
AbstractServerStream.TransportState.transportReportStatus
(Status status) Notifies failure to the listener of the stream.void
ManagedClientTransport.Listener.transportShutdown
(Status s) The transport is shutting down.void
AbstractServerStream.Sink.writeTrailers
(Metadata trailers, boolean headersSent, Status status) Sends trailers to the remote end point.Constructors in io.grpc.internal with parameters of type StatusModifierConstructorDescriptionFailingClientStream
(Status error, ClientStreamTracer[] tracers) Creates aFailingClientStream
that would fail with the given error.FailingClientStream
(Status error, ClientStreamListener.RpcProgress rpcProgress, ClientStreamTracer[] tracers) Creates aFailingClientStream
that would fail with the given error. -
Uses of Status in io.grpc.protobuf
Methods in io.grpc.protobuf with parameters of type StatusModifier and TypeMethodDescriptionstatic com.google.rpc.Status
StatusProto.fromStatusAndTrailers
(Status status, Metadata trailers) Extracts thegoogle.rpc.Status
from trailers, and makes sure they match the gRPCstatus
. -
Uses of Status in io.grpc.util
Fields in io.grpc.util declared as StatusModifier and TypeFieldDescriptionfinal Status
MultiChildLoadBalancer.AcceptResolvedAddrRetVal.status
Methods in io.grpc.util that return StatusModifier and TypeMethodDescriptionGracefulSwitchLoadBalancer.acceptResolvedAddresses
(LoadBalancer.ResolvedAddresses resolvedAddresses) MultiChildLoadBalancer.acceptResolvedAddresses
(LoadBalancer.ResolvedAddresses resolvedAddresses) Override to completely replace the default logic or to do additional activities.OutlierDetectionLoadBalancer.acceptResolvedAddresses
(LoadBalancer.ResolvedAddresses resolvedAddresses) Methods in io.grpc.util with parameters of type StatusModifier and TypeMethodDescriptionvoid
ForwardingLoadBalancer.handleNameResolutionError
(Status error) void
MultiChildLoadBalancer.handleNameResolutionError
(Status error) Handle the name resolution error.void
OutlierDetectionLoadBalancer.handleNameResolutionError
(Status error) void
ForwardingClientStreamTracer.streamClosed
(Status status) Constructors in io.grpc.util with parameters of type StatusModifierConstructorDescriptionAcceptResolvedAddrRetVal
(Status status, List<MultiChildLoadBalancer.ChildLbState> removedChildren)