pyfivetran.endpoints.group

Module Contents

Classes

Group

GroupEndpoint

API

class pyfivetran.endpoints.group.Group[source]

Bases: pyfivetran.endpoints.base.ApiDataclass

fivetran_id: str = None
name: str = None
created_at: datetime.datetime = None
_is_deleted: bool = False
property as_url: str
property raw: Dict[str, Any]
property public_key: str

Public key from SSH key pair.

property service_account: str

Fivetran service account associated with the group.

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

Helper method for deserializing from a dict

Parameters:

d – The dict to deserialize

Returns:

The deserialized object

delete() → pyfivetran.shed.GeneralApiResponse[source]

Deletes a group in your Fivetran account.

Returns:

GeneralApiResponse

modify(name: str) → pyfivetran.shed.GeneralApiResponse[source]

Modifies a group in your Fivetran account.

Parameters:

name – The name of the group

Returns:

GeneralApiResponse

add_user(email: Optional[str] = None, role: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Adds an existing user to a group in your Fivetran account.

Parameters:

  • email – The email of the user to add

  • role – The role of the user to add

Returns:

GeneralApiResponse

list_connectors(schema: Optional[str] = None, limit: Optional[int] = None) → List[pyfivetran.shed.PaginatedApiResponse][source]

Returns a list of connectors in a group in your Fivetran account.

Parameters:

  • schema – The schema of the connector

  • limit – The number of records to return

Returns:

List[PaginatedApiResponse]

list_users(limit: Optional[int] = None) → List[pyfivetran.shed.PaginatedApiResponse][source]

Returns a list of users in a group in your Fivetran account.

Parameters:

limit – The number of records to return

Returns:

List[PaginatedApiResponse]

remove_user(user_id: str) → pyfivetran.shed.GeneralApiResponse[source]

Removes a user from a group in your Fivetran account.

Parameters:

user_id – The ID of the user to remove

Returns:

GeneralApiResponse

class pyfivetran.endpoints.group.GroupEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None
create_group(name: str) → pyfivetran.endpoints.group.Group[source]

Creates a new group in your fivetran account.

Parameters:

name – The name of the group

Returns:

Group

list_groups(limit: Optional[int] = None) → List[pyfivetran.endpoints.group.Group][source]

Returns a list of groups in your Fivetran account.

Parameters:

limit – The number of records to return

Returns:

List[PaginatedApiResponse]

get_group(group_id: str) → pyfivetran.endpoints.group.Group[source]

Gets a group in your Fivetran account.

Parameters:

group_id – The ID of the group

Returns:

Group