PluginProbe ʕ •ᴥ•ʔ
ShareThis Dashboard for Google Analytics / 3.1.2
ShareThis Dashboard for Google Analytics v3.1.2
3.3.2 trunk 1.0.7 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5 2.1 2.1.2 2.1.3 2.1.4 2.1.5 2.2.5 2.3.5 2.3.6 2.3.7 2.3.8 2.4.0 2.4.1 2.5.0 2.5.1 2.5.2 2.5.3 2.5.4 2.5.5 3.0.0 3.1.0 3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 3.1.7 3.2.0 3.2.1 3.2.2 3.2.3 3.2.4 3.3.0 3.3.1
googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api / QuotaLimit.php
googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api Last commit date
BackendRule 3 years ago Billing 3 years ago Distribution 3 years ago Expr 3 years ago LabelDescriptor 3 years ago Logging 3 years ago MetricDescriptor 3 years ago Monitoring 3 years ago Property 3 years ago ResourceDescriptor 3 years ago Advice.php 3 years ago AuthProvider.php 3 years ago AuthRequirement.php 3 years ago Authentication.php 3 years ago AuthenticationRule.php 3 years ago Backend.php 3 years ago BackendRule.php 3 years ago BackendRule_PathTranslation.php 3 years ago Billing.php 3 years ago Billing_BillingDestination.php 3 years ago ChangeType.php 3 years ago ConfigChange.php 3 years ago Context.php 3 years ago ContextRule.php 3 years ago Control.php 3 years ago CustomHttpPattern.php 3 years ago Distribution.php 3 years ago Distribution_BucketOptions.php 3 years ago Distribution_BucketOptions_Explicit.php 3 years ago Distribution_BucketOptions_Exponential.php 3 years ago Distribution_BucketOptions_Linear.php 3 years ago Distribution_Exemplar.php 3 years ago Distribution_Range.php 3 years ago Documentation.php 3 years ago DocumentationRule.php 3 years ago Endpoint.php 3 years ago FieldBehavior.php 3 years ago Http.php 3 years ago HttpBody.php 3 years ago HttpRule.php 3 years ago LabelDescriptor.php 3 years ago LabelDescriptor_ValueType.php 3 years ago LaunchStage.php 3 years ago LogDescriptor.php 3 years ago Logging.php 3 years ago Logging_LoggingDestination.php 3 years ago Metric.php 3 years ago MetricDescriptor.php 3 years ago MetricDescriptor_MetricDescriptorMetadata.php 3 years ago MetricDescriptor_MetricKind.php 3 years ago MetricDescriptor_ValueType.php 3 years ago MetricRule.php 3 years ago MonitoredResource.php 3 years ago MonitoredResourceDescriptor.php 3 years ago MonitoredResourceMetadata.php 3 years ago Monitoring.php 3 years ago Monitoring_MonitoringDestination.php 3 years ago OAuthRequirements.php 3 years ago Page.php 3 years ago ProjectProperties.php 3 years ago Property.php 3 years ago Property_PropertyType.php 3 years ago Quota.php 3 years ago QuotaLimit.php 3 years ago ResourceDescriptor.php 3 years ago ResourceDescriptor_History.php 3 years ago ResourceReference.php 3 years ago RoutingParameter.php 3 years ago RoutingRule.php 3 years ago Service.php 3 years ago SourceInfo.php 3 years ago SystemParameter.php 3 years ago SystemParameterRule.php 3 years ago SystemParameters.php 3 years ago Usage.php 3 years ago UsageRule.php 3 years ago
QuotaLimit.php
752 lines
1 <?php
2 # Generated by the protocol buffer compiler. DO NOT EDIT!
3 # source: google/api/quota.proto
4
5 namespace Google\Api;
6
7 use Google\Protobuf\Internal\GPBType;
8 use Google\Protobuf\Internal\RepeatedField;
9 use Google\Protobuf\Internal\GPBUtil;
10
11 /**
12 * `QuotaLimit` defines a specific limit that applies over a specified duration
13 * for a limit type. There can be at most one limit for a duration and limit
14 * type combination defined within a `QuotaGroup`.
15 *
16 * Generated from protobuf message <code>google.api.QuotaLimit</code>
17 */
18 class QuotaLimit extends \Google\Protobuf\Internal\Message
19 {
20 /**
21 * Name of the quota limit. The name is used to refer to the limit when
22 * overriding the default limit on per-consumer basis.
23 * For group-based quota limits, the name must be unique within the quota
24 * group. If a name is not provided, it will be generated from the limit_by
25 * and duration fields.
26 * For metric-based quota limits, the name must be provided, and it must be
27 * unique within the service. The name can only include alphanumeric
28 * characters as well as '-'.
29 * The maximum length of the limit name is 64 characters.
30 * The name of a limit is used as a unique identifier for this limit.
31 * Therefore, once a limit has been put into use, its name should be
32 * immutable. You can use the display_name field to provide a user-friendly
33 * name for the limit. The display name can be evolved over time without
34 * affecting the identity of the limit.
35 *
36 * Generated from protobuf field <code>string name = 6;</code>
37 */
38 private $name = '';
39 /**
40 * Optional. User-visible, extended description for this quota limit.
41 * Should be used only when more context is needed to understand this limit
42 * than provided by the limit's display name (see: `display_name`).
43 *
44 * Generated from protobuf field <code>string description = 2;</code>
45 */
46 private $description = '';
47 /**
48 * Default number of tokens that can be consumed during the specified
49 * duration. This is the number of tokens assigned when a client
50 * application developer activates the service for his/her project.
51 * Specifying a value of 0 will block all requests. This can be used if you
52 * are provisioning quota to selected consumers and blocking others.
53 * Similarly, a value of -1 will indicate an unlimited quota. No other
54 * negative values are allowed.
55 * Used by group-based quotas only.
56 *
57 * Generated from protobuf field <code>int64 default_limit = 3;</code>
58 */
59 private $default_limit = 0;
60 /**
61 * Maximum number of tokens that can be consumed during the specified
62 * duration. Client application developers can override the default limit up
63 * to this maximum. If specified, this value cannot be set to a value less
64 * than the default limit. If not specified, it is set to the default limit.
65 * To allow clients to apply overrides with no upper bound, set this to -1,
66 * indicating unlimited maximum quota.
67 * Used by group-based quotas only.
68 *
69 * Generated from protobuf field <code>int64 max_limit = 4;</code>
70 */
71 private $max_limit = 0;
72 /**
73 * Free tier value displayed in the Developers Console for this limit.
74 * The free tier is the number of tokens that will be subtracted from the
75 * billed amount when billing is enabled.
76 * This field can only be set on a limit with duration "1d", in a billable
77 * group; it is invalid on any other limit. If this field is not set, it
78 * defaults to 0, indicating that there is no free tier for this service.
79 * Used by group-based quotas only.
80 *
81 * Generated from protobuf field <code>int64 free_tier = 7;</code>
82 */
83 private $free_tier = 0;
84 /**
85 * Duration of this limit in textual notation. Example: "100s", "24h", "1d".
86 * For duration longer than a day, only multiple of days is supported. We
87 * support only "100s" and "1d" for now. Additional support will be added in
88 * the future. "0" indicates indefinite duration.
89 * Used by group-based quotas only.
90 *
91 * Generated from protobuf field <code>string duration = 5;</code>
92 */
93 private $duration = '';
94 /**
95 * The name of the metric this quota limit applies to. The quota limits with
96 * the same metric will be checked together during runtime. The metric must be
97 * defined within the service config.
98 * Used by metric-based quotas only.
99 *
100 * Generated from protobuf field <code>string metric = 8;</code>
101 */
102 private $metric = '';
103 /**
104 * Specify the unit of the quota limit. It uses the same syntax as
105 * [Metric.unit][]. The supported unit kinds are determined by the quota
106 * backend system.
107 * The [Google Service Control](https://cloud.google.com/service-control)
108 * supports the following unit components:
109 * * One of the time intevals:
110 * * "/min" for quota every minute.
111 * * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
112 * * Otherwise the quota won't be reset by time, such as storage limit.
113 * * One and only one of the granted containers:
114 * * "/{organization}" quota for an organization.
115 * * "/{project}" quota for a project.
116 * * "/{folder}" quota for a folder.
117 * * "/{resource}" quota for a universal resource.
118 * * Zero or more quota segmentation dimension. Not all combos are valid.
119 * * "/{region}" quota for every region. Not to be used with time intervals.
120 * * Otherwise the resources granted on the target is not segmented.
121 * * "/{zone}" quota for every zone. Not to be used with time intervals.
122 * * Otherwise the resources granted on the target is not segmented.
123 * * "/{resource}" quota for a resource associated with a project or org.
124 * Here are some examples:
125 * * "1/min/{project}" for quota per minute per project.
126 * * "1/min/{user}" for quota per minute per user.
127 * * "1/min/{organization}" for quota per minute per organization.
128 * Note: the order of unit components is insignificant.
129 * The "1" at the beginning is required to follow the metric unit syntax.
130 * Used by metric-based quotas only.
131 *
132 * Generated from protobuf field <code>string unit = 9;</code>
133 */
134 private $unit = '';
135 /**
136 * Tiered limit values. Also allows for regional or zone overrides for these
137 * values if "/{region}" or "/{zone}" is specified in the unit field.
138 * Currently supported tiers from low to high:
139 * VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
140 * To apply different limit values for users according to their tiers, specify
141 * the values for the tiers you want to differentiate. For example:
142 * {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
143 * The limit value for each tier is optional except for the tier STANDARD.
144 * The limit value for an unspecified tier falls to the value of its next
145 * tier towards tier STANDARD. For the above example, the limit value for tier
146 * STANDARD is 500.
147 * To apply the same limit value for all users, just specify limit value for
148 * tier STANDARD. For example: {STANDARD:500}.
149 * To apply a regional overide for a tier, add a map entry with key
150 * "<TIER>/<region>", where <region> is a region name. Similarly, for a zone
151 * override, add a map entry with key "<TIER>/{zone}".
152 * Further, a wildcard can be used at the end of a zone name in order to
153 * specify zone level overrides. For example:
154 * LOW: 10, STANDARD: 50, HIGH: 100,
155 * LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,
156 * LOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80
157 * The regional overrides tier set for each region must be the same as
158 * the tier set for default limit values. Same rule applies for zone overrides
159 * tier as well.
160 * Used by metric-based quotas only.
161 *
162 * Generated from protobuf field <code>map<string, int64> values = 10;</code>
163 */
164 private $values;
165 /**
166 * User-visible display name for this limit.
167 * Optional. If not set, the UI will provide a default display name based on
168 * the quota configuration. This field can be used to override the default
169 * display name generated from the configuration.
170 *
171 * Generated from protobuf field <code>string display_name = 12;</code>
172 */
173 private $display_name = '';
174
175 /**
176 * Constructor.
177 *
178 * @param array $data {
179 * Optional. Data for populating the Message object.
180 *
181 * @type string $name
182 * Name of the quota limit. The name is used to refer to the limit when
183 * overriding the default limit on per-consumer basis.
184 * For group-based quota limits, the name must be unique within the quota
185 * group. If a name is not provided, it will be generated from the limit_by
186 * and duration fields.
187 * For metric-based quota limits, the name must be provided, and it must be
188 * unique within the service. The name can only include alphanumeric
189 * characters as well as '-'.
190 * The maximum length of the limit name is 64 characters.
191 * The name of a limit is used as a unique identifier for this limit.
192 * Therefore, once a limit has been put into use, its name should be
193 * immutable. You can use the display_name field to provide a user-friendly
194 * name for the limit. The display name can be evolved over time without
195 * affecting the identity of the limit.
196 * @type string $description
197 * Optional. User-visible, extended description for this quota limit.
198 * Should be used only when more context is needed to understand this limit
199 * than provided by the limit's display name (see: `display_name`).
200 * @type int|string $default_limit
201 * Default number of tokens that can be consumed during the specified
202 * duration. This is the number of tokens assigned when a client
203 * application developer activates the service for his/her project.
204 * Specifying a value of 0 will block all requests. This can be used if you
205 * are provisioning quota to selected consumers and blocking others.
206 * Similarly, a value of -1 will indicate an unlimited quota. No other
207 * negative values are allowed.
208 * Used by group-based quotas only.
209 * @type int|string $max_limit
210 * Maximum number of tokens that can be consumed during the specified
211 * duration. Client application developers can override the default limit up
212 * to this maximum. If specified, this value cannot be set to a value less
213 * than the default limit. If not specified, it is set to the default limit.
214 * To allow clients to apply overrides with no upper bound, set this to -1,
215 * indicating unlimited maximum quota.
216 * Used by group-based quotas only.
217 * @type int|string $free_tier
218 * Free tier value displayed in the Developers Console for this limit.
219 * The free tier is the number of tokens that will be subtracted from the
220 * billed amount when billing is enabled.
221 * This field can only be set on a limit with duration "1d", in a billable
222 * group; it is invalid on any other limit. If this field is not set, it
223 * defaults to 0, indicating that there is no free tier for this service.
224 * Used by group-based quotas only.
225 * @type string $duration
226 * Duration of this limit in textual notation. Example: "100s", "24h", "1d".
227 * For duration longer than a day, only multiple of days is supported. We
228 * support only "100s" and "1d" for now. Additional support will be added in
229 * the future. "0" indicates indefinite duration.
230 * Used by group-based quotas only.
231 * @type string $metric
232 * The name of the metric this quota limit applies to. The quota limits with
233 * the same metric will be checked together during runtime. The metric must be
234 * defined within the service config.
235 * Used by metric-based quotas only.
236 * @type string $unit
237 * Specify the unit of the quota limit. It uses the same syntax as
238 * [Metric.unit][]. The supported unit kinds are determined by the quota
239 * backend system.
240 * The [Google Service Control](https://cloud.google.com/service-control)
241 * supports the following unit components:
242 * * One of the time intevals:
243 * * "/min" for quota every minute.
244 * * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
245 * * Otherwise the quota won't be reset by time, such as storage limit.
246 * * One and only one of the granted containers:
247 * * "/{organization}" quota for an organization.
248 * * "/{project}" quota for a project.
249 * * "/{folder}" quota for a folder.
250 * * "/{resource}" quota for a universal resource.
251 * * Zero or more quota segmentation dimension. Not all combos are valid.
252 * * "/{region}" quota for every region. Not to be used with time intervals.
253 * * Otherwise the resources granted on the target is not segmented.
254 * * "/{zone}" quota for every zone. Not to be used with time intervals.
255 * * Otherwise the resources granted on the target is not segmented.
256 * * "/{resource}" quota for a resource associated with a project or org.
257 * Here are some examples:
258 * * "1/min/{project}" for quota per minute per project.
259 * * "1/min/{user}" for quota per minute per user.
260 * * "1/min/{organization}" for quota per minute per organization.
261 * Note: the order of unit components is insignificant.
262 * The "1" at the beginning is required to follow the metric unit syntax.
263 * Used by metric-based quotas only.
264 * @type array|\Google\Protobuf\Internal\MapField $values
265 * Tiered limit values. Also allows for regional or zone overrides for these
266 * values if "/{region}" or "/{zone}" is specified in the unit field.
267 * Currently supported tiers from low to high:
268 * VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
269 * To apply different limit values for users according to their tiers, specify
270 * the values for the tiers you want to differentiate. For example:
271 * {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
272 * The limit value for each tier is optional except for the tier STANDARD.
273 * The limit value for an unspecified tier falls to the value of its next
274 * tier towards tier STANDARD. For the above example, the limit value for tier
275 * STANDARD is 500.
276 * To apply the same limit value for all users, just specify limit value for
277 * tier STANDARD. For example: {STANDARD:500}.
278 * To apply a regional overide for a tier, add a map entry with key
279 * "<TIER>/<region>", where <region> is a region name. Similarly, for a zone
280 * override, add a map entry with key "<TIER>/{zone}".
281 * Further, a wildcard can be used at the end of a zone name in order to
282 * specify zone level overrides. For example:
283 * LOW: 10, STANDARD: 50, HIGH: 100,
284 * LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,
285 * LOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80
286 * The regional overrides tier set for each region must be the same as
287 * the tier set for default limit values. Same rule applies for zone overrides
288 * tier as well.
289 * Used by metric-based quotas only.
290 * @type string $display_name
291 * User-visible display name for this limit.
292 * Optional. If not set, the UI will provide a default display name based on
293 * the quota configuration. This field can be used to override the default
294 * display name generated from the configuration.
295 * }
296 */
297 public function __construct($data = NULL) {
298 \GPBMetadata\Google\Api\Quota::initOnce();
299 parent::__construct($data);
300 }
301
302 /**
303 * Name of the quota limit. The name is used to refer to the limit when
304 * overriding the default limit on per-consumer basis.
305 * For group-based quota limits, the name must be unique within the quota
306 * group. If a name is not provided, it will be generated from the limit_by
307 * and duration fields.
308 * For metric-based quota limits, the name must be provided, and it must be
309 * unique within the service. The name can only include alphanumeric
310 * characters as well as '-'.
311 * The maximum length of the limit name is 64 characters.
312 * The name of a limit is used as a unique identifier for this limit.
313 * Therefore, once a limit has been put into use, its name should be
314 * immutable. You can use the display_name field to provide a user-friendly
315 * name for the limit. The display name can be evolved over time without
316 * affecting the identity of the limit.
317 *
318 * Generated from protobuf field <code>string name = 6;</code>
319 * @return string
320 */
321 public function getName()
322 {
323 return $this->name;
324 }
325
326 /**
327 * Name of the quota limit. The name is used to refer to the limit when
328 * overriding the default limit on per-consumer basis.
329 * For group-based quota limits, the name must be unique within the quota
330 * group. If a name is not provided, it will be generated from the limit_by
331 * and duration fields.
332 * For metric-based quota limits, the name must be provided, and it must be
333 * unique within the service. The name can only include alphanumeric
334 * characters as well as '-'.
335 * The maximum length of the limit name is 64 characters.
336 * The name of a limit is used as a unique identifier for this limit.
337 * Therefore, once a limit has been put into use, its name should be
338 * immutable. You can use the display_name field to provide a user-friendly
339 * name for the limit. The display name can be evolved over time without
340 * affecting the identity of the limit.
341 *
342 * Generated from protobuf field <code>string name = 6;</code>
343 * @param string $var
344 * @return $this
345 */
346 public function setName($var)
347 {
348 GPBUtil::checkString($var, True);
349 $this->name = $var;
350
351 return $this;
352 }
353
354 /**
355 * Optional. User-visible, extended description for this quota limit.
356 * Should be used only when more context is needed to understand this limit
357 * than provided by the limit's display name (see: `display_name`).
358 *
359 * Generated from protobuf field <code>string description = 2;</code>
360 * @return string
361 */
362 public function getDescription()
363 {
364 return $this->description;
365 }
366
367 /**
368 * Optional. User-visible, extended description for this quota limit.
369 * Should be used only when more context is needed to understand this limit
370 * than provided by the limit's display name (see: `display_name`).
371 *
372 * Generated from protobuf field <code>string description = 2;</code>
373 * @param string $var
374 * @return $this
375 */
376 public function setDescription($var)
377 {
378 GPBUtil::checkString($var, True);
379 $this->description = $var;
380
381 return $this;
382 }
383
384 /**
385 * Default number of tokens that can be consumed during the specified
386 * duration. This is the number of tokens assigned when a client
387 * application developer activates the service for his/her project.
388 * Specifying a value of 0 will block all requests. This can be used if you
389 * are provisioning quota to selected consumers and blocking others.
390 * Similarly, a value of -1 will indicate an unlimited quota. No other
391 * negative values are allowed.
392 * Used by group-based quotas only.
393 *
394 * Generated from protobuf field <code>int64 default_limit = 3;</code>
395 * @return int|string
396 */
397 public function getDefaultLimit()
398 {
399 return $this->default_limit;
400 }
401
402 /**
403 * Default number of tokens that can be consumed during the specified
404 * duration. This is the number of tokens assigned when a client
405 * application developer activates the service for his/her project.
406 * Specifying a value of 0 will block all requests. This can be used if you
407 * are provisioning quota to selected consumers and blocking others.
408 * Similarly, a value of -1 will indicate an unlimited quota. No other
409 * negative values are allowed.
410 * Used by group-based quotas only.
411 *
412 * Generated from protobuf field <code>int64 default_limit = 3;</code>
413 * @param int|string $var
414 * @return $this
415 */
416 public function setDefaultLimit($var)
417 {
418 GPBUtil::checkInt64($var);
419 $this->default_limit = $var;
420
421 return $this;
422 }
423
424 /**
425 * Maximum number of tokens that can be consumed during the specified
426 * duration. Client application developers can override the default limit up
427 * to this maximum. If specified, this value cannot be set to a value less
428 * than the default limit. If not specified, it is set to the default limit.
429 * To allow clients to apply overrides with no upper bound, set this to -1,
430 * indicating unlimited maximum quota.
431 * Used by group-based quotas only.
432 *
433 * Generated from protobuf field <code>int64 max_limit = 4;</code>
434 * @return int|string
435 */
436 public function getMaxLimit()
437 {
438 return $this->max_limit;
439 }
440
441 /**
442 * Maximum number of tokens that can be consumed during the specified
443 * duration. Client application developers can override the default limit up
444 * to this maximum. If specified, this value cannot be set to a value less
445 * than the default limit. If not specified, it is set to the default limit.
446 * To allow clients to apply overrides with no upper bound, set this to -1,
447 * indicating unlimited maximum quota.
448 * Used by group-based quotas only.
449 *
450 * Generated from protobuf field <code>int64 max_limit = 4;</code>
451 * @param int|string $var
452 * @return $this
453 */
454 public function setMaxLimit($var)
455 {
456 GPBUtil::checkInt64($var);
457 $this->max_limit = $var;
458
459 return $this;
460 }
461
462 /**
463 * Free tier value displayed in the Developers Console for this limit.
464 * The free tier is the number of tokens that will be subtracted from the
465 * billed amount when billing is enabled.
466 * This field can only be set on a limit with duration "1d", in a billable
467 * group; it is invalid on any other limit. If this field is not set, it
468 * defaults to 0, indicating that there is no free tier for this service.
469 * Used by group-based quotas only.
470 *
471 * Generated from protobuf field <code>int64 free_tier = 7;</code>
472 * @return int|string
473 */
474 public function getFreeTier()
475 {
476 return $this->free_tier;
477 }
478
479 /**
480 * Free tier value displayed in the Developers Console for this limit.
481 * The free tier is the number of tokens that will be subtracted from the
482 * billed amount when billing is enabled.
483 * This field can only be set on a limit with duration "1d", in a billable
484 * group; it is invalid on any other limit. If this field is not set, it
485 * defaults to 0, indicating that there is no free tier for this service.
486 * Used by group-based quotas only.
487 *
488 * Generated from protobuf field <code>int64 free_tier = 7;</code>
489 * @param int|string $var
490 * @return $this
491 */
492 public function setFreeTier($var)
493 {
494 GPBUtil::checkInt64($var);
495 $this->free_tier = $var;
496
497 return $this;
498 }
499
500 /**
501 * Duration of this limit in textual notation. Example: "100s", "24h", "1d".
502 * For duration longer than a day, only multiple of days is supported. We
503 * support only "100s" and "1d" for now. Additional support will be added in
504 * the future. "0" indicates indefinite duration.
505 * Used by group-based quotas only.
506 *
507 * Generated from protobuf field <code>string duration = 5;</code>
508 * @return string
509 */
510 public function getDuration()
511 {
512 return $this->duration;
513 }
514
515 /**
516 * Duration of this limit in textual notation. Example: "100s", "24h", "1d".
517 * For duration longer than a day, only multiple of days is supported. We
518 * support only "100s" and "1d" for now. Additional support will be added in
519 * the future. "0" indicates indefinite duration.
520 * Used by group-based quotas only.
521 *
522 * Generated from protobuf field <code>string duration = 5;</code>
523 * @param string $var
524 * @return $this
525 */
526 public function setDuration($var)
527 {
528 GPBUtil::checkString($var, True);
529 $this->duration = $var;
530
531 return $this;
532 }
533
534 /**
535 * The name of the metric this quota limit applies to. The quota limits with
536 * the same metric will be checked together during runtime. The metric must be
537 * defined within the service config.
538 * Used by metric-based quotas only.
539 *
540 * Generated from protobuf field <code>string metric = 8;</code>
541 * @return string
542 */
543 public function getMetric()
544 {
545 return $this->metric;
546 }
547
548 /**
549 * The name of the metric this quota limit applies to. The quota limits with
550 * the same metric will be checked together during runtime. The metric must be
551 * defined within the service config.
552 * Used by metric-based quotas only.
553 *
554 * Generated from protobuf field <code>string metric = 8;</code>
555 * @param string $var
556 * @return $this
557 */
558 public function setMetric($var)
559 {
560 GPBUtil::checkString($var, True);
561 $this->metric = $var;
562
563 return $this;
564 }
565
566 /**
567 * Specify the unit of the quota limit. It uses the same syntax as
568 * [Metric.unit][]. The supported unit kinds are determined by the quota
569 * backend system.
570 * The [Google Service Control](https://cloud.google.com/service-control)
571 * supports the following unit components:
572 * * One of the time intevals:
573 * * "/min" for quota every minute.
574 * * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
575 * * Otherwise the quota won't be reset by time, such as storage limit.
576 * * One and only one of the granted containers:
577 * * "/{organization}" quota for an organization.
578 * * "/{project}" quota for a project.
579 * * "/{folder}" quota for a folder.
580 * * "/{resource}" quota for a universal resource.
581 * * Zero or more quota segmentation dimension. Not all combos are valid.
582 * * "/{region}" quota for every region. Not to be used with time intervals.
583 * * Otherwise the resources granted on the target is not segmented.
584 * * "/{zone}" quota for every zone. Not to be used with time intervals.
585 * * Otherwise the resources granted on the target is not segmented.
586 * * "/{resource}" quota for a resource associated with a project or org.
587 * Here are some examples:
588 * * "1/min/{project}" for quota per minute per project.
589 * * "1/min/{user}" for quota per minute per user.
590 * * "1/min/{organization}" for quota per minute per organization.
591 * Note: the order of unit components is insignificant.
592 * The "1" at the beginning is required to follow the metric unit syntax.
593 * Used by metric-based quotas only.
594 *
595 * Generated from protobuf field <code>string unit = 9;</code>
596 * @return string
597 */
598 public function getUnit()
599 {
600 return $this->unit;
601 }
602
603 /**
604 * Specify the unit of the quota limit. It uses the same syntax as
605 * [Metric.unit][]. The supported unit kinds are determined by the quota
606 * backend system.
607 * The [Google Service Control](https://cloud.google.com/service-control)
608 * supports the following unit components:
609 * * One of the time intevals:
610 * * "/min" for quota every minute.
611 * * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
612 * * Otherwise the quota won't be reset by time, such as storage limit.
613 * * One and only one of the granted containers:
614 * * "/{organization}" quota for an organization.
615 * * "/{project}" quota for a project.
616 * * "/{folder}" quota for a folder.
617 * * "/{resource}" quota for a universal resource.
618 * * Zero or more quota segmentation dimension. Not all combos are valid.
619 * * "/{region}" quota for every region. Not to be used with time intervals.
620 * * Otherwise the resources granted on the target is not segmented.
621 * * "/{zone}" quota for every zone. Not to be used with time intervals.
622 * * Otherwise the resources granted on the target is not segmented.
623 * * "/{resource}" quota for a resource associated with a project or org.
624 * Here are some examples:
625 * * "1/min/{project}" for quota per minute per project.
626 * * "1/min/{user}" for quota per minute per user.
627 * * "1/min/{organization}" for quota per minute per organization.
628 * Note: the order of unit components is insignificant.
629 * The "1" at the beginning is required to follow the metric unit syntax.
630 * Used by metric-based quotas only.
631 *
632 * Generated from protobuf field <code>string unit = 9;</code>
633 * @param string $var
634 * @return $this
635 */
636 public function setUnit($var)
637 {
638 GPBUtil::checkString($var, True);
639 $this->unit = $var;
640
641 return $this;
642 }
643
644 /**
645 * Tiered limit values. Also allows for regional or zone overrides for these
646 * values if "/{region}" or "/{zone}" is specified in the unit field.
647 * Currently supported tiers from low to high:
648 * VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
649 * To apply different limit values for users according to their tiers, specify
650 * the values for the tiers you want to differentiate. For example:
651 * {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
652 * The limit value for each tier is optional except for the tier STANDARD.
653 * The limit value for an unspecified tier falls to the value of its next
654 * tier towards tier STANDARD. For the above example, the limit value for tier
655 * STANDARD is 500.
656 * To apply the same limit value for all users, just specify limit value for
657 * tier STANDARD. For example: {STANDARD:500}.
658 * To apply a regional overide for a tier, add a map entry with key
659 * "<TIER>/<region>", where <region> is a region name. Similarly, for a zone
660 * override, add a map entry with key "<TIER>/{zone}".
661 * Further, a wildcard can be used at the end of a zone name in order to
662 * specify zone level overrides. For example:
663 * LOW: 10, STANDARD: 50, HIGH: 100,
664 * LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,
665 * LOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80
666 * The regional overrides tier set for each region must be the same as
667 * the tier set for default limit values. Same rule applies for zone overrides
668 * tier as well.
669 * Used by metric-based quotas only.
670 *
671 * Generated from protobuf field <code>map<string, int64> values = 10;</code>
672 * @return \Google\Protobuf\Internal\MapField
673 */
674 public function getValues()
675 {
676 return $this->values;
677 }
678
679 /**
680 * Tiered limit values. Also allows for regional or zone overrides for these
681 * values if "/{region}" or "/{zone}" is specified in the unit field.
682 * Currently supported tiers from low to high:
683 * VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
684 * To apply different limit values for users according to their tiers, specify
685 * the values for the tiers you want to differentiate. For example:
686 * {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
687 * The limit value for each tier is optional except for the tier STANDARD.
688 * The limit value for an unspecified tier falls to the value of its next
689 * tier towards tier STANDARD. For the above example, the limit value for tier
690 * STANDARD is 500.
691 * To apply the same limit value for all users, just specify limit value for
692 * tier STANDARD. For example: {STANDARD:500}.
693 * To apply a regional overide for a tier, add a map entry with key
694 * "<TIER>/<region>", where <region> is a region name. Similarly, for a zone
695 * override, add a map entry with key "<TIER>/{zone}".
696 * Further, a wildcard can be used at the end of a zone name in order to
697 * specify zone level overrides. For example:
698 * LOW: 10, STANDARD: 50, HIGH: 100,
699 * LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,
700 * LOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80
701 * The regional overrides tier set for each region must be the same as
702 * the tier set for default limit values. Same rule applies for zone overrides
703 * tier as well.
704 * Used by metric-based quotas only.
705 *
706 * Generated from protobuf field <code>map<string, int64> values = 10;</code>
707 * @param array|\Google\Protobuf\Internal\MapField $var
708 * @return $this
709 */
710 public function setValues($var)
711 {
712 $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::INT64);
713 $this->values = $arr;
714
715 return $this;
716 }
717
718 /**
719 * User-visible display name for this limit.
720 * Optional. If not set, the UI will provide a default display name based on
721 * the quota configuration. This field can be used to override the default
722 * display name generated from the configuration.
723 *
724 * Generated from protobuf field <code>string display_name = 12;</code>
725 * @return string
726 */
727 public function getDisplayName()
728 {
729 return $this->display_name;
730 }
731
732 /**
733 * User-visible display name for this limit.
734 * Optional. If not set, the UI will provide a default display name based on
735 * the quota configuration. This field can be used to override the default
736 * display name generated from the configuration.
737 *
738 * Generated from protobuf field <code>string display_name = 12;</code>
739 * @param string $var
740 * @return $this
741 */
742 public function setDisplayName($var)
743 {
744 GPBUtil::checkString($var, True);
745 $this->display_name = $var;
746
747 return $this;
748 }
749
750 }
751
752