Data Pipeline

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

data_pipeline_create

data_pipeline_create(workspace_id: str, display_name: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a data pipeline.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the data pipeline in.	required
display_name	str	The display name of the data pipeline.	required
description	str | None	The description of the data pipeline.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

data_pipeline_get

data_pipeline_get(workspace_id: str, data_pipeline_id: str, preview: bool = True) -> requests.Response

Get a data pipeline.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the data pipeline from.	required
data_pipeline_id	str	The id of the data pipeline to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

data_pipeline_list

data_pipeline_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List data pipelines for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list data pipelines for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

data_pipeline_update

data_pipeline_update(workspace_id: str, data_pipeline_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a data pipeline.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update the data pipeline in.	required
data_pipeline_id	str	The id of the data pipeline to update.	required
display_name	str | None	The display name of the data pipeline.	None
description	str | None	The description of the data pipeline.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

data_pipeline_delete

data_pipeline_delete(workspace_id: str, data_pipeline_id: str, preview: bool = True) -> requests.Response

Delete a data pipeline.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete the data pipeline from.	required
data_pipeline_id	str	The id of the data pipeline to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.