Struct ErrorInfo 

#[non_exhaustive]
pub struct ErrorInfo {
    pub domain: Option<String>,
    pub metadatas: HashMap<String, String>,
    pub reason: Option<String>,
    /* private fields */
}

Available on crate features addresses or autoscalers or backend-buckets or backend-services or cross-site-networks or disks or external-vpn-gateways or firewall-policies or firewalls or forwarding-rules or future-reservations or global-addresses or global-forwarding-rules or global-network-endpoint-groups or global-operations or global-organization-operations or global-public-delegated-prefixes or health-checks or http-health-checks or https-health-checks or images or instance-group-manager-resize-requests or instance-group-managers or instance-groups or instance-settings or instance-templates or instances or instant-snapshots or interconnect-attachment-groups or interconnect-attachments or interconnect-groups or interconnects or licenses or machine-images or network-attachments or network-edge-security-services or network-endpoint-groups or network-firewall-policies or networks or node-groups or node-templates or organization-security-policies or packet-mirrorings or preview-features or projects or public-advertised-prefixes or public-delegated-prefixes or region-autoscalers or region-backend-services or region-commitments or region-disks or region-health-check-services or region-health-checks or region-instance-group-managers or region-instance-groups or region-instance-templates or region-instances or region-instant-snapshots or region-network-endpoint-groups or region-network-firewall-policies or region-notification-endpoints or region-operations or region-security-policies or region-ssl-certificates or region-ssl-policies or region-target-http-proxies or region-target-https-proxies or region-target-tcp-proxies or region-url-maps or reservation-blocks or reservation-slots or reservation-sub-blocks or reservations or resource-policies or routers or routes or security-policies or service-attachments or snapshot-settings or snapshots or ssl-certificates or ssl-policies or storage-pools or subnetworks or target-grpc-proxies or target-http-proxies or target-https-proxies or target-instances or target-pools or target-ssl-proxies or target-tcp-proxies or target-vpn-gateways or url-maps or vpn-gateways or vpn-tunnels or wire-groups or zone-operations only.

Describes the cause of the error with structured details.

Example of an error when contacting the “pubsub.googleapis.com” API when it is not enabled:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

This response indicates that the pubsub.googleapis.com API is not enabled.

Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain: Option<String>

The logical grouping to which the “reason” belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: “pubsub.googleapis.com”. If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is “googleapis.com”.

metadatas: HashMap<String, String>

Additional structured details about this error.

Keys must match a regular expression of a-z+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

reason: Option<String>

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Implementations

impl ErrorInfo

pub fn new() -> Self

pub fn set_domain<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of domain.

Example

let x = ErrorInfo::new().set_domain("example");

pub fn set_or_clear_domain<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of domain.

Example

let x = ErrorInfo::new().set_or_clear_domain(Some("example"));
let x = ErrorInfo::new().set_or_clear_domain(None::<String>);

pub fn set_metadatas<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of metadatas.

Example

let x = ErrorInfo::new().set_metadatas([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_reason<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of reason.

Example

let x = ErrorInfo::new().set_reason("example");

pub fn set_or_clear_reason<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of reason.

Example

let x = ErrorInfo::new().set_or_clear_reason(Some("example"));
let x = ErrorInfo::new().set_or_clear_reason(None::<String>);

Trait Implementations

impl Clone for ErrorInfo

fn clone(&self) -> ErrorInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ErrorInfo

fn default() -> ErrorInfo

Returns the “default value” for a type.

impl Message for ErrorInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ErrorInfo

fn eq(&self, other: &ErrorInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ErrorInfo