Debian Codegraph @

docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.producerQuotaPolicies.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.producerQuotaPolicies.html">producerQuotaPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, force=None, forceJustification=None, validateOnly=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a producer quota policy. A producer quota policy is applied by the owner or administrator of a service at an org or folder node to set the default quota limit for all consumers under the node where the policy is created. To create multiple policies at once, use ImportProducerQuotaPolicies instead. If a policy with the specified dimensions already exists, this call will fail. To overwrite an existing policy if one is already present ("upsert" semantics), use ImportProducerQuotaPolicies instead.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, force=None, forceJustification=None, validateOnly=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a producer quota policy.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists all producer policies created at current consumer node for a limit.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, force=None, forceJustification=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates a producer quota policy.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(parent, body=None, force=None, forceJustification=None, validateOnly=None, x__xgafv=None)</code>
103 <pre>Creates a producer quota policy. A producer quota policy is applied by the owner or administrator of a service at an org or folder node to set the default quota limit for all consumers under the node where the policy is created. To create multiple policies at once, use ImportProducerQuotaPolicies instead. If a policy with the specified dimensions already exists, this call will fail. To overwrite an existing policy if one is already present (&quot;upsert&quot; semantics), use ImportProducerQuotaPolicies instead.
104
105 Args:
106 parent: string, Required. The resource name of the parent quota limit. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
107 body: object, The request body.
108 The object takes the form of:
109
110 { # Quota policy created by service producer.
111 &quot;container&quot;: &quot;A String&quot;, # The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}
112 &quot;dimensions&quot;: { # If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit&#x27;s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * &quot;project&quot; is not a valid key; the project is already specified in the parent resource name. * &quot;user&quot; is not a valid key; the API does not support quota polcies that apply only to a specific user. * If &quot;region&quot; appears as a key, its value must be a valid Cloud region. * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone. * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the map.
113 &quot;a_key&quot;: &quot;A String&quot;,
114 },
115 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`
116 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer policy. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
117 &quot;policyValue&quot;: &quot;A String&quot;, # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
118 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.
119 }
120
121 force: boolean, Whether to force the creation of the quota policy. If the policy creation would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
122 forceJustification: string, If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.
123 validateOnly: boolean, If set to true, validate the request, but do not actually update.
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # This resource represents a long-running operation that is the result of a network API call.
133 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
134 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
135 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
136 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
137 {
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 ],
141 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
142 },
143 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
144 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
145 },
146 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
147 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="delete">delete(name, force=None, forceJustification=None, validateOnly=None, x__xgafv=None)</code>
155 <pre>Deletes a producer quota policy.
156
157 Args:
158 name: string, Required. The resource name of the policy to delete. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` (required)
159 force: boolean, Whether to force the deletion of the quota policy. If the policy deletion would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
160 forceJustification: string, If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.
161 validateOnly: boolean, If set to true, validate the request, but do not actually update.
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167 Returns:
168 An object of the form:
169
170 { # This resource represents a long-running operation that is the result of a network API call.
171 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
172 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
173 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
174 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
175 {
176 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
177 },
178 ],
179 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
180 },
181 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
183 },
184 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
185 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
186 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
187 },
188 }</pre>
189 </div>
190
191 <div class="method">
192 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
193 <pre>Lists all producer policies created at current consumer node for a limit.
194
195 Args:
196 parent: string, Required. The resource name of the parent quota limit. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
197 pageSize: integer, Requested size of the next page of data.
198 pageToken: string, Token identifying which result to start with; returned by a previous list call.
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204 Returns:
205 An object of the form:
206
207 { # Response message for ListProducerQuotaPolicies.
208 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying which result to start with; returned by a previous list call.
209 &quot;producerQuotaPolicies&quot;: [ # Producer policies on this limit.
210 { # Quota policy created by service producer.
211 &quot;container&quot;: &quot;A String&quot;, # The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}
212 &quot;dimensions&quot;: { # If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit&#x27;s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * &quot;project&quot; is not a valid key; the project is already specified in the parent resource name. * &quot;user&quot; is not a valid key; the API does not support quota polcies that apply only to a specific user. * If &quot;region&quot; appears as a key, its value must be a valid Cloud region. * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone. * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the map.
213 &quot;a_key&quot;: &quot;A String&quot;,
214 },
215 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`
216 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer policy. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
217 &quot;policyValue&quot;: &quot;A String&quot;, # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
218 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.
219 },
220 ],
221 }</pre>
222 </div>
223
224 <div class="method">
225 <code class="details" id="list_next">list_next()</code>
226 <pre>Retrieves the next page of results.
227
228 Args:
229 previous_request: The request for the previous page. (required)
230 previous_response: The response from the request for the previous page. (required)
231
232 Returns:
233 A request object that you can call &#x27;execute()&#x27; on to request the next
234 page. Returns None if there are no more items in the collection.
235 </pre>
236 </div>
237
238 <div class="method">
239 <code class="details" id="patch">patch(name, body=None, force=None, forceJustification=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
240 <pre>Updates a producer quota policy.
241
242 Args:
243 name: string, The resource name of the producer policy. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` (required)
244 body: object, The request body.
245 The object takes the form of:
246
247 { # Quota policy created by service producer.
248 &quot;container&quot;: &quot;A String&quot;, # The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}
249 &quot;dimensions&quot;: { # If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit&#x27;s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * &quot;project&quot; is not a valid key; the project is already specified in the parent resource name. * &quot;user&quot; is not a valid key; the API does not support quota polcies that apply only to a specific user. * If &quot;region&quot; appears as a key, its value must be a valid Cloud region. * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone. * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the map.
250 &quot;a_key&quot;: &quot;A String&quot;,
251 },
252 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`
253 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer policy. An example name would be: `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
254 &quot;policyValue&quot;: &quot;A String&quot;, # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
255 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.
256 }
257
258 force: boolean, Whether to force the update of the quota policy. If the policy update would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
259 forceJustification: string, If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.
260 updateMask: string, Update only the specified fields. If unset, all modifiable fields will be updated.
261 validateOnly: boolean, If set to true, validate the request, but do not actually update.
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267 Returns:
268 An object of the form:
269
270 { # This resource represents a long-running operation that is the result of a network API call.
271 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
272 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
273 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
274 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
275 {
276 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
277 },
278 ],
279 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
280 },
281 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
285 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
286 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
287 },
288 }</pre>
289 </div>
290
291 </body></html>