Skip to content

Commit 34eedde

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 3e66447 of spec repo (#106)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent acfa5de commit 34eedde

20 files changed

+1422
-4
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.2.0",
7-
"regenerated": "2020-10-02 12:11:56.338365",
8-
"spec_repo_commit": "8d1ef64"
7+
"regenerated": "2020-10-05 08:54:47.138698",
8+
"spec_repo_commit": "3e66447"
99
},
1010
"v2": {
1111
"apigentools_version": "1.2.0",
12-
"regenerated": "2020-10-02 12:12:05.995977",
13-
"spec_repo_commit": "8d1ef64"
12+
"regenerated": "2020-10-05 08:54:57.081213",
13+
"spec_repo_commit": "3e66447"
1414
}
1515
}
1616
}

.openapi-generator/FILES

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ datadog_api_client/v2/model/logs_archive_destination_s3_type.py
6060
datadog_api_client/v2/model/logs_archive_integration_azure.py
6161
datadog_api_client/v2/model/logs_archive_integration_gcs.py
6262
datadog_api_client/v2/model/logs_archive_integration_s3.py
63+
datadog_api_client/v2/model/logs_archive_order.py
64+
datadog_api_client/v2/model/logs_archive_order_attributes.py
65+
datadog_api_client/v2/model/logs_archive_order_definition.py
66+
datadog_api_client/v2/model/logs_archive_order_definition_type.py
6367
datadog_api_client/v2/model/logs_archive_state.py
6468
datadog_api_client/v2/model/logs_archives.py
6569
datadog_api_client/v2/model/logs_compute.py
@@ -244,6 +248,10 @@ docs/LogsArchiveDestinationS3Type.md
244248
docs/LogsArchiveIntegrationAzure.md
245249
docs/LogsArchiveIntegrationGCS.md
246250
docs/LogsArchiveIntegrationS3.md
251+
docs/LogsArchiveOrder.md
252+
docs/LogsArchiveOrderAttributes.md
253+
docs/LogsArchiveOrderDefinition.md
254+
docs/LogsArchiveOrderDefinitionType.md
247255
docs/LogsArchiveState.md
248256
docs/LogsArchives.md
249257
docs/LogsArchivesApi.md
@@ -432,6 +440,10 @@ test/test_logs_archive_destination_s3_type.py
432440
test/test_logs_archive_integration_azure.py
433441
test/test_logs_archive_integration_gcs.py
434442
test/test_logs_archive_integration_s3.py
443+
test/test_logs_archive_order.py
444+
test/test_logs_archive_order_attributes.py
445+
test/test_logs_archive_order_definition.py
446+
test/test_logs_archive_order_definition_type.py
435447
test/test_logs_archive_state.py
436448
test/test_logs_archives.py
437449
test/test_logs_archives_api.py

docs/v2/LogsArchiveOrder.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LogsArchiveOrder
2+
3+
A ordered list of archive IDs.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**data** | [**LogsArchiveOrderDefinition**](LogsArchiveOrderDefinition.md) | | [optional]
8+
9+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
10+
11+

docs/v2/LogsArchiveOrderAttributes.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LogsArchiveOrderAttributes
2+
3+
The attributes associated with the archive order.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**archive_ids** | **[str]** | An ordered array of &#x60;&lt;ARCHIVE_ID&gt;&#x60; strings, the order of archive IDs in the array define the overall archives order for Datadog. |
8+
9+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
10+
11+

docs/v2/LogsArchiveOrderDefinition.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# LogsArchiveOrderDefinition
2+
3+
The definition of an archive order.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**attributes** | [**LogsArchiveOrderAttributes**](LogsArchiveOrderAttributes.md) | |
8+
**type** | [**LogsArchiveOrderDefinitionType**](LogsArchiveOrderDefinitionType.md) | |
9+
10+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
11+
12+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LogsArchiveOrderDefinitionType
2+
3+
Type of the archive order definition.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | Type of the archive order definition. | if omitted the server will use the default value of "archive_order", must be one of ["archive_order", ]
8+
9+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
10+
11+

docs/v2/LogsArchivesApi.md

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ Method | HTTP request | Description
88
[**create_logs_archive**](LogsArchivesApi.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive
99
[**delete_logs_archive**](LogsArchivesApi.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive
1010
[**get_logs_archive**](LogsArchivesApi.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive
11+
[**get_logs_archive_order**](LogsArchivesApi.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order
1112
[**list_archive_read_roles**](LogsArchivesApi.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive
1213
[**list_logs_archives**](LogsArchivesApi.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives
1314
[**remove_role_from_archive**](LogsArchivesApi.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive
1415
[**update_logs_archive**](LogsArchivesApi.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive
16+
[**update_logs_archive_order**](LogsArchivesApi.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order
1517

1618

1719
# **add_read_role_to_archive**
@@ -379,6 +381,86 @@ Name | Type | Description | Notes
379381

380382
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
381383

384+
# **get_logs_archive_order**
385+
> LogsArchiveOrder get_logs_archive_order()
386+
387+
Get archive order
388+
389+
Get the current order of your archives. This endpoint takes no JSON arguments.
390+
391+
### Example
392+
393+
* Api Key Authentication (apiKeyAuth):
394+
* Api Key Authentication (appKeyAuth):
395+
```python
396+
import os
397+
import time
398+
import datadog_api_client.v2
399+
from datadog_api_client.v2.api import logs_archives_api
400+
from datadog_api_client.v2.model.logs_archive_order import LogsArchiveOrder
401+
from datadog_api_client.v2.model.api_error_response import APIErrorResponse
402+
from pprint import pprint
403+
# Defining the host is optional and defaults to https://api.datadoghq.com
404+
# See configuration.py for a list of all supported configuration parameters.
405+
configuration = datadog_api_client.v2.Configuration(
406+
host = "https://api.datadoghq.com"
407+
)
408+
409+
# The client must configure the authentication and authorization parameters
410+
# in accordance with the API server security policy.
411+
# Examples for each auth method are provided below, use the example that
412+
# satisfies your auth use case.
413+
414+
# Configure API key authorization: apiKeyAuth
415+
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
416+
417+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
418+
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
419+
420+
# Configure API key authorization: appKeyAuth
421+
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
422+
423+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
424+
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
425+
426+
# Enter a context with an instance of the API client
427+
with datadog_api_client.v2.ApiClient(configuration) as api_client:
428+
# Create an instance of the API class
429+
api_instance = logs_archives_api.LogsArchivesApi(api_client)
430+
431+
# example, this endpoint has no required or optional parameters
432+
try:
433+
# Get archive order
434+
api_response = api_instance.get_logs_archive_order()
435+
pprint(api_response)
436+
except datadog_api_client.v2.ApiException as e:
437+
print("Exception when calling LogsArchivesApi->get_logs_archive_order: %s\n" % e)
438+
```
439+
440+
### Parameters
441+
This endpoint does not need any parameter.
442+
443+
### Return type
444+
445+
[**LogsArchiveOrder**](LogsArchiveOrder.md)
446+
447+
### Authorization
448+
449+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
450+
451+
### HTTP request headers
452+
453+
- **Content-Type**: Not defined
454+
- **Accept**: application/json
455+
456+
### HTTP response details
457+
| Status code | Description | Response headers |
458+
|-------------|-------------|------------------|
459+
**200** | OK | - |
460+
**403** | Forbidden | - |
461+
462+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
463+
382464
# **list_archive_read_roles**
383465
> RolesResponse list_archive_read_roles(archive_id)
384466
@@ -743,3 +825,98 @@ Name | Type | Description | Notes
743825

744826
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
745827

828+
# **update_logs_archive_order**
829+
> LogsArchiveOrder update_logs_archive_order(body)
830+
831+
Update archive order
832+
833+
Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. **Note**: Using the `PUT` method updates your archive's order by replacing the current order with the new one.
834+
835+
### Example
836+
837+
* Api Key Authentication (apiKeyAuth):
838+
* Api Key Authentication (appKeyAuth):
839+
```python
840+
import os
841+
import time
842+
import datadog_api_client.v2
843+
from datadog_api_client.v2.api import logs_archives_api
844+
from datadog_api_client.v2.model.logs_archive_order import LogsArchiveOrder
845+
from datadog_api_client.v2.model.api_error_response import APIErrorResponse
846+
from pprint import pprint
847+
# Defining the host is optional and defaults to https://api.datadoghq.com
848+
# See configuration.py for a list of all supported configuration parameters.
849+
configuration = datadog_api_client.v2.Configuration(
850+
host = "https://api.datadoghq.com"
851+
)
852+
853+
# The client must configure the authentication and authorization parameters
854+
# in accordance with the API server security policy.
855+
# Examples for each auth method are provided below, use the example that
856+
# satisfies your auth use case.
857+
858+
# Configure API key authorization: apiKeyAuth
859+
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
860+
861+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
862+
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
863+
864+
# Configure API key authorization: appKeyAuth
865+
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
866+
867+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
868+
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
869+
870+
# Enter a context with an instance of the API client
871+
with datadog_api_client.v2.ApiClient(configuration) as api_client:
872+
# Create an instance of the API class
873+
api_instance = logs_archives_api.LogsArchivesApi(api_client)
874+
body = LogsArchiveOrder(
875+
data=LogsArchiveOrderDefinition(
876+
attributes=LogsArchiveOrderAttributes(
877+
archive_ids=[
878+
"["a2zcMylnM4OCHpYusxIi1g","a2zcMylnM4OCHpYusxIi2g","a2zcMylnM4OCHpYusxIi3g"]",
879+
],
880+
),
881+
type=LogsArchiveOrderDefinitionType("archive_order"),
882+
),
883+
) # LogsArchiveOrder | An object containing the new ordered list of archive IDs.
884+
885+
# example passing only required values which don't have defaults set
886+
try:
887+
# Update archive order
888+
api_response = api_instance.update_logs_archive_order(body)
889+
pprint(api_response)
890+
except datadog_api_client.v2.ApiException as e:
891+
print("Exception when calling LogsArchivesApi->update_logs_archive_order: %s\n" % e)
892+
```
893+
894+
### Parameters
895+
896+
Name | Type | Description | Notes
897+
------------- | ------------- | ------------- | -------------
898+
**body** | [**LogsArchiveOrder**](LogsArchiveOrder.md)| An object containing the new ordered list of archive IDs. |
899+
900+
### Return type
901+
902+
[**LogsArchiveOrder**](LogsArchiveOrder.md)
903+
904+
### Authorization
905+
906+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
907+
908+
### HTTP request headers
909+
910+
- **Content-Type**: application/json
911+
- **Accept**: application/json
912+
913+
### HTTP response details
914+
| Status code | Description | Response headers |
915+
|-------------|-------------|------------------|
916+
**200** | OK | - |
917+
**400** | Bad Request | - |
918+
**403** | Forbidden | - |
919+
**422** | Unprocessable Entity | - |
920+
921+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
922+

docs/v2/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,12 @@ Class | Method | HTTP request | Description
122122
*LogsArchivesApi* | [**create_logs_archive**](LogsArchivesApi.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive
123123
*LogsArchivesApi* | [**delete_logs_archive**](LogsArchivesApi.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive
124124
*LogsArchivesApi* | [**get_logs_archive**](LogsArchivesApi.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive
125+
*LogsArchivesApi* | [**get_logs_archive_order**](LogsArchivesApi.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order
125126
*LogsArchivesApi* | [**list_archive_read_roles**](LogsArchivesApi.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive
126127
*LogsArchivesApi* | [**list_logs_archives**](LogsArchivesApi.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives
127128
*LogsArchivesApi* | [**remove_role_from_archive**](LogsArchivesApi.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive
128129
*LogsArchivesApi* | [**update_logs_archive**](LogsArchivesApi.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive
130+
*LogsArchivesApi* | [**update_logs_archive_order**](LogsArchivesApi.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order
129131
*RolesApi* | [**add_permission_to_role**](RolesApi.md#add_permission_to_role) | **POST** /api/v2/roles/{role_id}/permissions | Grant permission to a role
130132
*RolesApi* | [**add_user_to_role**](RolesApi.md#add_user_to_role) | **POST** /api/v2/roles/{role_id}/users | Add a user to a role
131133
*RolesApi* | [**create_role**](RolesApi.md#create_role) | **POST** /api/v2/roles | Create role
@@ -213,6 +215,10 @@ Class | Method | HTTP request | Description
213215
- [LogsArchiveIntegrationAzure](LogsArchiveIntegrationAzure.md)
214216
- [LogsArchiveIntegrationGCS](LogsArchiveIntegrationGCS.md)
215217
- [LogsArchiveIntegrationS3](LogsArchiveIntegrationS3.md)
218+
- [LogsArchiveOrder](LogsArchiveOrder.md)
219+
- [LogsArchiveOrderAttributes](LogsArchiveOrderAttributes.md)
220+
- [LogsArchiveOrderDefinition](LogsArchiveOrderDefinition.md)
221+
- [LogsArchiveOrderDefinitionType](LogsArchiveOrderDefinitionType.md)
216222
- [LogsArchiveState](LogsArchiveState.md)
217223
- [LogsArchives](LogsArchives.md)
218224
- [LogsCompute](LogsCompute.md)

0 commit comments

Comments
 (0)