Add logs_by_retention usage property and GetUsageLogsByRetention endpoint

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-05-07 12:40:41.023990",
-            "spec_repo_commit": "52e5730"
+            "regenerated": "2021-05-10 13:54:44.972483",
+            "spec_repo_commit": "dcadb1c"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-05-07 12:41:31.534053",
-            "spec_repo_commit": "52e5730"
+            "regenerated": "2021-05-10 13:55:32.733610",
+            "spec_repo_commit": "dcadb1c"
         }
     }
 }

api_docs/v1/LogsByRetention.md

@@ -0,0 +1,16 @@
+
+
+# LogsByRetention
+
+Object containing logs usage data broken down by retention period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orgs** | [**LogsByRetentionOrgs**](LogsByRetentionOrgs.md) |  |  [optional]
+**usage** | [**List<LogsRetentionAggSumUsage>**](LogsRetentionAggSumUsage.md) | Aggregated index logs usage for each retention period with usage. |  [optional]
+**usageByMonth** | [**LogsByRetentionMonthlyUsage**](LogsByRetentionMonthlyUsage.md) |  |  [optional]
+
+
+

api_docs/v1/LogsByRetentionMonthlyUsage.md

@@ -0,0 +1,15 @@
+
+
+# LogsByRetentionMonthlyUsage
+
+Object containing a summary of indexed logs usage by retention period for a single month.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **String** | The month for the usage. |  [optional]
+**usage** | [**List<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the month. |  [optional]
+
+
+

api_docs/v1/LogsByRetentionOrgUsage.md

@@ -0,0 +1,14 @@
+
+
+# LogsByRetentionOrgUsage
+
+Indexed logs usage by retention for a single organization.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage** | [**List<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the organization. |  [optional]
+
+
+

api_docs/v1/LogsByRetentionOrgs.md

@@ -0,0 +1,14 @@
+
+
+# LogsByRetentionOrgs
+
+Indexed logs usage summary for each organization for each retention period with usage.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage** | [**List<LogsByRetentionOrgUsage>**](LogsByRetentionOrgUsage.md) | Indexed logs usage summary for each organization. |  [optional]
+
+
+

api_docs/v1/LogsRetentionAggSumUsage.md

@@ -0,0 +1,17 @@
+
+
+# LogsRetentionAggSumUsage
+
+Object containing indexed logs usage aggregated across organizations and months for a retention period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logsIndexedLogsUsageAggSum** | **Long** | Total indexed logs for this retention period. |  [optional]
+**logsLiveIndexedLogsUsageAggSum** | **Long** | Live indexed logs for this retention period. |  [optional]
+**logsRehydratedIndexedLogsUsageAggSum** | **Long** | Rehydrated indexed logs for this retention period. |  [optional]
+**retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. |  [optional]
+
+
+

api_docs/v1/LogsRetentionSumUsage.md

@@ -0,0 +1,17 @@
+
+
+# LogsRetentionSumUsage
+
+Object containing indexed logs usage grouped by retention period and summed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logsIndexedLogsUsageSum** | **Long** | Total indexed logs for this retention period. |  [optional]
+**logsLiveIndexedLogsUsageSum** | **Long** | Live indexed logs for this retention period. |  [optional]
+**logsRehydratedIndexedLogsUsageSum** | **Long** | Rehydrated indexed logs for this retention period. |  [optional]
+**retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. |  [optional]
+
+
+

api_docs/v1/README.md

@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
 *UsageMeteringApi* | [**getUsageLambda**](UsageMeteringApi.md#getUsageLambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda
 *UsageMeteringApi* | [**getUsageLogs**](UsageMeteringApi.md#getUsageLogs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs
 *UsageMeteringApi* | [**getUsageLogsByIndex**](UsageMeteringApi.md#getUsageLogsByIndex) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index
+*UsageMeteringApi* | [**getUsageLogsByRetention**](UsageMeteringApi.md#getUsageLogsByRetention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention
 *UsageMeteringApi* | [**getUsageNetworkFlows**](UsageMeteringApi.md#getUsageNetworkFlows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows
 *UsageMeteringApi* | [**getUsageNetworkHosts**](UsageMeteringApi.md#getUsageNetworkHosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts
 *UsageMeteringApi* | [**getUsageProfiling**](UsageMeteringApi.md#getUsageProfiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts
@@ -340,6 +341,10 @@ Class | Method | HTTP request | Description
  - [LogsArithmeticProcessorType](LogsArithmeticProcessorType.md)
  - [LogsAttributeRemapper](LogsAttributeRemapper.md)
  - [LogsAttributeRemapperType](LogsAttributeRemapperType.md)
+ - [LogsByRetention](LogsByRetention.md)
+ - [LogsByRetentionMonthlyUsage](LogsByRetentionMonthlyUsage.md)
+ - [LogsByRetentionOrgUsage](LogsByRetentionOrgUsage.md)
+ - [LogsByRetentionOrgs](LogsByRetentionOrgs.md)
  - [LogsCategoryProcessor](LogsCategoryProcessor.md)
  - [LogsCategoryProcessorCategory](LogsCategoryProcessorCategory.md)
  - [LogsCategoryProcessorType](LogsCategoryProcessorType.md)
@@ -370,6 +375,8 @@ Class | Method | HTTP request | Description
  - [LogsPipelinesOrder](LogsPipelinesOrder.md)
  - [LogsProcessor](LogsProcessor.md)
  - [LogsQueryCompute](LogsQueryCompute.md)
+ - [LogsRetentionAggSumUsage](LogsRetentionAggSumUsage.md)
+ - [LogsRetentionSumUsage](LogsRetentionSumUsage.md)
  - [LogsServiceRemapper](LogsServiceRemapper.md)
  - [LogsServiceRemapperType](LogsServiceRemapperType.md)
  - [LogsSort](LogsSort.md)
@@ -621,6 +628,8 @@ Class | Method | HTTP request | Description
  - [UsageLambdaResponse](UsageLambdaResponse.md)
  - [UsageLogsByIndexHour](UsageLogsByIndexHour.md)
  - [UsageLogsByIndexResponse](UsageLogsByIndexResponse.md)
+ - [UsageLogsByRetentionHour](UsageLogsByRetentionHour.md)
+ - [UsageLogsByRetentionResponse](UsageLogsByRetentionResponse.md)
  - [UsageLogsHour](UsageLogsHour.md)
  - [UsageLogsResponse](UsageLogsResponse.md)
  - [UsageMetricCategory](UsageMetricCategory.md)

api_docs/v1/UsageLogsByRetentionHour.md

@@ -0,0 +1,17 @@
+
+
+# UsageLogsByRetentionHour
+
+The number of indexed logs for each hour for a given organization broken down by retention period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indexedEventsCount** | **Long** | Total logs indexed with this retention period during a given hour. |  [optional]
+**liveIndexedEventsCount** | **Long** | Live logs indexed with this retention period during a given hour. |  [optional]
+**rehydratedIndexedEventsCount** | **Long** | Rehydrated logs indexed with this retention period during a given hour. |  [optional]
+**retention** | **String** | The retention period in days or \"custom\" for all custom retention usage. |  [optional]
+
+
+

api_docs/v1/UsageLogsByRetentionResponse.md

@@ -0,0 +1,14 @@
+
+
+# UsageLogsByRetentionResponse
+
+Response containing the indexed logs usage broken down by retention period for an organization during a given hour.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage** | [**List<UsageLogsByRetentionHour>**](UsageLogsByRetentionHour.md) | Get hourly usage for indexed logs by retention period. |  [optional]
+
+
+

api_docs/v1/UsageMeteringApi.md

@@ -22,6 +22,7 @@ Method | HTTP request | Description
 [**getUsageLambda**](UsageMeteringApi.md#getUsageLambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda
 [**getUsageLogs**](UsageMeteringApi.md#getUsageLogs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs
 [**getUsageLogsByIndex**](UsageMeteringApi.md#getUsageLogsByIndex) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index
+[**getUsageLogsByRetention**](UsageMeteringApi.md#getUsageLogsByRetention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention
 [**getUsageNetworkFlows**](UsageMeteringApi.md#getUsageNetworkFlows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows
 [**getUsageNetworkHosts**](UsageMeteringApi.md#getUsageNetworkHosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts
 [**getUsageProfiling**](UsageMeteringApi.md#getUsageProfiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts
@@ -1346,6 +1347,78 @@ Name | Type | Description  | Notes
 | **403** | Forbidden - User is not authorized |  -  |
 
 
+## getUsageLogsByRetention
+
+> UsageLogsByRetentionResponse getUsageLogsByRetention(startHr, parameters);
+
+Get hourly logs usage by retention
+
+Get hourly usage for indexed logs by retention period.
+
+### Example
+
+```java
+import java.time.OffsetDateTime;
+// Import classes:
+import java.util.*;
+import com.datadog.api.v1.client.ApiClient;
+import com.datadog.api.v1.client.ApiException;
+import com.datadog.api.v1.client.Configuration;
+import com.datadog.api.v1.client.auth.*;
+import com.datadog.api.v1.client.model.*;
+import com.datadog.api.v1.client.api.UsageMeteringApi;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+        UsageMeteringApi apiInstance = new UsageMeteringApi(defaultClient);
+        OffsetDateTime startHr = OffsetDateTime.now(); // OffsetDateTime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+        OffsetDateTime endHr = OffsetDateTime.now(); // OffsetDateTime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.
+        try {
+	    UsageLogsByRetentionResponse result = apiInstance.getUsageLogsByRetention(startHr, new UsageMeteringApi.GetUsageLogsByRetentionOptionalParameters()
+                .endHr(endHr));
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling UsageMeteringApi#getUsageLogsByRetention");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **startHr** | **OffsetDateTime**| Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. |
+ **endHr** | **OffsetDateTime**| Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional]
+
+### Return type
+
+[**UsageLogsByRetentionResponse**](UsageLogsByRetentionResponse.md)
+
+### Authorization
+
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json;datetime-format=rfc3339
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad Request |  -  |
+| **403** | Forbidden - User is not authorized |  -  |
+
+
 ## getUsageNetworkFlows
 
 > UsageNetworkFlowsResponse getUsageNetworkFlows(startHr, parameters);

api_docs/v1/UsageSummaryResponse.md

@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **lastUpdated** | **OffsetDateTime** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. |  [optional]
 **liveIndexedEventsAggSum** | **Long** | Shows the sum of all live logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). |  [optional]
 **liveIngestedBytesAggSum** | **Long** | Shows the sum of all live logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). |  [optional]
+**logsByRetention** | [**LogsByRetention**](LogsByRetention.md) |  |  [optional]
 **mobileRumSessionCountAggSum** | **Long** | Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations. |  [optional]
 **mobileRumSessionCountAndroidAggSum** | **Long** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations. |  [optional]
 **mobileRumSessionCountIosAggSum** | **Long** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations. |  [optional]