Class GoogleRpcStatus
-
- All Implemented Interfaces:
public abstract class GoogleRpcStatus extends JsonSerializable
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](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). This data type is not supported in Gemini API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classGoogleRpcStatus.BuilderBuilder for GoogleRpcStatus.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description GoogleRpcStatus()
-
Method Summary
Modifier and Type Method Description abstract Optional<Integer>code()The status code, which should be an enum value of google.rpc.Code. abstract Optional<List<Map<String, Object>>>details()A list of messages that carry the error details. abstract Optional<String>message()A developer-facing error message, which should be in English. static GoogleRpcStatus.Builderbuilder()Instantiates a builder for GoogleRpcStatus. abstract GoogleRpcStatus.BuildertoBuilder()Creates a builder with the same values as this instance. static GoogleRpcStatusfromJson(String jsonString)Deserializes a JSON string to a GoogleRpcStatus object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
code
abstract Optional<Integer> code()
The status code, which should be an enum value of google.rpc.Code.
-
details
abstract Optional<List<Map<String, Object>>> details()
A list of messages that carry the error details. There is a common set of message types for APIs to use.
-
message
abstract Optional<String> message()
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.
-
builder
static GoogleRpcStatus.Builder builder()
Instantiates a builder for GoogleRpcStatus.
-
toBuilder
abstract GoogleRpcStatus.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static GoogleRpcStatus fromJson(String jsonString)
Deserializes a JSON string to a GoogleRpcStatus object.
-
-
-
-