Class: DatadogAPIClient::V2::UsageQuotaUpdateAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/usage_quota_update_attributes.rb

Overview

Attributes to update on a usage quota. At least one of usage_limit, enforced, or pending_usage_limit must be provided. Omitting a property leaves its current value unchanged.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



37
38
39
# File 'lib/datadog_api_client/v2/models/usage_quota_update_attributes.rb', line 37

def additional_properties
  @additional_properties
end

#enforced ⇒ Object

Whether to actively block usage above the limit. Omit this field to leave the current enforcement setting unchanged.



25
26
27
# File 'lib/datadog_api_client/v2/models/usage_quota_update_attributes.rb', line 25

def enforced
  @enforced
end

#pending_usage_limit ⇒ Object

The limit to apply to the organization-wide quota at 00:00 UTC on the first day of the next calendar month. Must be a non-negative integer in the usage units defined by the quota namespace. This value is not checked against current usage.

Setting this field replaces any previously scheduled limit. The server sets pending_effective_from.

Omitting this field preserves the scheduled change, even when increasing usage_limit. Setting enforced=false clears the scheduled change. To cancel it explicitly, use DELETE /api/v2/usage/quotas/{quota_namespace}/{id}/pending.



32
33
34
# File 'lib/datadog_api_client/v2/models/usage_quota_update_attributes.rb', line 32

def pending_usage_limit
  @pending_usage_limit
end

#usage_limit ⇒ Object

The new quota limit in the usage units defined by the quota namespace. For an organization-wide quota (empty scope), the limit must be greater than the usage already recorded in the current period. Omit this field to leave the current limit unchanged.



35
36
37
# File 'lib/datadog_api_client/v2/models/usage_quota_update_attributes.rb', line 35

def usage_limit
  @usage_limit
end