Sandbox::https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto

Repository navigation

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

syntax = "proto3";

package google.rpc;

import "google/protobuf/any.proto";

option go_package = "google.golang.org/genproto/googleapis/rpc/status;status";

option java_multiple_files = true;

option java_outer_classname = "StatusProto";

option java_package = "com.google.rpc";

option objc_class_prefix = "RPC";

// 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).

message Status {

// The status code, which should be an enum value of

// [google.rpc.Code][google.rpc.Code].

int32 code = 1;

// 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][google.rpc.Status.details] field, or localized

// by the client.

string message = 2;

// A list of messages that carry the error details. There is a common set of

// message types for APIs to use.

repeated google.protobuf.Any details = 3;

}