Struct google_ml1_beta1::GoogleRpc__Status
source · pub struct GoogleRpc__Status {
pub message: Option<String>,
pub code: Option<i32>,
pub details: Option<Vec<HashMap<String, String>>>,
}
Expand description
The Status
type defines a logical error model that is suitable for different
programming environments, including REST APIs and RPC APIs. It is used by
gRPC. The error model is designed to be:
- Simple to use and understand for most users
- Flexible enough to meet unexpected needs
§Overview
The Status
message contains three pieces of data: error code, error message,
and error details. The error code should be an enum value of
google.rpc.Code, but it may accept additional error codes if needed. The
error message should be a developer-facing English message that helps
developers understand and resolve the error. If a localized user-facing
error message is needed, put the localized message in the error details or
localize it in the client. The optional error details may contain arbitrary
information about the error. There is a predefined set of error detail types
in the package google.rpc
that can be used for common error conditions.
§Language mapping
The Status
message is the logical representation of the error model, but it
is not necessarily the actual wire format. When the Status
message is
exposed in different client libraries and different wire protocols, it can be
mapped differently. For example, it will likely be mapped to some exceptions
in Java, but more likely mapped to some error codes in C.
§Other uses
The error model and the Status
message can be used in a variety of
environments, either with or without APIs, to provide a
consistent developer experience across different environments.
Example uses of this error model include:
-
Partial errors. If a service needs to return partial errors to the client, it may embed the
Status
in the normal response to indicate the partial errors. -
Workflow errors. A typical workflow has multiple steps. Each step may have a
Status
message for error reporting. -
Batch operations. If a client uses batch request and batch response, the
Status
message should be used directly inside batch response, one for each error sub-response. -
Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the
Status
message. -
Logging. If some API errors are stored in logs, the message
Status
could be used directly after any stripping needed for security/privacy reasons.
This type is not used in any activity, and only used as part of another schema.
Fields§
§message: Option<String>
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code: Option<i32>
The status code, which should be an enum value of google.rpc.Code.
details: Option<Vec<HashMap<String, String>>>
A list of messages that carry the error details. There will be a common set of message types for APIs to use.
Trait Implementations§
source§impl Clone for GoogleRpc__Status
impl Clone for GoogleRpc__Status
source§fn clone(&self) -> GoogleRpc__Status
fn clone(&self) -> GoogleRpc__Status
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GoogleRpc__Status
impl Debug for GoogleRpc__Status
source§impl Default for GoogleRpc__Status
impl Default for GoogleRpc__Status
source§fn default() -> GoogleRpc__Status
fn default() -> GoogleRpc__Status
source§impl Deserialize for GoogleRpc__Status
impl Deserialize for GoogleRpc__Status
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer,
source§impl Serialize for GoogleRpc__Status
impl Serialize for GoogleRpc__Status
impl Part for GoogleRpc__Status
Auto Trait Implementations§
impl Freeze for GoogleRpc__Status
impl RefUnwindSafe for GoogleRpc__Status
impl Send for GoogleRpc__Status
impl Sync for GoogleRpc__Status
impl Unpin for GoogleRpc__Status
impl UnwindSafe for GoogleRpc__Status
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more