gooddata-afm-client 0.7.0

OpenAPI definition

gooddata-afm-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v0
• Package version: 0.7.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import gooddata_afm_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gooddata_afm_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import gooddata_afm_client
from pprint import pprint
from gooddata_afm_client.api import actions_api
from gooddata_afm_client.model.afm_execution import AfmExecution
from gooddata_afm_client.model.afm_execution_response import AfmExecutionResponse
from gooddata_afm_client.model.afm_valid_objects_query import AfmValidObjectsQuery
from gooddata_afm_client.model.afm_valid_objects_response import AfmValidObjectsResponse
from gooddata_afm_client.model.elements_request import ElementsRequest
from gooddata_afm_client.model.elements_response import ElementsResponse
from gooddata_afm_client.model.error_message import ErrorMessage
from gooddata_afm_client.model.execution_result import ExecutionResult
# Defining the host is optional and defaults to http://gooddata-cn-ce:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_afm_client.Configuration(
    host = "http://gooddata-cn-ce:3000"
)



# Enter a context with an instance of the API client
with gooddata_afm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = actions_api.ActionsApi(api_client)
    workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier
label = "label_example" # str | Requested label.
sort_order = "ASC" # str | Sort order of returned items. Items are sorted by ```label``` title. (optional) (default to "ASC")
complement_filter = False # bool | Inverse filter: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter``` (optional) (default to False)
pattern_filter = "patternFilter_example" # str | Return only items, whose ```label``` title case insensitively contains ```filter``` as substring. (optional)
exact_filter = [
        "exactFilter_example",
    ] # [str] | Return only items, whose ```label``` title exactly matches one of ```filter```. (optional)
offset = 0 # int | Request page with this offset. (optional) (default to 0)
limit = 1000 # int | Return only this number of items. (optional) (default to 1000)
data_sampling_percentage = 0 # float | Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views. (optional)
skip_cache = True # bool | Ignore all caches during execution of current request. (optional)

    try:
        # Listing of label values.
        api_response = api_instance.compute_label_elements(workspace_id, label, sort_order=sort_order, complement_filter=complement_filter, pattern_filter=pattern_filter, exact_filter=exact_filter, offset=offset, limit=limit, data_sampling_percentage=data_sampling_percentage, skip_cache=skip_cache)
        pprint(api_response)
    except gooddata_afm_client.ApiException as e:
        print("Exception when calling ActionsApi->compute_label_elements: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://gooddata-cn-ce:3000

Class	Method	HTTP request	Description
ActionsApi	compute_label_elements	GET /api/actions/workspaces/{workspaceId}/execution/collectLabelElements	Listing of label values.
ActionsApi	compute_label_elements_post	POST /api/actions/workspaces/{workspaceId}/execution/collectLabelElements	Listing of label values.
ActionsApi	compute_report	POST /api/actions/workspaces/{workspaceId}/execution/afm/execute	Executes analytical request and returns link to the result
ActionsApi	compute_valid_objects	POST /api/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects	Valid objects
ActionsApi	explain_afm	POST /api/actions/workspaces/{workspaceId}/execution/afm/explain	AFM explain resource.
ActionsApi	retrieve_result	GET /api/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}	Get a single execution result

Documentation For Models

• AFM
• AbsoluteDateFilter
• AbsoluteDateFilterBody
• AbsoluteDateFilterBodyAllOf
• AbstractMeasureValueFilter
• AbstractMeasureValueFilterAllOf
• AfmExecution
• AfmExecutionResponse
• AfmObjectIdentifier
• AfmValidObjectsQuery
• AfmValidObjectsResponse
• ArithmeticMeasureDefinition
• ArithmeticMeasureDefinitionArithmeticMeasure
• AttributeExecutionResultHeader
• AttributeFilter
• AttributeFilterElements
• AttributeHeader
• AttributeHeaderAttributeHeader
• AttributeItem
• AttributeResultHeader
• CommonAttributeFilter
• CommonAttributeFilterAllOf
• CommonDateFilter
• CommonDateFilterAllOf
• CommonFilter
• CommonMeasureValueFilter
• CommonMeasureValueFilterAllOf
• ComparisonMeasureValueFilter
• ComparisonMeasureValueFilterBody
• ComparisonMeasureValueFilterBodyAllOf
• DataColumnLocator
• DateFilter
• Dimension
• DimensionHeader
• Element
• ElementsRequest
• ElementsResponse
• ErrorMessage
• ExecutionLinks
• ExecutionResponse
• ExecutionResult
• ExecutionResultGrandTotal
• ExecutionResultHeader
• ExecutionResultPaging
• ExecutionSettings
• FilterDefinition
• FilterDefinitionForSimpleMeasure
• GrandTotal
• HeaderGroup
• Identifier
• IncludedDimensionProps
• InlineFilterDefinition
• InlineFilterDefinitionBody
• InlineFilterDefinitionBodyAllOf
• InlineMeasureDefinition
• InlineMeasureDefinitionInline
• LocalIdentifier
• MeasureDefinition
• MeasureExecutionResultHeader
• MeasureGroupHeader
• MeasureHeaderOut
• MeasureItem
• MeasureResultHeader
• MeasureValueFilter
• NegativeAttributeFilter
• NegativeAttributeFilterBody
• NegativeAttributeFilterBodyAllOf
• ObjectIdentifier
• Paging
• PopDataset
• PopDatasetMeasureDefinition
• PopDatasetMeasureDefinitionPreviousPeriodMeasure
• PopDate
• PopDateMeasureDefinition
• PopDateMeasureDefinitionOverPeriodMeasure
• PositiveAttributeFilter
• PositiveAttributeFilterBody
• PositiveAttributeFilterBodyAllOf
• RangeMeasureValueFilter
• RangeMeasureValueFilterBody
• RangeMeasureValueFilterBodyAllOf
• RankingFilter
• RankingFilterBody
• RankingFilterBodyAllOf
• RelativeDateFilter
• RelativeDateFilterBody
• RelativeDateFilterBodyAllOf
• ResultDimension
• ResultSpec
• SimpleMeasureDefinition
• SimpleMeasureDefinitionMeasure
• SortDirection
• SortKeyAttribute
• SortKeyAttributeAttribute
• SortKeyValue
• SortKeyValueValue
• TotalFunction

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in gooddata_afm_client.apis and gooddata_afm_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from gooddata_afm_client.api.default_api import DefaultApi
• from gooddata_afm_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import gooddata_afm_client
from gooddata_afm_client.apis import *
from gooddata_afm_client.models import *