pyfivetran.endpoints.destination

Module Contents

Classes

Region

Destination

DestinationEndpoint

API

class pyfivetran.endpoints.destination.Region(*args, **kwds)[source]

Bases: enum.Enum

GCP_US_EAST4 = 'GCP_US_EAST4'
GCP_US_WEST1 = 'GCP_US_WEST1'
class pyfivetran.endpoints.destination.Destination[source]

Bases: pyfivetran.endpoints.base.ApiDataclass

fivetran_id: str = None
service: str = None
region: pyfivetran.endpoints.destination.Region = None
setup_status: str = None
group_id: str = None
time_zone_offset: str | int | datetime.tzinfo = None
setup_tests: Optional[List[Dict[str, Any]]] = None
config: Optional[Dict[str, Any]] = None
_is_deleted: bool = False
property as_url: str
property raw: Dict[str, Any]
delete() → pyfivetran.shed.GeneralApiResponse[source]
modify(region: Optional[str | pyfivetran.endpoints.destination.Region] = None, config: Optional[Dict[str, Any]] = None, trust_certificates: Optional[bool] = None, trust_fingerprints: Optional[bool] = None, run_setup_tests: Optional[bool] = None, time_zone_offset: Optional[str | int | datetime.tzinfo] = None) → pyfivetran.shed.GeneralApiResponse[source]

Modifies the destination.

Parameters:

  • region – The region of the destination

  • config – The configuration of the destination

  • trust_certificates – Whether to trust certificates

  • trust_fingerprints – Whether to trust fingerprints

  • run_setup_tests – Whether to run setup tests

  • time_zone_offset – The time zone offset of the destination

Returns:

GeneralApiResponse

run_setup_tests(trust_certificates: Optional[bool] = None, trust_fingerprints: Optional[bool] = None) → pyfivetran.shed.GeneralApiResponse[source]

Runs setup tests on the destination.

Parameters:

  • trust_certificates – Whether to trust certificates

  • trust_fingerprints – Whether to trust fingerprints

Returns:

GeneralApiResponse

classmethod _from_dict(endpoint, d: Dict[str, Any]) → pyfivetran.endpoints.destination.Destination[source]

Helper method for deserializing from a dict.

Parameters:

d – The dict to deserialize

Returns:

The deserialized object

class pyfivetran.endpoints.destination.DestinationEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None
get_destination(destination_id: str) → pyfivetran.endpoints.destination.Destination[source]

Get a destination object.

Parameters:

destination_id – The ID of the destination

Returns:

Destination

create_destination(group_id: str, service: str, time_zone_offset: str | int | datetime.tzinfo, config: Dict[str, Any], trust_certificates: bool = False, trust_fingerprints: bool = False, run_setup_tests: Optional[bool] = None, region: Optional[str | pyfivetran.endpoints.destination.Region] = None) → pyfivetran.endpoints.destination.Destination[source]

Creates a new destination within a specified group in your Fivetran account.

Parameters:

  • group_id – The ID of the group

  • service – The name of the service

  • time_zone_offset – The time zone offset

  • config – The config of the destination

  • trust_certificates – Whether to trust certificates

  • trust_fingerprints – Whether to trust fingerprints

  • run_setup_tests – Whether to run setup tests

  • region – The region of the destination

Returns:

Destination