Skip to content

Latest commit

 

History

History
639 lines (436 loc) · 17.3 KB

ZzzInternalZzzApi.md

File metadata and controls

639 lines (436 loc) · 17.3 KB

thirdeye_client.ZzzInternalZzzApi

All URIs are relative to https://localhost

Method HTTP request Description
create_all_tables POST /internal/db-admin/create-all-tables
delete_all_data DELETE /internal/db-admin/truncate-all-tables
delete_all_tables DELETE /internal/db-admin/drop-all-tables
execute_query GET /internal/db-admin/execute-query
generate_html_email GET /internal/email/html
get_package_info GET /internal/package-info
get_tables GET /internal/db-admin/tables
notify POST /internal/notify
ping GET /internal/ping
post POST /internal/http-detector
trigger_webhook POST /internal/trigger/webhook
webhook_dummy POST /internal/webhook
worker_id GET /internal/worker/id

create_all_tables

create_all_tables()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.create_all_tables()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->create_all_tables: %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]

delete_all_data

delete_all_data()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.delete_all_data()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->delete_all_data: %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]

delete_all_tables

delete_all_tables()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.delete_all_tables()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->delete_all_tables: %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]

execute_query

execute_query(sql=sql)

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))
sql = 'sql_example' # str |  (optional)

try:
    api_instance.execute_query(sql=sql)
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->execute_query: %s\n" % e)

Parameters

Name Type Description Notes
sql 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]

generate_html_email

generate_html_email(subscription_group_id=subscription_group_id, reset=reset)

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))
subscription_group_id = 789 # int |  (optional)
reset = true # bool |  (optional)

try:
    api_instance.generate_html_email(subscription_group_id=subscription_group_id, reset=reset)
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->generate_html_email: %s\n" % e)

Parameters

Name Type Description Notes
subscription_group_id int [optional]
reset bool [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html, application/json

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

get_package_info

get_package_info()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.get_package_info()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->get_package_info: %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_tables

get_tables()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.get_tables()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->get_tables: %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]

notify

notify(subscription_group_id=subscription_group_id, reset=reset)

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))
subscription_group_id = 789 # int |  (optional)
reset = true # bool |  (optional)

try:
    api_instance.notify(subscription_group_id=subscription_group_id, reset=reset)
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->notify: %s\n" % e)

Parameters

Name Type Description Notes
subscription_group_id int [optional]
reset bool [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]

ping

ping()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.ping()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->ping: %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]

post

post(body=body)

Example

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

# create an instance of the API class
api_instance = thirdeye_client.ZzzInternalZzzApi()
body = NULL # object |  (optional)

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

Parameters

Name Type Description Notes
body object [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

trigger_webhook

trigger_webhook()

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.trigger_webhook()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->trigger_webhook: %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]

webhook_dummy

webhook_dummy(body=body, x_signature=x_signature)

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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))
body = NULL # object |  (optional)
x_signature = 'x_signature_example' # str |  (optional)

try:
    api_instance.webhook_dummy(body=body, x_signature=x_signature)
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->webhook_dummy: %s\n" % e)

Parameters

Name Type Description Notes
body object [optional]
x_signature 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]

worker_id

worker_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.ZzzInternalZzzApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.worker_id()
except ApiException as e:
    print("Exception when calling ZzzInternalZzzApi->worker_id: %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]