-
Notifications
You must be signed in to change notification settings - Fork 461
Expand file tree
/
Copy pathErrorInfo.php
More file actions
217 lines (202 loc) · 8.97 KB
/
ErrorInfo.php
File metadata and controls
217 lines (202 loc) · 8.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/rpc/error_details.proto
namespace Google\Rpc;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;
/**
* Describes the cause of the error with structured details.
* Example of an error when contacting the "pubsub.googleapis.com" API when it
* is not enabled:
* { "reason": "API_DISABLED"
* "domain": "googleapis.com"
* "metadata": {
* "resource": "projects/123",
* "service": "pubsub.googleapis.com"
* }
* }
* This response indicates that the pubsub.googleapis.com API is not enabled.
* Example of an error that is returned when attempting to create a Spanner
* instance in a region that is out of stock:
* { "reason": "STOCKOUT"
* "domain": "spanner.googleapis.com",
* "metadata": {
* "availableRegions": "us-central1,us-east2"
* }
* }
*
* Generated from protobuf message <code>google.rpc.ErrorInfo</code>
*/
class ErrorInfo extends \Google\Protobuf\Internal\Message
{
/**
* The reason of the error. This is a constant value that identifies the
* proximate cause of the error. Error reasons are unique within a particular
* domain of errors. This should be at most 63 characters and match a
* regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
* UPPER_SNAKE_CASE.
*
* Generated from protobuf field <code>string reason = 1;</code>
*/
protected $reason = '';
/**
* The logical grouping to which the "reason" belongs. The error domain
* is typically the registered service name of the tool or product that
* generates the error. Example: "pubsub.googleapis.com". If the error is
* generated by some common infrastructure, the error domain must be a
* globally unique value that identifies the infrastructure. For Google API
* infrastructure, the error domain is "googleapis.com".
*
* Generated from protobuf field <code>string domain = 2;</code>
*/
protected $domain = '';
/**
* Additional structured details about this error.
* Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
* ideally be lowerCamelCase. Also, they must be limited to 64 characters in
* length. When identifying the current value of an exceeded limit, the units
* should be contained in the key, not the value. For example, rather than
* `{"instanceLimit": "100/request"}`, should be returned as,
* `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
* instances that can be created in a single (batch) request.
*
* Generated from protobuf field <code>map<string, string> metadata = 3;</code>
*/
private $metadata;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $reason
* The reason of the error. This is a constant value that identifies the
* proximate cause of the error. Error reasons are unique within a particular
* domain of errors. This should be at most 63 characters and match a
* regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
* UPPER_SNAKE_CASE.
* @type string $domain
* The logical grouping to which the "reason" belongs. The error domain
* is typically the registered service name of the tool or product that
* generates the error. Example: "pubsub.googleapis.com". If the error is
* generated by some common infrastructure, the error domain must be a
* globally unique value that identifies the infrastructure. For Google API
* infrastructure, the error domain is "googleapis.com".
* @type array|\Google\Protobuf\Internal\MapField $metadata
* Additional structured details about this error.
* Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
* ideally be lowerCamelCase. Also, they must be limited to 64 characters in
* length. When identifying the current value of an exceeded limit, the units
* should be contained in the key, not the value. For example, rather than
* `{"instanceLimit": "100/request"}`, should be returned as,
* `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
* instances that can be created in a single (batch) request.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Rpc\ErrorDetails::initOnce();
parent::__construct($data);
}
/**
* The reason of the error. This is a constant value that identifies the
* proximate cause of the error. Error reasons are unique within a particular
* domain of errors. This should be at most 63 characters and match a
* regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
* UPPER_SNAKE_CASE.
*
* Generated from protobuf field <code>string reason = 1;</code>
* @return string
*/
public function getReason()
{
return $this->reason;
}
/**
* The reason of the error. This is a constant value that identifies the
* proximate cause of the error. Error reasons are unique within a particular
* domain of errors. This should be at most 63 characters and match a
* regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
* UPPER_SNAKE_CASE.
*
* Generated from protobuf field <code>string reason = 1;</code>
* @param string $var
* @return $this
*/
public function setReason($var)
{
GPBUtil::checkString($var, True);
$this->reason = $var;
return $this;
}
/**
* The logical grouping to which the "reason" belongs. The error domain
* is typically the registered service name of the tool or product that
* generates the error. Example: "pubsub.googleapis.com". If the error is
* generated by some common infrastructure, the error domain must be a
* globally unique value that identifies the infrastructure. For Google API
* infrastructure, the error domain is "googleapis.com".
*
* Generated from protobuf field <code>string domain = 2;</code>
* @return string
*/
public function getDomain()
{
return $this->domain;
}
/**
* The logical grouping to which the "reason" belongs. The error domain
* is typically the registered service name of the tool or product that
* generates the error. Example: "pubsub.googleapis.com". If the error is
* generated by some common infrastructure, the error domain must be a
* globally unique value that identifies the infrastructure. For Google API
* infrastructure, the error domain is "googleapis.com".
*
* Generated from protobuf field <code>string domain = 2;</code>
* @param string $var
* @return $this
*/
public function setDomain($var)
{
GPBUtil::checkString($var, True);
$this->domain = $var;
return $this;
}
/**
* Additional structured details about this error.
* Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
* ideally be lowerCamelCase. Also, they must be limited to 64 characters in
* length. When identifying the current value of an exceeded limit, the units
* should be contained in the key, not the value. For example, rather than
* `{"instanceLimit": "100/request"}`, should be returned as,
* `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
* instances that can be created in a single (batch) request.
*
* Generated from protobuf field <code>map<string, string> metadata = 3;</code>
* @return \Google\Protobuf\Internal\MapField
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* Additional structured details about this error.
* Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
* ideally be lowerCamelCase. Also, they must be limited to 64 characters in
* length. When identifying the current value of an exceeded limit, the units
* should be contained in the key, not the value. For example, rather than
* `{"instanceLimit": "100/request"}`, should be returned as,
* `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
* instances that can be created in a single (batch) request.
*
* Generated from protobuf field <code>map<string, string> metadata = 3;</code>
* @param array|\Google\Protobuf\Internal\MapField $var
* @return $this
*/
public function setMetadata($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->metadata = $arr;
return $this;
}
}