blob: 047bd4556b2f3075091ea903c0fdb400c6bdb8a7 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="serviceusage_v1beta1.html">Service Usage API</a> . <a href="serviceusage_v1beta1.services.html">services</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html">adminOverrides()</a></code>
79</p>
80<p class="firstline">Returns the adminOverrides Resource.</p>
81
82<p class="toc_element">
83 <code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html">consumerOverrides()</a></code>
84</p>
85<p class="firstline">Returns the consumerOverrides Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
89<p class="firstline">Retrieves a summary of quota information for a specific quota limit.</p>
90<h3>Method Details</h3>
91<div class="method">
92 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
93 <pre>Retrieves a summary of quota information for a specific quota limit.
94
95Args:
96 name: string, The resource name of the quota limit.
97
98Use the quota limit resource name returned by previous
99ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls. (required)
100 view: string, Specifies the level of detail for quota information in the response.
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # Consumer quota settings for a quota limit.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700110 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
111 &quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
112 #
113 # An example name would be:
114 # `compute.googleapis.com/cpus`
115 &quot;unit&quot;: &quot;A String&quot;, # The limit unit.
116 #
117 # An example unit would be
118 # `1/{project}/{region}`
119 # Note that `{project}` and `{region}` are not placeholders in this example;
120 # the literal characters `{` and `}` occur in the string.
121 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700122 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
123 #
124 # An example name would be:
125 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
126 #
127 # The resource name is intended to be opaque and should not be parsed for
128 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 &quot;quotaBuckets&quot;: [ # Summary of the enforced quota buckets, organized by quota dimension,
130 # ordered from least specific to most specific (for example, the global
131 # default bucket, with no quota dimensions, will always appear first).
132 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700133 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700134 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
135 # This name is generated by the server when the override is created.
136 #
137 # Example names would be:
138 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
139 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
140 #
141 # The resource name is intended to be opaque and should not be parsed for
142 # its component strings, since its representation could change in the future.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
144 # Can be any nonnegative integer, or -1 (unlimited quota).
145 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
146 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
147 # Used by admin overrides only.
148 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
149 #
150 # An example unit would be:
151 # `1/{project}/{region}`
152 # Note that `{project}` and `{region}` are not placeholders in this example;
153 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
155 #
156 # An example name would be:
157 # `compute.googleapis.com/cpus`
158 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
159 # for dimensions defined in the limit unit.
160 #
161 # For example, an override on a limit with the unit 1/{project}/{region}
162 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
163 # the override is only applied to quota consumed in that region.
164 #
165 # This map has the following restrictions:
166 #
167 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
168 # Any string appearing in {brackets} in the unit (besides {project} or
169 # {user}) is a defined key.
170 # * &quot;project&quot; is not a valid key; the project is already specified in
171 # the parent resource name.
172 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
173 # that apply only to a specific user.
174 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
175 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
176 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
177 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
178 # map.
179 &quot;a_key&quot;: &quot;A String&quot;,
180 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700181 },
182 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
184 # This name is generated by the server when the override is created.
185 #
186 # Example names would be:
187 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
188 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
189 #
190 # The resource name is intended to be opaque and should not be parsed for
191 # its component strings, since its representation could change in the future.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700192 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
193 # Can be any nonnegative integer, or -1 (unlimited quota).
194 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
195 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
196 # Used by admin overrides only.
197 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
198 #
199 # An example unit would be:
200 # `1/{project}/{region}`
201 # Note that `{project}` and `{region}` are not placeholders in this example;
202 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700203 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
204 #
205 # An example name would be:
206 # `compute.googleapis.com/cpus`
207 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
208 # for dimensions defined in the limit unit.
209 #
210 # For example, an override on a limit with the unit 1/{project}/{region}
211 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
212 # the override is only applied to quota consumed in that region.
213 #
214 # This map has the following restrictions:
215 #
216 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
217 # Any string appearing in {brackets} in the unit (besides {project} or
218 # {user}) is a defined key.
219 # * &quot;project&quot; is not a valid key; the project is already specified in
220 # the parent resource name.
221 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
222 # that apply only to a specific user.
223 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
224 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
225 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
226 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
227 # map.
228 &quot;a_key&quot;: &quot;A String&quot;,
229 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 },
231 &quot;dimensions&quot;: { # The dimensions of this quota bucket.
232 #
233 # If this map is empty, this is the global bucket, which is the default quota
234 # value applied to all requests that do not have a more specific override.
235 #
236 # If this map is nonempty, the default limit, effective limit, and quota
237 # overrides apply only to requests that have the dimensions given in the map.
238 #
239 # For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
240 # specified effective limit is only effective in that region, and the
241 # specified overrides apply only in that region.
242 &quot;a_key&quot;: &quot;A String&quot;,
243 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700244 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
245 # configuration.
246 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
247 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
248 # This name is generated by the server when the override is created.
249 #
250 # Example names would be:
251 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
252 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
253 #
254 # The resource name is intended to be opaque and should not be parsed for
255 # its component strings, since its representation could change in the future.
256 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
257 # Can be any nonnegative integer, or -1 (unlimited quota).
258 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
259 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
260 # Used by admin overrides only.
261 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
262 #
263 # An example unit would be:
264 # `1/{project}/{region}`
265 # Note that `{project}` and `{region}` are not placeholders in this example;
266 # the literal characters `{` and `}` occur in the string.
267 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
268 #
269 # An example name would be:
270 # `compute.googleapis.com/cpus`
271 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
272 # for dimensions defined in the limit unit.
273 #
274 # For example, an override on a limit with the unit 1/{project}/{region}
275 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
276 # the override is only applied to quota consumed in that region.
277 #
278 # This map has the following restrictions:
279 #
280 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
281 # Any string appearing in {brackets} in the unit (besides {project} or
282 # {user}) is a defined key.
283 # * &quot;project&quot; is not a valid key; the project is already specified in
284 # the parent resource name.
285 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
286 # that apply only to a specific user.
287 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
288 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
289 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
290 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
291 # map.
292 &quot;a_key&quot;: &quot;A String&quot;,
293 },
294 },
295 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
296 # are no overrides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700297 },
298 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700299 }</pre>
300</div>
301
302</body></html>