Stay organized with collections Save and categorize content based on your preferences.
Represents success or an error with info about the error.
This class is typically used to indicate whether or not a function or other operation completed successfully. Success is indicated by an "OK" status. OK statuses will have .
code()
==
StatusCode::kOk
and .
ok()
== true
, with all other properties having empty values. All OK statuses are equal. Any non-OK Status
is considered an error. Users can inspect the error using the member functions, or they can simply stream the Status
object, and it will print itself in some human readable way (the streamed format may change over time and you should not depend on the specific format of a streamed Status
object remaining unchanged).
This is a regular value type that can be copied, moved, compared for equality, and streamed.
Constructors Status(Status const &)Copy construction and assignment.
Parameter Name Description
Status const &
Move construction and assignment.
Parameter Name Description
Status &&
Default constructor, initializes to StatusCode::kOk
.
Construct from a status code, message and (optional) error info.
Parameters Name Descriptioncode
StatusCode
the status code for the new Status
.
message
std::string
the message for the new Status
, ignored if code
is StatusCode::kOk
.
info
ErrorInfo
the ErrorInfo
for the new Status
, ignored if code
is SStatusCode::kOk
.
Copy construction and assignment.
Parameter Name Description
Status const &
Status &
operator=(Status &&)
Move construction and assignment.
Parameter Name Description
Status &&
Status &
Functions ok() const
Returns true if the status code is StatusCode::kOk
.
bool
code() const
Returns the status code.
Returns Type DescriptionStatusCode
message() const
Returns the message associated with the status.
This is always empty if code()
is StatusCode::kOk
.
std::string const &
error_info() const
Returns the additional error info associated with the status.
This is always a default-constructed error info if code()
is StatusCode::kOk
.
ErrorInfo const &
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["The page details the `Status` class in the Google Cloud C++ library, which represents the outcome of operations, indicating success or failure with accompanying error information."],["The `Status` class can be used by developers to check if functions have completed successfully, with the presence of an \"OK\" status implying success and the ability to inspect errors through the class's member functions otherwise."],["The latest version of the common library is version 2.37.0-rc, and the page provides links to documentation for this and a list of other versions, from 2.36.0 down to 2.10.1."],["The `Status` class is a regular value type that supports copy construction, move construction, equality comparisons, and streaming for human-readable output, but the specific format of the streamed output is subject to change."],["The `Status` class supports multiple constructors including the default constructor, as well as constructors for copying and moving values, and it has functions to get the status code, any potential error messages, and error information."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4