blob: 7fdf0f4e5e358fb209a37edd6823927c497d87b3 [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 Kim4ed7d3f2020-05-27 12:20:54 -0700110 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
111 #
112 # An example name would be:
113 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
114 #
115 # The resource name is intended to be opaque and should not be parsed for
116 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700118 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;quotaBuckets&quot;: [ # Summary of the enforced quota buckets, organized by quota dimension,
120 # ordered from least specific to most specific (for example, the global
121 # default bucket, with no quota dimensions, will always appear first).
122 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700123 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
125 #
126 # An example unit would be:
127 # `1/{project}/{region}`
128 # Note that `{project}` and `{region}` are not placeholders in this example;
129 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700130 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
131 # Can be any nonnegative integer, or -1 (unlimited quota).
132 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
133 # This name is generated by the server when the override is created.
134 #
135 # Example names would be:
136 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
137 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
138 #
139 # The resource name is intended to be opaque and should not be parsed for
140 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
142 #
143 # An example name would be:
144 # `compute.googleapis.com/cpus`
145 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
146 # for dimensions defined in the limit unit.
147 #
148 # For example, an override on a limit with the unit 1/{project}/{region}
149 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
150 # the override is only applied to quota consumed in that region.
151 #
152 # This map has the following restrictions:
153 #
154 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
155 # Any string appearing in {brackets} in the unit (besides {project} or
156 # {user}) is a defined key.
157 # * &quot;project&quot; is not a valid key; the project is already specified in
158 # the parent resource name.
159 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
160 # that apply only to a specific user.
161 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
162 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
163 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
164 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
165 # map.
166 &quot;a_key&quot;: &quot;A String&quot;,
167 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700168 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
170 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
171 #
172 # An example unit would be:
173 # `1/{project}/{region}`
174 # Note that `{project}` and `{region}` are not placeholders in this example;
175 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700176 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
177 # Can be any nonnegative integer, or -1 (unlimited quota).
178 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
179 # This name is generated by the server when the override is created.
180 #
181 # Example names would be:
182 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
183 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
184 #
185 # The resource name is intended to be opaque and should not be parsed for
186 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700187 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
188 #
189 # An example name would be:
190 # `compute.googleapis.com/cpus`
191 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
192 # for dimensions defined in the limit unit.
193 #
194 # For example, an override on a limit with the unit 1/{project}/{region}
195 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
196 # the override is only applied to quota consumed in that region.
197 #
198 # This map has the following restrictions:
199 #
200 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
201 # Any string appearing in {brackets} in the unit (besides {project} or
202 # {user}) is a defined key.
203 # * &quot;project&quot; is not a valid key; the project is already specified in
204 # the parent resource name.
205 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
206 # that apply only to a specific user.
207 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
208 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
209 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
210 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
211 # map.
212 &quot;a_key&quot;: &quot;A String&quot;,
213 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700214 },
215 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
216 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
217 #
218 # An example unit would be:
219 # `1/{project}/{region}`
220 # Note that `{project}` and `{region}` are not placeholders in this example;
221 # the literal characters `{` and `}` occur in the string.
222 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
223 # Can be any nonnegative integer, or -1 (unlimited quota).
Bu Sun Kim65020912020-05-20 12:08:20 -0700224 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override.
225 # This name is generated by the server when the override is created.
226 #
227 # Example names would be:
228 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
229 # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
230 #
231 # The resource name is intended to be opaque and should not be parsed for
232 # its component strings, since its representation could change in the future.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700233 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
234 #
235 # An example name would be:
236 # `compute.googleapis.com/cpus`
237 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values
238 # for dimensions defined in the limit unit.
239 #
240 # For example, an override on a limit with the unit 1/{project}/{region}
241 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
242 # the override is only applied to quota consumed in that region.
243 #
244 # This map has the following restrictions:
245 #
246 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
247 # Any string appearing in {brackets} in the unit (besides {project} or
248 # {user}) is a defined key.
249 # * &quot;project&quot; is not a valid key; the project is already specified in
250 # the parent resource name.
251 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
252 # that apply only to a specific user.
253 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
254 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
255 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
256 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
257 # map.
258 &quot;a_key&quot;: &quot;A String&quot;,
259 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700260 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700261 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
262 # configuration.
263 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
264 # are no overrides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;dimensions&quot;: { # The dimensions of this quota bucket.
266 #
267 # If this map is empty, this is the global bucket, which is the default quota
268 # value applied to all requests that do not have a more specific override.
269 #
270 # If this map is nonempty, the default limit, effective limit, and quota
271 # overrides apply only to requests that have the dimensions given in the map.
272 #
273 # For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
274 # specified effective limit is only effective in that region, and the
275 # specified overrides apply only in that region.
276 &quot;a_key&quot;: &quot;A String&quot;,
277 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 },
279 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700280 &quot;unit&quot;: &quot;A String&quot;, # The limit unit.
281 #
282 # An example unit would be
283 # `1/{project}/{region}`
284 # Note that `{project}` and `{region}` are not placeholders in this example;
285 # the literal characters `{` and `}` occur in the string.
286 &quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
287 #
288 # An example name would be:
289 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700290 }</pre>
291</div>
292
293</body></html>