google-genai/com.google.genai.types/GoogleRpcStatus

GoogleRpcStatus

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.

Constructors

GoogleRpcStatus

public void GoogleRpcStatus()

Types

public abstract class Builder

Builder for GoogleRpcStatus.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

public static GoogleRpcStatus.Builder builder()

Instantiates a builder for GoogleRpcStatus.

public abstract Optional<Integer> code()

The status code, which should be an enum value of google.rpc.Code.

public abstract Optional<List<Map<String, Object>>> details()

A list of messages that carry the error details.

public static GoogleRpcStatus fromJson(String jsonString)

Deserializes a JSON string to a GoogleRpcStatus object.

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

public abstract Optional<String> message()

A developer-facing error message, which should be in English.

public static ObjectMapper objectMapper()

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

public abstract GoogleRpcStatus.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.