blob: d2581822108749604235d0ae8db8b056b165e41d [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="serviceconsumermanagement_v1beta1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1beta1.services.html">services</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.producerOverrides.html">producerOverrides()</a></code>
79</p>
80<p class="firstline">Returns the producerOverrides Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Retrieves a summary of quota information for a specific quota limit.</p>
85<h3>Method Details</h3>
86<div class="method">
87 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
88 <pre>Retrieves a summary of quota information for a specific quota limit.
89
90Args:
91 name: string, The resource name of the quota limit, returned by a
92ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.
93
94An example name would be:
95`services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
96 view: string, Specifies the level of detail for quota information in the response.
97 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
101
102Returns:
103 An object of the form:
104
105 { # Consumer quota settings for a quota limit.
106 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700107 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
108 #
109 # An example name would be:
110 # `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
111 #
112 # The resource name is intended to be opaque and should not be parsed for
113 # its component strings, since its representation could change in the future.
114 &quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
115 #
116 # An example name would be:
117 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 &quot;quotaBuckets&quot;: [ # Summary of the enforced quota buckets, organized by quota dimension,
119 # ordered from least specific to most specific (for example, the global
120 # default bucket, with no quota dimensions, will always appear first).
121 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
122 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
123 # are no overrides.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700124 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
125 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
126 # An example name would be:
127 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
128 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
129 #
130 # An example unit would be:
131 # `1/{project}/{region}`
132 # Note that `{project}` and `{region}` are not placeholders in this example;
133 # the literal characters `{` and `}` occur in the string.
134 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
135 #
136 # An example name would be:
137 # `compute.googleapis.com/cpus`
138 &quot;dimensions&quot;: { #
139 # If this map is nonempty, then this override applies only to specific values
140 # for dimensions defined in the limit unit.
141 #
142 # For example, an override on a limit with the unit 1/{project}/{region}
143 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
144 # the override is only applied to quota consumed in that region.
145 #
146 # This map has the following restrictions:
147 #
148 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
149 # Any string appearing in {brackets} in the unit (besides {project} or
150 # {user}) is a defined key.
151 # * &quot;project&quot; is not a valid key; the project is already specified in
152 # the parent resource name.
153 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
154 # that apply only to a specific user.
155 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
156 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
157 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
158 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
159 # map.
160 &quot;a_key&quot;: &quot;A String&quot;,
161 },
162 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
163 # Can be any nonnegative integer, or -1 (unlimited quota).
164 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700165 &quot;dimensions&quot;: { # The dimensions of this quota bucket.
166 #
167 # If this map is empty, this is the global bucket, which is the default quota
168 # value applied to all requests that do not have a more specific override.
169 #
170 # If this map is nonempty, the default limit, effective limit, and quota
171 # overrides apply only to requests that have the dimensions given in the map.
172 #
173 # For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
174 # specified effective limit is only effective in that region, and the
175 # specified overrides apply only in that region.
176 &quot;a_key&quot;: &quot;A String&quot;,
177 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700179 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
180 # An example name would be:
181 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
Bu Sun Kim65020912020-05-20 12:08:20 -0700182 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
183 #
184 # An example unit would be:
185 # `1/{project}/{region}`
186 # Note that `{project}` and `{region}` are not placeholders in this example;
187 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700188 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
189 #
190 # An example name would be:
191 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 &quot;dimensions&quot;: { #
193 # If this map is nonempty, then this override applies only to specific values
194 # for dimensions defined in the limit unit.
195 #
196 # For example, an override on a limit with the unit 1/{project}/{region}
197 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
198 # the override is only applied to quota consumed in that region.
199 #
200 # This map has the following restrictions:
201 #
202 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
203 # Any string appearing in {brackets} in the unit (besides {project} or
204 # {user}) is a defined key.
205 # * &quot;project&quot; is not a valid key; the project is already specified in
206 # the parent resource name.
207 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
208 # that apply only to a specific user.
209 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
210 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
211 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
212 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
213 # map.
214 &quot;a_key&quot;: &quot;A String&quot;,
215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
217 # Can be any nonnegative integer, or -1 (unlimited quota).
Bu Sun Kim65020912020-05-20 12:08:20 -0700218 },
219 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700220 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
221 # An example name would be:
222 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
224 #
225 # An example unit would be:
226 # `1/{project}/{region}`
227 # Note that `{project}` and `{region}` are not placeholders in this example;
228 # the literal characters `{` and `}` occur in the string.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700229 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
230 #
231 # An example name would be:
232 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700233 &quot;dimensions&quot;: { #
234 # If this map is nonempty, then this override applies only to specific values
235 # for dimensions defined in the limit unit.
236 #
237 # For example, an override on a limit with the unit 1/{project}/{region}
238 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
239 # the override is only applied to quota consumed in that region.
240 #
241 # This map has the following restrictions:
242 #
243 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
244 # Any string appearing in {brackets} in the unit (besides {project} or
245 # {user}) is a defined key.
246 # * &quot;project&quot; is not a valid key; the project is already specified in
247 # the parent resource name.
248 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
249 # that apply only to a specific user.
250 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
251 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
252 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
253 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
254 # map.
255 &quot;a_key&quot;: &quot;A String&quot;,
256 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700257 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
258 # Can be any nonnegative integer, or -1 (unlimited quota).
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700260 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
261 # configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 },
263 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700264 &quot;unit&quot;: &quot;A String&quot;, # The limit unit.
265 #
266 # An example unit would be:
267 # `1/{project}/{region}`
268 # Note that `{project}` and `{region}` are not placeholders in this example;
269 # the literal characters `{` and `}` occur in the string.
270 }</pre>
271</div>
272
273</body></html>