Skip to content

Latest commit

 

History

History
708 lines (484 loc) · 19.2 KB

DataSourceApi.md

File metadata and controls

708 lines (484 loc) · 19.2 KB
Raw

thirdeye_client.DataSourceApi

All URIs are relative to https://localhost

Method HTTP request Description
clear_data_source_cache DELETE /api/data-sources/cache
count_with_predicate GET /api/data-sources/count
create_multiple POST /api/data-sources
delete DELETE /api/data-sources/{id}
delete_all DELETE /api/data-sources/all
edit_multiple PUT /api/data-sources
get1 GET /api/data-sources/{id}
get2 GET /api/data-sources/name/{name}
get_all GET /api/data-sources
get_datasets GET /api/data-sources/name/{name}/datasets
offboard_all DELETE /api/data-sources/offboard-all
onboard_all POST /api/data-sources/onboard-all
onboard_dataset POST /api/data-sources/onboard-dataset
validate GET /api/data-sources/validate

clear_data_source_cache

clear_data_source_cache()

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.clear_data_source_cache()
except ApiException as e:
    print("Exception when calling DataSourceApi->clear_data_source_cache: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

count_with_predicate

count_with_predicate()

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.count_with_predicate()
except ApiException as e:
    print("Exception when calling DataSourceApi->count_with_predicate: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_multiple

create_multiple(body=body)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.DataSourceApiModel()] # list[DataSourceApiModel] |  (optional)

try:
    api_instance.create_multiple(body=body)
except ApiException as e:
    print("Exception when calling DataSourceApi->create_multiple: %s\n" % e)

Parameters

Name Type Description Notes
body list[DataSourceApiModel] [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(id)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.delete(id)
except ApiException as e:
    print("Exception when calling DataSourceApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_all

delete_all()

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.delete_all()
except ApiException as e:
    print("Exception when calling DataSourceApi->delete_all: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_multiple

edit_multiple(body=body)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.DataSourceApiModel()] # list[DataSourceApiModel] |  (optional)

try:
    api_instance.edit_multiple(body=body)
except ApiException as e:
    print("Exception when calling DataSourceApi->edit_multiple: %s\n" % e)

Parameters

Name Type Description Notes
body list[DataSourceApiModel] [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get1

get1(id)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.get1(id)
except ApiException as e:
    print("Exception when calling DataSourceApi->get1: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get2

get2(name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str | 

try:
    api_instance.get2(name)
except ApiException as e:
    print("Exception when calling DataSourceApi->get2: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all

get_all()

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.get_all()
except ApiException as e:
    print("Exception when calling DataSourceApi->get_all: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_datasets

get_datasets(name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str | 

try:
    api_instance.get_datasets(name)
except ApiException as e:
    print("Exception when calling DataSourceApi->get_datasets: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

offboard_all

offboard_all(name=name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str |  (optional)

try:
    api_instance.offboard_all(name=name)
except ApiException as e:
    print("Exception when calling DataSourceApi->offboard_all: %s\n" % e)

Parameters

Name Type Description Notes
name str [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

onboard_all

onboard_all(name=name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str |  (optional)

try:
    api_instance.onboard_all(name=name)
except ApiException as e:
    print("Exception when calling DataSourceApi->onboard_all: %s\n" % e)

Parameters

Name Type Description Notes
name str [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

onboard_dataset

onboard_dataset(data_source_name=data_source_name, dataset_name=dataset_name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
data_source_name = 'data_source_name_example' # str |  (optional)
dataset_name = 'dataset_name_example' # str |  (optional)

try:
    api_instance.onboard_dataset(data_source_name=data_source_name, dataset_name=dataset_name)
except ApiException as e:
    print("Exception when calling DataSourceApi->onboard_dataset: %s\n" % e)

Parameters

Name Type Description Notes
data_source_name str [optional]
dataset_name str [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate

validate(name=name)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.DataSourceApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str |  (optional)

try:
    api_instance.validate(name=name)
except ApiException as e:
    print("Exception when calling DataSourceApi->validate: %s\n" % e)

Parameters

Name Type Description Notes
name str [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]