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