|
| 1 | +{# AUTOGENERATED. DO NOT EDIT. #} |
| 2 | + |
| 3 | +{% extends "config-connector/_base.html" %} |
| 4 | + |
| 5 | +{% block page_title %}APIQuotaAdjusterSettings{% endblock %} |
| 6 | +{% block body %} |
| 7 | + |
| 8 | + |
| 9 | +<table> |
| 10 | +<thead> |
| 11 | +<tr> |
| 12 | +<th><strong>Property</strong></th> |
| 13 | +<th><strong>Value</strong></th> |
| 14 | +</tr> |
| 15 | +</thead> |
| 16 | +<tbody> |
| 17 | +<tr> |
| 18 | +<td>{{gcp_name_short}} Service Name</td> |
| 19 | +<td>Cloud Quotas</td> |
| 20 | +</tr> |
| 21 | +<tr> |
| 22 | +<td>{{gcp_name_short}} Service Documentation</td> |
| 23 | +<td><a href="/quotas/docs/">/quotas/docs/</a></td> |
| 24 | +</tr> |
| 25 | +<tr> |
| 26 | +<td>{{gcp_name_short}} REST Resource Documentation</td> |
| 27 | +<td><a href="/quotas/docs/reference/rest/v1beta/projects.locations.quotaAdjusterSettings">/quotas/docs/reference/rest/v1beta/projects.locations.quotaAdjusterSettings</a></td> |
| 28 | +</tr> |
| 29 | +<tr> |
| 30 | +<td>{{product_name_short}} Resource Short Names</td> |
| 31 | +<td>APIQuotaAdjusterSettings<br>gcpapiquotaadjustersetting<br>gcpapiquotaadjustersettings<br>apiquotaadjustersettings</td> |
| 32 | +</tr> |
| 33 | +<tr> |
| 34 | +<td>{{product_name_short}} Service Name</td> |
| 35 | +<td>cloudquotas.googleapis.com</td> |
| 36 | +</tr> |
| 37 | +<tr> |
| 38 | +<td>{{product_name_short}} Resource Fully Qualified Name</td> |
| 39 | +<td>apiquotaadjustersettings.cloudquota.cnrm.cloud.google.com</td> |
| 40 | +</tr> |
| 41 | + |
| 42 | +<tr> |
| 43 | + <td>Can Be Referenced by IAMPolicy/IAMPolicyMember</td> |
| 44 | + <td>No</td> |
| 45 | +</tr> |
| 46 | + |
| 47 | + |
| 48 | +<tr> |
| 49 | +<td>{{product_name_short}} Default Average Reconcile Interval In Seconds</td> |
| 50 | +<td>600</td> |
| 51 | +</tr> |
| 52 | +</tbody> |
| 53 | +</table> |
| 54 | + |
| 55 | +## Custom Resource Definition Properties |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +### Spec |
| 60 | +#### Schema |
| 61 | +```yaml |
| 62 | +enablement: string |
| 63 | +projectRef: |
| 64 | + external: string |
| 65 | + kind: string |
| 66 | + name: string |
| 67 | + namespace: string |
| 68 | +resourceID: string |
| 69 | +``` |
| 70 | +
|
| 71 | +<table class="properties responsive"> |
| 72 | +<thead> |
| 73 | + <tr> |
| 74 | + <th colspan="2">Fields</th> |
| 75 | + </tr> |
| 76 | +</thead> |
| 77 | +<tbody> |
| 78 | + <tr> |
| 79 | + <td> |
| 80 | + <p><code>enablement</code></p> |
| 81 | + <p><i>Required</i></p> |
| 82 | + </td> |
| 83 | + <td> |
| 84 | + <p><code class="apitype">string</code></p> |
| 85 | + <p>{% verbatim %}Required. The configured value of the enablement at the given resource.{% endverbatim %}</p> |
| 86 | + </td> |
| 87 | + </tr> |
| 88 | + <tr> |
| 89 | + <td> |
| 90 | + <p><code>projectRef</code></p> |
| 91 | + <p><i>Required</i></p> |
| 92 | + </td> |
| 93 | + <td> |
| 94 | + <p><code class="apitype">object</code></p> |
| 95 | + <p>{% verbatim %}The Project that this resource belongs to.{% endverbatim %}</p> |
| 96 | + </td> |
| 97 | + </tr> |
| 98 | + <tr> |
| 99 | + <td> |
| 100 | + <p><code>projectRef.external</code></p> |
| 101 | + <p><i>Optional</i></p> |
| 102 | + </td> |
| 103 | + <td> |
| 104 | + <p><code class="apitype">string</code></p> |
| 105 | + <p>{% verbatim %}The `projectID` field of a project, when not managed by Config Connector.{% endverbatim %}</p> |
| 106 | + </td> |
| 107 | + </tr> |
| 108 | + <tr> |
| 109 | + <td> |
| 110 | + <p><code>projectRef.kind</code></p> |
| 111 | + <p><i>Optional</i></p> |
| 112 | + </td> |
| 113 | + <td> |
| 114 | + <p><code class="apitype">string</code></p> |
| 115 | + <p>{% verbatim %}The kind of the Project resource; optional but must be `Project` if provided.{% endverbatim %}</p> |
| 116 | + </td> |
| 117 | + </tr> |
| 118 | + <tr> |
| 119 | + <td> |
| 120 | + <p><code>projectRef.name</code></p> |
| 121 | + <p><i>Optional</i></p> |
| 122 | + </td> |
| 123 | + <td> |
| 124 | + <p><code class="apitype">string</code></p> |
| 125 | + <p>{% verbatim %}The `name` field of a `Project` resource.{% endverbatim %}</p> |
| 126 | + </td> |
| 127 | + </tr> |
| 128 | + <tr> |
| 129 | + <td> |
| 130 | + <p><code>projectRef.namespace</code></p> |
| 131 | + <p><i>Optional</i></p> |
| 132 | + </td> |
| 133 | + <td> |
| 134 | + <p><code class="apitype">string</code></p> |
| 135 | + <p>{% verbatim %}The `namespace` field of a `Project` resource.{% endverbatim %}</p> |
| 136 | + </td> |
| 137 | + </tr> |
| 138 | + <tr> |
| 139 | + <td> |
| 140 | + <p><code>resourceID</code></p> |
| 141 | + <p><i>Optional</i></p> |
| 142 | + </td> |
| 143 | + <td> |
| 144 | + <p><code class="apitype">string</code></p> |
| 145 | + <p>{% verbatim %}The APIQuotaAdjusterSettings name. If not given, the metadata.name will be used.{% endverbatim %}</p> |
| 146 | + </td> |
| 147 | + </tr> |
| 148 | +</tbody> |
| 149 | +</table> |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | +### Status |
| 154 | +#### Schema |
| 155 | +```yaml |
| 156 | +conditions: |
| 157 | +- lastTransitionTime: string |
| 158 | + message: string |
| 159 | + reason: string |
| 160 | + status: string |
| 161 | + type: string |
| 162 | +externalRef: string |
| 163 | +observedGeneration: integer |
| 164 | +observedState: |
| 165 | + etag: string |
| 166 | + updateTime: string |
| 167 | +``` |
| 168 | + |
| 169 | +<table class="properties responsive"> |
| 170 | +<thead> |
| 171 | + <tr> |
| 172 | + <th colspan="2">Fields</th> |
| 173 | + </tr> |
| 174 | +</thead> |
| 175 | +<tbody> |
| 176 | + <tr> |
| 177 | + <td><code>conditions</code></td> |
| 178 | + <td> |
| 179 | + <p><code class="apitype">list (object)</code></p> |
| 180 | + <p>{% verbatim %}Conditions represent the latest available observations of the object's current state.{% endverbatim %}</p> |
| 181 | + </td> |
| 182 | + </tr> |
| 183 | + <tr> |
| 184 | + <td><code>conditions[]</code></td> |
| 185 | + <td> |
| 186 | + <p><code class="apitype">object</code></p> |
| 187 | + <p>{% verbatim %}{% endverbatim %}</p> |
| 188 | + </td> |
| 189 | + </tr> |
| 190 | + <tr> |
| 191 | + <td><code>conditions[].lastTransitionTime</code></td> |
| 192 | + <td> |
| 193 | + <p><code class="apitype">string</code></p> |
| 194 | + <p>{% verbatim %}Last time the condition transitioned from one status to another.{% endverbatim %}</p> |
| 195 | + </td> |
| 196 | + </tr> |
| 197 | + <tr> |
| 198 | + <td><code>conditions[].message</code></td> |
| 199 | + <td> |
| 200 | + <p><code class="apitype">string</code></p> |
| 201 | + <p>{% verbatim %}Human-readable message indicating details about last transition.{% endverbatim %}</p> |
| 202 | + </td> |
| 203 | + </tr> |
| 204 | + <tr> |
| 205 | + <td><code>conditions[].reason</code></td> |
| 206 | + <td> |
| 207 | + <p><code class="apitype">string</code></p> |
| 208 | + <p>{% verbatim %}Unique, one-word, CamelCase reason for the condition's last transition.{% endverbatim %}</p> |
| 209 | + </td> |
| 210 | + </tr> |
| 211 | + <tr> |
| 212 | + <td><code>conditions[].status</code></td> |
| 213 | + <td> |
| 214 | + <p><code class="apitype">string</code></p> |
| 215 | + <p>{% verbatim %}Status is the status of the condition. Can be True, False, Unknown.{% endverbatim %}</p> |
| 216 | + </td> |
| 217 | + </tr> |
| 218 | + <tr> |
| 219 | + <td><code>conditions[].type</code></td> |
| 220 | + <td> |
| 221 | + <p><code class="apitype">string</code></p> |
| 222 | + <p>{% verbatim %}Type is the type of the condition.{% endverbatim %}</p> |
| 223 | + </td> |
| 224 | + </tr> |
| 225 | + <tr> |
| 226 | + <td><code>externalRef</code></td> |
| 227 | + <td> |
| 228 | + <p><code class="apitype">string</code></p> |
| 229 | + <p>{% verbatim %}A unique specifier for the APIQuotaAdjusterSettings resource in GCP.{% endverbatim %}</p> |
| 230 | + </td> |
| 231 | + </tr> |
| 232 | + <tr> |
| 233 | + <td><code>observedGeneration</code></td> |
| 234 | + <td> |
| 235 | + <p><code class="apitype">integer</code></p> |
| 236 | + <p>{% verbatim %}ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.{% endverbatim %}</p> |
| 237 | + </td> |
| 238 | + </tr> |
| 239 | + <tr> |
| 240 | + <td><code>observedState</code></td> |
| 241 | + <td> |
| 242 | + <p><code class="apitype">object</code></p> |
| 243 | + <p>{% verbatim %}ObservedState is the state of the resource as most recently observed in GCP.{% endverbatim %}</p> |
| 244 | + </td> |
| 245 | + </tr> |
| 246 | + <tr> |
| 247 | + <td><code>observedState.etag</code></td> |
| 248 | + <td> |
| 249 | + <p><code class="apitype">string</code></p> |
| 250 | + <p>{% verbatim %}Optional. The current etag of the QuotaAdjusterSettings. If an etag is provided on update and does not match the current server's etag of the QuotaAdjusterSettings, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.{% endverbatim %}</p> |
| 251 | + </td> |
| 252 | + </tr> |
| 253 | + <tr> |
| 254 | + <td><code>observedState.updateTime</code></td> |
| 255 | + <td> |
| 256 | + <p><code class="apitype">string</code></p> |
| 257 | + <p>{% verbatim %}Output only. The timestamp when the QuotaAdjusterSettings was last updated.{% endverbatim %}</p> |
| 258 | + </td> |
| 259 | + </tr> |
| 260 | +</tbody> |
| 261 | +</table> |
| 262 | + |
| 263 | +## Sample YAML(s) |
| 264 | + |
| 265 | +### Typical Use Case |
| 266 | +```yaml |
| 267 | +# Copyright 2025 Google LLC |
| 268 | +# |
| 269 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 270 | +# you may not use this file except in compliance with the License. |
| 271 | +# You may obtain a copy of the License at |
| 272 | +# |
| 273 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 274 | +# |
| 275 | +# Unless required by applicable law or agreed to in writing, software |
| 276 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 277 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 278 | +# See the License for the specific language governing permissions and |
| 279 | +# limitations under the License. |
| 280 | +
|
| 281 | +apiVersion: cloudquota.cnrm.cloud.google.com/v1beta1 |
| 282 | +kind: APIQuotaAdjusterSettings |
| 283 | +metadata: |
| 284 | + name: apiquotaadjustersettings-sample |
| 285 | +spec: |
| 286 | + resourceID: quotaAdjusterSettings |
| 287 | + projectRef: |
| 288 | + external: projects/${PROJECT_ID?} |
| 289 | + enablement: ENABLED |
| 290 | +``` |
| 291 | + |
| 292 | + |
| 293 | +Note: If you have any trouble with instantiating the resource, refer to <a href="/config-connector/docs/troubleshooting">Troubleshoot Config Connector</a>. |
| 294 | + |
| 295 | +{% endblock %} |
0 commit comments