Class: DatadogAPIClient::V2::UsageQuotaBulkResultAttributes

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

Overview

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.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 45

def additional_properties
  @additional_properties
end

#enforced ⇒ Object

Whether usage above the limit is actively blocked instead of only tracked or alerted on. Omitted if this item failed to write.



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

def enforced
  @enforced
end

#error ⇒ Object

An error message describing why this item failed to write. Omitted if this item was written successfully.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 28

def error
  @error
end

#org_public_id ⇒ Object

The public ID of the organization that owns the quota. Omitted if this item failed to write.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 31

def org_public_id
  @org_public_id
end

#pending_effective_from ⇒ Object

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.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 34

def pending_effective_from
  @pending_effective_from
end

#pending_usage_limit ⇒ Object

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.



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

def pending_usage_limit
  @pending_usage_limit
end

#scope ⇒ Object

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.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 40

def scope
  @scope
end

#usage_limit ⇒ Object

The quota limit in the usage units defined by the quota namespace. May be fractional for quotas configured before public writes required whole units. Omitted if this item failed to write.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/usage_quota_bulk_result_attributes.rb', line 43

def usage_limit
  @usage_limit
end