blob: e2f144eb59971dbc35d0e5a65208176d5b67ad3c [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> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html">adminOverrides</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#create">create(parent, body=None, force=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070083<p class="toc_element">
84 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an admin override.</p>
86<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080087 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070088<p class="firstline">Lists all admin overrides on this limit.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080093 <code><a href="#patch">patch(name, body=None, updateMask=None, force=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="firstline">Updates an admin override.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700102 <code class="details" id="create">create(parent, body=None, force=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <pre>Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104
105Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 parent: string, The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 body: object, The request body.
108 The object takes the form of:
109
110{ # A quota override
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800111 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
112 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override 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 override 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 overrides 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 &quot;a_key&quot;: &quot;A String&quot;,
115 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800116 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800118 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: &quot;organizations/12345&quot; or &quot;folders/67890&quot;. Used by admin overrides only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700119}
120
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 force: boolean, Whether to force the creation of the quota override. If creating an override would cause the effective quota for the consumer to decrease 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 &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.
132 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700136 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700137 {
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800141 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
142 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700143 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800144 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146 },
147 &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}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
153 <pre>Deletes an admin override.
154
155Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156 name: string, The resource name of the override to delete. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` (required)
157 force: boolean, Whether to force the deletion of the quota override. If deleting an override would cause the effective quota for the consumer to decrease 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700166 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800167 &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.
168 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
169 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800170 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700171 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700173 {
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800177 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
178 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700179 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800180 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
181 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
182 },
183 &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}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700184 }</pre>
185</div>
186
187<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800188 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 <pre>Lists all admin overrides on this limit.
190
191Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 parent: string, The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800193 pageToken: string, Token identifying which result to start with; returned by a previous list call.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800194 pageSize: integer, Requested size of the next page of data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
203 { # Response message for ListAdminOverrides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &quot;overrides&quot;: [ # Admin overrides on this limit.
205 { # A quota override
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800206 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
207 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override 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 override 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 overrides 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &quot;a_key&quot;: &quot;A String&quot;,
210 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800211 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700212 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800213 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: &quot;organizations/12345&quot; or &quot;folders/67890&quot;. Used by admin overrides only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 },
215 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800216 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying which result to start with; returned by a previous list call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700217 }</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
222 <pre>Retrieves the next page of results.
223
224Args:
225 previous_request: The request for the previous page. (required)
226 previous_response: The response from the request for the previous page. (required)
227
228Returns:
229 A request object that you can call &#x27;execute()&#x27; on to request the next
230 page. Returns None if there are no more items in the collection.
231 </pre>
232</div>
233
234<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800235 <code class="details" id="patch">patch(name, body=None, updateMask=None, force=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 <pre>Updates an admin override.
237
238Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 name: string, The resource name of the override to update. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 body: object, The request body.
241 The object takes the form of:
242
243{ # A quota override
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800244 &quot;name&quot;: &quot;A String&quot;, # The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
245 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700246 &quot;dimensions&quot;: { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override 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 override 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 overrides 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700247 &quot;a_key&quot;: &quot;A String&quot;,
248 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800249 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700250 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800251 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: &quot;organizations/12345&quot; or &quot;folders/67890&quot;. Used by admin overrides only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700252}
253
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700254 updateMask: string, Update only the specified fields of the override. If unset, all fields will be updated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800255 force: boolean, Whether to force the update of the quota override. If updating an override would cause the effective quota for the consumer to decrease 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700256 x__xgafv: string, V1 error format.
257 Allowed values
258 1 - v1 error format
259 2 - v2 error format
260
261Returns:
262 An object of the form:
263
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700264 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800265 &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.
266 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
267 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800268 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700269 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700270 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700271 {
272 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
273 },
274 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800275 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
276 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700277 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800278 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
280 },
281 &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}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 }</pre>
283</div>
284
285</body></html>