Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add limit parameter for get usage top average metrics #166

Merged
merged 1 commit into from
Nov 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.3.0",
"regenerated": "2020-11-24 09:46:11.720897",
"spec_repo_commit": "8ea24b0"
"regenerated": "2020-11-24 10:21:04.823364",
"spec_repo_commit": "605e8f8"
},
"v2": {
"apigentools_version": "1.3.0",
"regenerated": "2020-11-24 09:46:22.351897",
"spec_repo_commit": "8ea24b0"
"regenerated": "2020-11-24 10:21:18.659367",
"spec_repo_commit": "605e8f8"
}
}
}
4 changes: 3 additions & 1 deletion docs/v1/UsageMeteringApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2527,6 +2527,7 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
names = [
"names_example",
] # [str] | Comma-separated list of metric names. (optional)
limit = 500 # int | Maximum number of results to return. (optional) if omitted the server will use the default value of 500

# example passing only required values which don't have defaults set
try:
Expand All @@ -2540,7 +2541,7 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
# and optional values
try:
# Get top 500 custom metrics by hourly average
api_response = api_instance.get_usage_top_avg_metrics(month, names=names)
api_response = api_instance.get_usage_top_avg_metrics(month, names=names, limit=limit)
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\n" % e)
Expand All @@ -2552,6 +2553,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**month** | **datetime**| Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. |
**names** | **[str]**| Comma-separated list of metric names. | [optional]
**limit** | **int**| Maximum number of results to return. | [optional] if omitted the server will use the default value of 500

### Return type

Expand Down
12 changes: 12 additions & 0 deletions src/datadog_api_client/v1/api/usage_metering_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3392,6 +3392,7 @@ def __get_usage_top_avg_metrics(

Keyword Args:
names ([str]): Comma-separated list of metric names.. [optional]
limit (int): Maximum number of results to return.. [optional] if omitted the server will use the default value of 500
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
Expand Down Expand Up @@ -3456,6 +3457,7 @@ def __get_usage_top_avg_metrics(
'all': [
'month',
'names',
'limit',
],
'required': [
'month',
Expand All @@ -3465,10 +3467,16 @@ def __get_usage_top_avg_metrics(
'enum': [
],
'validation': [
'limit',
]
},
root_map={
'validations': {
('limit',): {

'inclusive_maximum': 5000,
'inclusive_minimum': 1,
},
},
'allowed_values': {
},
Expand All @@ -3477,14 +3485,18 @@ def __get_usage_top_avg_metrics(
(datetime,),
'names':
([str],),
'limit':
(int,),
},
'attribute_map': {
'month': 'month',
'names': 'names',
'limit': 'limit',
},
'location_map': {
'month': 'query',
'names': 'query',
'limit': 'query',
},
'collection_format_map': {
'names': 'multi',
Expand Down
10 changes: 10 additions & 0 deletions src/datadog_api_client/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15837,6 +15837,16 @@ paths:
items:
type: string
type: array
- description: Maximum number of results to return.
in: query
name: limit
required: false
schema:
default: 500
format: int32
maximum: 5000
minimum: 1
type: integer
responses:
'200':
content:
Expand Down