Class GoogleRpcStatus

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

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.

public record GoogleRpcStatus : IEquatable<GoogleRpcStatus>

Inheritance

object

GoogleRpcStatus

Implements

IEquatable<GoogleRpcStatus>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Code

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

[JsonPropertyName("code")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? Code { get; set; }

Property Value

int?

Details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

[JsonPropertyName("details")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<Dictionary<string, object>>? Details { get; set; }

Property Value

List<Dictionary<string, object>>

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.

[JsonPropertyName("message")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Message { get; set; }

Property Value

string

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a GoogleRpcStatus object.

public static GoogleRpcStatus? FromJson(string jsonString, JsonSerializerOptions? options = null)

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

GoogleRpcStatus

The deserialized GoogleRpcStatus object, or null if deserialization fails.