# Hightouch Tasks


This module contains a collection of tasks to interact with Hightouch.

# HightouchRunSync

class

prefect.tasks.hightouch.hightouch_tasks.HightouchRunSync

(api_key=None, api_key_env_var=None, sync_id=None, wait_for_completion=False, wait_time_between_api_calls=10, max_wait_time=None, **kwargs)[source]

This task can be used to trigger a new sync run on Hightouch. Under the hood it uses Hightouch official APIs.

Args:

  • api_key (str, optional): The API key to use to authenticate on Hightouch.
  • api_key_env_var (str, optional): The name of the environment variable that contains the API key to use to authenticate on Hightouch. This value is considered only if api_key is not provided.
  • sync_id (int, optional): The ID of the Hightouch sync to run.
  • wait_for_completion (bool, optional): Whether to wait for sync run completion or not. Default is False.
  • wait_for_completion: (int, optional): Whether to wait for the sync run to finish execution or not. Default is False.
  • wait_time_between_api_calls (int, optional): The number of seconds to wait between API calls. Default is 10.
  • max_wait_time (int, optional): The maximum number of seconds to wait for the Hightouch API to return a response. If wait_for_completion is True and maximum_wait_time is not set then the task will run until completed or cancelled.
  • **kwargs (optional): Additional keyword arguments to pass to the standard Task initalization.

methods:                                                                                                                                                       

prefect.tasks.hightouch.hightouch_tasks.HightouchRunSync.run

(api_key=None, api_key_env_var=None, sync_id=None, wait_for_completion=False, wait_time_between_api_calls=10, max_wait_time=None)[source]

This task can be used to trigger a new sync run on Hightouch. Under the hood it uses Hightouch official APIs.

Args:

  • api_key (str, optional): The API key to use to authenticate on Hightouch.
  • api_key_env_var (str, optional): The name of the environment variable that contains the API key to use to authenticate on Hightouch. This value is considered only if api_key is not provided.
  • sync_id (int, optional): The ID of the Hightouch sync to run.
  • wait_for_completion: (int, optional): Whether to wait for the sync run to finish execution or not. Default is False.
  • wait_time_between_api_calls (int, optional): The number of seconds to wait between API calls. Default is 10.
  • max_wait_time (int, optional): The maximum number of seconds to wait for the If wait_for_completion is True and maximum_wait_time is not set then the task will run until completed or cancelled. Hightouch API to return a response.
Raises:
  • ValueError if both api_key and api_key_env_var are missing. - ValueError if api_key is missing and api_key_env_var is not found. - ValueError if sync_id is missing.


Returns:



    This documentation was auto-generated from commit e6bd04a
    on September 7, 2022 at 21:06 UTC