Skip to content

Commit 0bb45e0

Browse files
author
Roman Hartig
committed
XSH-733: Regenerate afm-client to allow fetching ResultCacheMetadata
1 parent f8a5d8c commit 0bb45e0

28 files changed

Lines changed: 1502 additions & 216 deletions

gooddata-afm-client/.openapi-generator/FILES

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ docs/ArithmeticMeasureDefinitionArithmeticMeasure.md
2626
docs/AttributeExecutionResultHeader.md
2727
docs/AttributeFilter.md
2828
docs/AttributeFilterElements.md
29-
docs/AttributeHeader.md
3029
docs/AttributeHeaderOut.md
30+
docs/AttributeHeaderOutAttributeHeader.md
3131
docs/AttributeItem.md
3232
docs/AttributeResultHeader.md
3333
docs/ComparisonMeasureValueFilter.md
@@ -57,7 +57,7 @@ docs/InlineMeasureDefinition.md
5757
docs/InlineMeasureDefinitionInline.md
5858
docs/MeasureDefinition.md
5959
docs/MeasureExecutionResultHeader.md
60-
docs/MeasureGroupHeader.md
60+
docs/MeasureGroupHeaders.md
6161
docs/MeasureHeaderOut.md
6262
docs/MeasureItem.md
6363
docs/MeasureResultHeader.md
@@ -82,14 +82,17 @@ docs/RankingFilterRankingFilter.md
8282
docs/RelativeDateFilter.md
8383
docs/RelativeDateFilterRelativeDateFilter.md
8484
docs/RestApiIdentifier.md
85+
docs/ResultCacheMetadata.md
8586
docs/ResultDimension.md
86-
docs/ResultDimensionHeadersInner.md
87+
docs/ResultDimensionHeader.md
8788
docs/ResultSpec.md
8889
docs/SimpleMeasureDefinition.md
8990
docs/SimpleMeasureDefinitionMeasure.md
9091
docs/SortKey.md
9192
docs/SortKeyAttribute.md
9293
docs/SortKeyAttributeAttribute.md
94+
docs/SortKeyTotal.md
95+
docs/SortKeyTotalTotal.md
9396
docs/SortKeyValue.md
9497
docs/SortKeyValueValue.md
9598
docs/StatusType.md
@@ -130,8 +133,8 @@ gooddata_afm_client/model/arithmetic_measure_definition_arithmetic_measure.py
130133
gooddata_afm_client/model/attribute_execution_result_header.py
131134
gooddata_afm_client/model/attribute_filter.py
132135
gooddata_afm_client/model/attribute_filter_elements.py
133-
gooddata_afm_client/model/attribute_header.py
134136
gooddata_afm_client/model/attribute_header_out.py
137+
gooddata_afm_client/model/attribute_header_out_attribute_header.py
135138
gooddata_afm_client/model/attribute_item.py
136139
gooddata_afm_client/model/attribute_result_header.py
137140
gooddata_afm_client/model/comparison_measure_value_filter.py
@@ -161,7 +164,7 @@ gooddata_afm_client/model/inline_measure_definition.py
161164
gooddata_afm_client/model/inline_measure_definition_inline.py
162165
gooddata_afm_client/model/measure_definition.py
163166
gooddata_afm_client/model/measure_execution_result_header.py
164-
gooddata_afm_client/model/measure_group_header.py
167+
gooddata_afm_client/model/measure_group_headers.py
165168
gooddata_afm_client/model/measure_header_out.py
166169
gooddata_afm_client/model/measure_item.py
167170
gooddata_afm_client/model/measure_result_header.py
@@ -186,14 +189,17 @@ gooddata_afm_client/model/ranking_filter_ranking_filter.py
186189
gooddata_afm_client/model/relative_date_filter.py
187190
gooddata_afm_client/model/relative_date_filter_relative_date_filter.py
188191
gooddata_afm_client/model/rest_api_identifier.py
192+
gooddata_afm_client/model/result_cache_metadata.py
189193
gooddata_afm_client/model/result_dimension.py
190-
gooddata_afm_client/model/result_dimension_headers_inner.py
194+
gooddata_afm_client/model/result_dimension_header.py
191195
gooddata_afm_client/model/result_spec.py
192196
gooddata_afm_client/model/simple_measure_definition.py
193197
gooddata_afm_client/model/simple_measure_definition_measure.py
194198
gooddata_afm_client/model/sort_key.py
195199
gooddata_afm_client/model/sort_key_attribute.py
196200
gooddata_afm_client/model/sort_key_attribute_attribute.py
201+
gooddata_afm_client/model/sort_key_total.py
202+
gooddata_afm_client/model/sort_key_total_total.py
197203
gooddata_afm_client/model/sort_key_value.py
198204
gooddata_afm_client/model/sort_key_value_value.py
199205
gooddata_afm_client/model/status_type.py

gooddata-afm-client/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ from gooddata_afm_client.model.elements_request import ElementsRequest
5858
from gooddata_afm_client.model.elements_response import ElementsResponse
5959
from gooddata_afm_client.model.execution_result import ExecutionResult
6060
from gooddata_afm_client.model.problem import Problem
61+
from gooddata_afm_client.model.result_cache_metadata import ResultCacheMetadata
6162
# Defining the host is optional and defaults to http://localhost
6263
# See configuration.py for a list of all supported configuration parameters.
6364
configuration = gooddata_afm_client.Configuration(
@@ -107,6 +108,7 @@ Class | Method | HTTP request | Description
107108
*ActionsApi* | [**compute_report**](docs/ActionsApi.md#compute_report) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute | Executes analytical request and returns link to the result
108109
*ActionsApi* | [**compute_valid_objects**](docs/ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects
109110
*ActionsApi* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource.
111+
*ActionsApi* | [**retrieve_execution_metadata**](docs/ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata.
110112
*ActionsApi* | [**retrieve_result**](docs/ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result
111113

112114

@@ -137,8 +139,8 @@ Class | Method | HTTP request | Description
137139
- [AttributeExecutionResultHeader](docs/AttributeExecutionResultHeader.md)
138140
- [AttributeFilter](docs/AttributeFilter.md)
139141
- [AttributeFilterElements](docs/AttributeFilterElements.md)
140-
- [AttributeHeader](docs/AttributeHeader.md)
141142
- [AttributeHeaderOut](docs/AttributeHeaderOut.md)
143+
- [AttributeHeaderOutAttributeHeader](docs/AttributeHeaderOutAttributeHeader.md)
142144
- [AttributeItem](docs/AttributeItem.md)
143145
- [AttributeResultHeader](docs/AttributeResultHeader.md)
144146
- [ComparisonMeasureValueFilter](docs/ComparisonMeasureValueFilter.md)
@@ -168,7 +170,7 @@ Class | Method | HTTP request | Description
168170
- [InlineMeasureDefinitionInline](docs/InlineMeasureDefinitionInline.md)
169171
- [MeasureDefinition](docs/MeasureDefinition.md)
170172
- [MeasureExecutionResultHeader](docs/MeasureExecutionResultHeader.md)
171-
- [MeasureGroupHeader](docs/MeasureGroupHeader.md)
173+
- [MeasureGroupHeaders](docs/MeasureGroupHeaders.md)
172174
- [MeasureHeaderOut](docs/MeasureHeaderOut.md)
173175
- [MeasureItem](docs/MeasureItem.md)
174176
- [MeasureResultHeader](docs/MeasureResultHeader.md)
@@ -193,14 +195,17 @@ Class | Method | HTTP request | Description
193195
- [RelativeDateFilter](docs/RelativeDateFilter.md)
194196
- [RelativeDateFilterRelativeDateFilter](docs/RelativeDateFilterRelativeDateFilter.md)
195197
- [RestApiIdentifier](docs/RestApiIdentifier.md)
198+
- [ResultCacheMetadata](docs/ResultCacheMetadata.md)
196199
- [ResultDimension](docs/ResultDimension.md)
197-
- [ResultDimensionHeadersInner](docs/ResultDimensionHeadersInner.md)
200+
- [ResultDimensionHeader](docs/ResultDimensionHeader.md)
198201
- [ResultSpec](docs/ResultSpec.md)
199202
- [SimpleMeasureDefinition](docs/SimpleMeasureDefinition.md)
200203
- [SimpleMeasureDefinitionMeasure](docs/SimpleMeasureDefinitionMeasure.md)
201204
- [SortKey](docs/SortKey.md)
202205
- [SortKeyAttribute](docs/SortKeyAttribute.md)
203206
- [SortKeyAttributeAttribute](docs/SortKeyAttributeAttribute.md)
207+
- [SortKeyTotal](docs/SortKeyTotal.md)
208+
- [SortKeyTotalTotal](docs/SortKeyTotalTotal.md)
204209
- [SortKeyValue](docs/SortKeyValue.md)
205210
- [SortKeyValueValue](docs/SortKeyValueValue.md)
206211
- [StatusType](docs/StatusType.md)

gooddata-afm-client/docs/ActionsApi.md

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Method | HTTP request | Description
88
[**compute_report**](ActionsApi.md#compute_report) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute | Executes analytical request and returns link to the result
99
[**compute_valid_objects**](ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects
1010
[**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource.
11+
[**retrieve_execution_metadata**](ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata.
1112
[**retrieve_result**](ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result
1213

1314

@@ -484,6 +485,77 @@ No authorization required
484485

485486
[[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)
486487

488+
# **retrieve_execution_metadata**
489+
> ResultCacheMetadata retrieve_execution_metadata(workspace_id, result_id)
490+
491+
Get a single execution result's metadata.
492+
493+
The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse
494+
495+
### Example
496+
497+
498+
```python
499+
import time
500+
import gooddata_afm_client
501+
from gooddata_afm_client.api import actions_api
502+
from gooddata_afm_client.model.problem import Problem
503+
from gooddata_afm_client.model.result_cache_metadata import ResultCacheMetadata
504+
from pprint import pprint
505+
# Defining the host is optional and defaults to http://localhost
506+
# See configuration.py for a list of all supported configuration parameters.
507+
configuration = gooddata_afm_client.Configuration(
508+
host = "http://localhost"
509+
)
510+
511+
512+
# Enter a context with an instance of the API client
513+
with gooddata_afm_client.ApiClient() as api_client:
514+
# Create an instance of the API class
515+
api_instance = actions_api.ActionsApi(api_client)
516+
workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier
517+
result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID
518+
519+
# example passing only required values which don't have defaults set
520+
try:
521+
# Get a single execution result's metadata.
522+
api_response = api_instance.retrieve_execution_metadata(workspace_id, result_id)
523+
pprint(api_response)
524+
except gooddata_afm_client.ApiException as e:
525+
print("Exception when calling ActionsApi->retrieve_execution_metadata: %s\n" % e)
526+
```
527+
528+
529+
### Parameters
530+
531+
Name | Type | Description | Notes
532+
------------- | ------------- | ------------- | -------------
533+
**workspace_id** | **str**| Workspace identifier |
534+
**result_id** | **str**| Result ID |
535+
536+
### Return type
537+
538+
[**ResultCacheMetadata**](ResultCacheMetadata.md)
539+
540+
### Authorization
541+
542+
No authorization required
543+
544+
### HTTP request headers
545+
546+
- **Content-Type**: Not defined
547+
- **Accept**: application/json
548+
549+
550+
### HTTP response details
551+
552+
| Status code | Description | Response headers |
553+
|-------------|-------------|------------------|
554+
**200** | Execution result's metadata was found and returned. | - |
555+
**404** | Execution result was not found. | - |
556+
557+
[[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)
558+
487559
# **retrieve_result**
488560
> ExecutionResult retrieve_result(workspace_id, result_id)
489561
@@ -520,6 +592,9 @@ with gooddata_afm_client.ApiClient() as api_client:
520592
limit = [
521593
limit=1,10,
522594
] # [int] | Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of []
595+
excluded_total_dimensions = [
596+
"excludedTotalDimensions=dim_0,dim_1",
597+
] # [str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) if omitted the server will use the default value of []
523598

524599
# example passing only required values which don't have defaults set
525600
try:
@@ -533,7 +608,7 @@ with gooddata_afm_client.ApiClient() as api_client:
533608
# and optional values
534609
try:
535610
# Get a single execution result
536-
api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit)
611+
api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions)
537612
pprint(api_response)
538613
except gooddata_afm_client.ApiException as e:
539614
print("Exception when calling ActionsApi->retrieve_result: %s\n" % e)
@@ -548,6 +623,7 @@ Name | Type | Description | Notes
548623
**result_id** | **str**| Result ID |
549624
**offset** | **[int]**| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of []
550625
**limit** | **[int]**| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of []
626+
**excluded_total_dimensions** | **[str]**| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] if omitted the server will use the default value of []
551627

552628
### Return type
553629

@@ -568,7 +644,7 @@ No authorization required
568644
| Status code | Description | Response headers |
569645
|-------------|-------------|------------------|
570646
**200** | Execution result was found and returned. | - |
571-
**400** | Limit and/or offset query parameters (paging) were invalid. | - |
647+
**400** | Limit and/or offset and/or excludedTotalDimensions query parameters (paging) were invalid. | - |
572648
**404** | Execution result was not found. | - |
573649
**500** | The result processing has failed unexpectedly. | - |
574650

gooddata-afm-client/docs/AttributeHeaderOut.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
8-
**attribute_name** | **str** | |
9-
**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
10-
**label_name** | **str** | |
11-
**local_identifier** | **str** | |
12-
**primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
13-
**granularity** | **str** | | [optional]
7+
**attribute_header** | [**AttributeHeaderOutAttributeHeader**](AttributeHeaderOutAttributeHeader.md) | |
148
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
159

1610
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# AttributeHeaderOutAttributeHeader
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
8+
**attribute_name** | **str** | |
9+
**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
10+
**label_name** | **str** | |
11+
**local_identifier** | **str** | |
12+
**primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
13+
**granularity** | **str** | | [optional]
14+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
18+

gooddata-afm-client/docs/DataColumnLocators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**properties** | [**{str: (DataColumnLocator,)}**](DataColumnLocator.md) | Mapping from dimensions to data column locators. Locators for each dimension opposite to the sorted one must be specified. | [optional]
7+
**properties** | [**{str: (DataColumnLocator,)}**](DataColumnLocator.md) | Mapping from dimensions to data column locators. | [optional]
88
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

gooddata-afm-client/docs/MeasureGroupHeader.md renamed to gooddata-afm-client/docs/MeasureGroupHeaders.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# MeasureGroupHeader
1+
# MeasureGroupHeaders
22

33

44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**measure_group_headers** | [**[MeasureHeaderOut]**](MeasureHeaderOut.md) | |
7+
**measure_group_headers** | [**[MeasureHeaderOut]**](MeasureHeaderOut.md) | | [optional]
88
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

gooddata-afm-client/docs/RestApiIdentifier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RestApiIdentifier
22

3-
Identifier of primary label of attribute owning requested label, or null if the primary label is excluded.
3+
Object identifier.
44

55
## Properties
66
Name | Type | Description | Notes
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ResultCacheMetadata
2+
3+
All execution result's metadata used for calculation including ExecutionResponse
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**afm** | [**AFM**](AFM.md) | |
9+
**execution_response** | [**ExecutionResponse**](ExecutionResponse.md) | |
10+
**result_spec** | [**ResultSpec**](ResultSpec.md) | |
11+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

gooddata-afm-client/docs/ResultDimension.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**headers** | [**[ResultDimensionHeadersInner]**](ResultDimensionHeadersInner.md) | |
7+
**headers** | [**[ResultDimensionHeader]**](ResultDimensionHeader.md) | |
8+
**local_identifier** | **str** | |
89
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
910

1011
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)