You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1b7a2d9
Browse filesBrowse the repository at this point in the historyBrowse files
ci.datadog-api-spec
committed
Regenerate client from commit f2f1df9 of spec repo
Creates or updates one or more usage quotas by scope. If a quota already exists for a supplied scope, it is updated; otherwise, a new quota is created. Requires the ``billing_edit`` permission.
664
+
Creates or updates one or more usage quotas by scope. If a quota already exists for a supplied scope, it is updated.
665
+
Otherwise, a quota is created only when ``usage_limit`` and ``enforced`` are provided.
666
+
For the organization-wide quota, ``pending_usage_limit`` schedules a limit for the next usage period and can
667
+
accompany an immediate limit or update an existing quota by itself.
668
+
Scheduled changes follow ``include_descendants`` like the other fields. Requires the ``billing_edit`` permission.
636
669
637
670
:param quota_namespace: The product-specific namespace whose usage quotas are being managed.
Cancels the limit change scheduled to take effect at the start of the next usage period, leaving the usage quota and its current limit unchanged. Returns ``404`` when the quota does not exist, has no scheduled change, or its scheduled change has already taken effect; in every case the quota is left unchanged. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the ``billing_edit`` permission.
696
+
697
+
:param quota_namespace: The product-specific namespace whose usage quotas are being managed.
698
+
:type quota_namespace: str
699
+
:param id: The opaque quota identifier returned by a previous list or create request. Clients must pass this value verbatim.
Updates the supplied fields on a usage quota and leaves omitted fields unchanged. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the ``billing_edit`` permission.
1324
+
Updates the supplied fields on a usage quota and leaves omitted fields unchanged. For an organization-wide quota, ``pending_usage_limit`` schedules a limit for the next usage period. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the ``billing_edit`` permission.
1270
1325
1271
1326
:param quota_namespace: The product-specific namespace whose usage quotas are being managed.
Attributes of a usage quota bulk write result. On success, all fields except ``error`` are present. On failure, only ``error`` is present and the other fields are omitted.
61
+
Attributes of a usage quota bulk write result. On success, quota fields are present as applicable, and pending fields are present only when a change is scheduled. On failure, only ``error`` is present and the other fields are omitted.
52
62
53
63
:param enforced: Whether usage above the limit is actively blocked instead of only tracked or alerted on. Omitted if this item failed to write.
54
64
:type enforced: bool, optional
@@ -59,6 +69,12 @@ def __init__(
59
69
:param org_public_id: The public ID of the organization that owns the quota. Omitted if this item failed to write.
60
70
:type org_public_id: str, optional
61
71
72
+
:param pending_effective_from: The future UTC month when the scheduled limit takes effect, formatted as ``YYYY-MM`` , starting at 00:00 UTC on its first day. Present only together with ``pending_usage_limit`` and omitted when no change is scheduled or this item failed to write.
73
+
:type pending_effective_from: str, optional
74
+
75
+
:param pending_usage_limit: The usage limit scheduled for the organization-wide quota in the usage units defined by the quota namespace. A value of ``0`` is valid. At the start of the effective month, this value becomes ``usage_limit`` and both pending fields are omitted. Omitted when no change is scheduled or this item failed to write.
76
+
:type pending_usage_limit: float, optional
77
+
62
78
:param scope: A namespace-specific key and value identifying what the quota applies to within an organization. The object contains exactly one entry. A value of ``"*"`` identifies the default quota applied to entities without a specific quota. This field is omitted for an organization-wide quota.
The result of writing one usage quota in a bulk create-or-update request.
40
40
41
-
:param attributes: Attributes of a usage quota bulk write result. On success, all fields except ``error`` are present. On failure, only ``error`` is present and the other fields are omitted.
41
+
:param attributes: Attributes of a usage quota bulk write result. On success, quota fields are present as applicable, and pending fields are present only when a change is scheduled. On failure, only ``error`` is present and the other fields are omitted.
42
42
:type attributes: UsageQuotaBulkResultAttributes
43
43
44
44
:param id: An opaque usage quota identifier. Clients must pass this value back verbatim in update and delete requests and must not infer any structure from it.
Attributes for creating or updating a usage quota by scope.
57
+
Attributes for creating or updating a usage quota by scope. Each item must provide ``usage_limit`` , ``pending_usage_limit`` , or both. Providing only ``pending_usage_limit`` updates an existing organization-wide quota, never creates one, requires ``enforced`` to be omitted, and fails if the quota does not exist.
48
58
49
-
:param enforced: Whether to actively block usage above the limit instead of only tracking or alerting on it.
50
-
:type enforced: bool
59
+
:param enforced: Whether to actively block usage above ``usage_limit`` instead of only tracking or alerting on it. Required when ``usage_limit`` is provided and must be omitted when only ``pending_usage_limit`` is provided.
60
+
:type enforced: bool, optional
61
+
62
+
:param pending_usage_limit: The non-negative, whole-number limit to schedule for the organization-wide quota in the usage units defined by the quota namespace. It is not checked against current usage. Each write schedules the value for 00:00 UTC on the first day of the next calendar month and replaces any previously scheduled change; the server computes ``pending_effective_from``. Omit this field to leave any scheduled change unchanged, including when raising ``usage_limit``. Cancel a scheduled change only by deleting the quota's ``/pending`` sub-resource.
63
+
:type pending_usage_limit: int, optional
51
64
52
65
:param scope: A namespace-specific key and value identifying what the quota applies to within an organization. The object must contain exactly one entry. Use ``"*"`` as the value for the default quota applied to entities without a specific quota, or omit the scope for an organization-wide quota. A specific value must identify an existing user handle in the caller's organization when ``include_descendants`` is false. When ``include_descendants`` is true, the handle must exist in the caller's organization or in at least one targeted descendant organization; the quota is then applied only to the organizations where that handle exists, and the request fails only if the handle exists in none of them.
53
66
:type scope: UsageQuotaRequestScope, optional
54
67
55
-
:param usage_limit: The quota limit to set in the usage units defined by the quota namespace. For an organization-wide quota (scope omitted), the limit must be greater than the usage already recorded in the current period.
56
-
:type usage_limit: int
68
+
:param usage_limit: The non-negative, whole-number quota limit to set in the usage units defined by the quota namespace. For an organization-wide quota (scope omitted), the limit must be greater than usage already recorded in the current period. When this field is provided, ``enforced`` is required.
0 commit comments