blob: 0b9907f89b26b28eed74f4ac7895a30d3e85a81a [file] [log] [blame]
William Kurkianea869482019-04-09 15:16:11 -04001// Code generated by protoc-gen-go. DO NOT EDIT.
2// source: google/rpc/status.proto
Abhilash S.L3b494632019-07-16 15:51:09 +05304package status
William Kurkianea869482019-04-09 15:16:11 -04005
Abhilash S.L3b494632019-07-16 15:51:09 +05306import (
7 fmt "fmt"
8 math "math"
10 proto ""
11 any ""
William Kurkianea869482019-04-09 15:16:11 -040013
14// Reference imports to suppress errors if they are not otherwise used.
15var _ = proto.Marshal
16var _ = fmt.Errorf
17var _ = math.Inf
19// This is a compile-time assertion to ensure that this generated file
20// is compatible with the proto package it is being compiled against.
21// A compilation error at this line likely means your copy of the
22// proto package needs to be updated.
Abhilash S.L3b494632019-07-16 15:51:09 +053023const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package
William Kurkianea869482019-04-09 15:16:11 -040024
25// The `Status` type defines a logical error model that is suitable for
26// different programming environments, including REST APIs and RPC APIs. It is
27// used by [gRPC]( The error model is designed to be:
29// - Simple to use and understand for most users
30// - Flexible enough to meet unexpected needs
32// # Overview
34// The `Status` message contains three pieces of data: error code, error
35// message, and error details. The error code should be an enum value of
36// [google.rpc.Code][google.rpc.Code], but it may accept additional error codes
37// if needed. The error message should be a developer-facing English message
38// that helps developers *understand* and *resolve* the error. If a localized
39// user-facing error message is needed, put the localized message in the error
40// details or localize it in the client. The optional error details may contain
41// arbitrary information about the error. There is a predefined set of error
42// detail types in the package `google.rpc` that can be used for common error
43// conditions.
45// # Language mapping
47// The `Status` message is the logical representation of the error model, but it
48// is not necessarily the actual wire format. When the `Status` message is
49// exposed in different client libraries and different wire protocols, it can be
50// mapped differently. For example, it will likely be mapped to some exceptions
51// in Java, but more likely mapped to some error codes in C.
53// # Other uses
55// The error model and the `Status` message can be used in a variety of
56// environments, either with or without APIs, to provide a
57// consistent developer experience across different environments.
59// Example uses of this error model include:
61// - Partial errors. If a service needs to return partial errors to the client,
62// it may embed the `Status` in the normal response to indicate the partial
63// errors.
65// - Workflow errors. A typical workflow has multiple steps. Each step may
66// have a `Status` message for error reporting.
68// - Batch operations. If a client uses batch request and batch response, the
69// `Status` message should be used directly inside batch response, one for
70// each error sub-response.
72// - Asynchronous operations. If an API call embeds asynchronous operation
73// results in its response, the status of those operations should be
74// represented directly using the `Status` message.
76// - Logging. If some API errors are stored in logs, the message `Status` could
77// be used directly after any stripping needed for security/privacy reasons.
78type Status struct {
79 // The status code, which should be an enum value of
80 // [google.rpc.Code][google.rpc.Code].
81 Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
82 // A developer-facing error message, which should be in English. Any
83 // user-facing error message should be localized and sent in the
84 // [google.rpc.Status.details][google.rpc.Status.details] field, or localized
85 // by the client.
86 Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
87 // A list of messages that carry the error details. There is a common set of
88 // message types for APIs to use.
89 Details []*any.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
90 XXX_NoUnkeyedLiteral struct{} `json:"-"`
91 XXX_unrecognized []byte `json:"-"`
92 XXX_sizecache int32 `json:"-"`
95func (m *Status) Reset() { *m = Status{} }
96func (m *Status) String() string { return proto.CompactTextString(m) }
97func (*Status) ProtoMessage() {}
98func (*Status) Descriptor() ([]byte, []int) {
Abhilash S.L3b494632019-07-16 15:51:09 +053099 return fileDescriptor_24d244abaf643bfe, []int{0}
William Kurkianea869482019-04-09 15:16:11 -0400100}
Abhilash S.L3b494632019-07-16 15:51:09 +0530101
William Kurkianea869482019-04-09 15:16:11 -0400102func (m *Status) XXX_Unmarshal(b []byte) error {
103 return xxx_messageInfo_Status.Unmarshal(m, b)
105func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
106 return xxx_messageInfo_Status.Marshal(b, m, deterministic)
Abhilash S.L3b494632019-07-16 15:51:09 +0530108func (m *Status) XXX_Merge(src proto.Message) {
109 xxx_messageInfo_Status.Merge(m, src)
William Kurkianea869482019-04-09 15:16:11 -0400110}
111func (m *Status) XXX_Size() int {
112 return xxx_messageInfo_Status.Size(m)
114func (m *Status) XXX_DiscardUnknown() {
115 xxx_messageInfo_Status.DiscardUnknown(m)
118var xxx_messageInfo_Status proto.InternalMessageInfo
120func (m *Status) GetCode() int32 {
121 if m != nil {
122 return m.Code
123 }
124 return 0
127func (m *Status) GetMessage() string {
128 if m != nil {
129 return m.Message
130 }
131 return ""
134func (m *Status) GetDetails() []*any.Any {
135 if m != nil {
136 return m.Details
137 }
138 return nil
141func init() {
142 proto.RegisterType((*Status)(nil), "google.rpc.Status")
Abhilash S.L3b494632019-07-16 15:51:09 +0530145func init() { proto.RegisterFile("google/rpc/status.proto", fileDescriptor_24d244abaf643bfe) }
William Kurkianea869482019-04-09 15:16:11 -0400146
Abhilash S.L3b494632019-07-16 15:51:09 +0530147var fileDescriptor_24d244abaf643bfe = []byte{
William Kurkianea869482019-04-09 15:16:11 -0400148 // 209 bytes of a gzipped FileDescriptorProto
149 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0x12, 0x4f, 0xcf, 0xcf, 0x4f,
150 0xcf, 0x49, 0xd5, 0x2f, 0x2a, 0x48, 0xd6, 0x2f, 0x2e, 0x49, 0x2c, 0x29, 0x2d, 0xd6, 0x2b, 0x28,
151 0xca, 0x2f, 0xc9, 0x17, 0xe2, 0x82, 0x48, 0xe8, 0x15, 0x15, 0x24, 0x4b, 0x49, 0x42, 0x15, 0x81,
152 0x65, 0x92, 0x4a, 0xd3, 0xf4, 0x13, 0xf3, 0x2a, 0x21, 0xca, 0x94, 0xd2, 0xb8, 0xd8, 0x82, 0xc1,
153 0xda, 0x84, 0x84, 0xb8, 0x58, 0x92, 0xf3, 0x53, 0x52, 0x25, 0x18, 0x15, 0x18, 0x35, 0x58, 0x83,
154 0xc0, 0x6c, 0x21, 0x09, 0x2e, 0xf6, 0xdc, 0xd4, 0xe2, 0xe2, 0xc4, 0xf4, 0x54, 0x09, 0x26, 0x05,
155 0x46, 0x0d, 0xce, 0x20, 0x18, 0x57, 0x48, 0x8f, 0x8b, 0x3d, 0x25, 0xb5, 0x24, 0x31, 0x33, 0xa7,
156 0x58, 0x82, 0x59, 0x81, 0x59, 0x83, 0xdb, 0x48, 0x44, 0x0f, 0x6a, 0x21, 0xcc, 0x12, 0x3d, 0xc7,
157 0xbc, 0xca, 0x20, 0x98, 0x22, 0xa7, 0x38, 0x2e, 0xbe, 0xe4, 0xfc, 0x5c, 0x3d, 0x84, 0xa3, 0x9c,
158 0xb8, 0x21, 0xf6, 0x06, 0x80, 0x94, 0x07, 0x30, 0x46, 0x99, 0x43, 0xa5, 0xd2, 0xf3, 0x73, 0x12,
159 0xf3, 0xd2, 0xf5, 0xf2, 0x8b, 0xd2, 0xf5, 0xd3, 0x53, 0xf3, 0xc0, 0x86, 0xe9, 0x43, 0xa4, 0x12,
160 0x0b, 0x32, 0x8b, 0x91, 0xfc, 0x69, 0x0d, 0xa1, 0x16, 0x31, 0x31, 0x07, 0x05, 0x38, 0x27, 0xb1,
161 0x81, 0x55, 0x1a, 0x03, 0x02, 0x00, 0x00, 0xff, 0xff, 0xa4, 0x53, 0xf0, 0x7c, 0x10, 0x01, 0x00,
162 0x00,