Reflex

Warning

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

reflex_create

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

Create a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the reflex in.	required
display_name	str	The display name of the reflex.	required
reflex_path	str	The path to the reflex to load content from.	required
description	str | None	The description of the reflex.	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.

reflex_get

reflex_get(workspace_id: str, reflex_id: str, preview: bool = True) -> requests.Response

Get a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the reflex from.	required
reflex_id	str	The id of the reflex 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.

reflex_list

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

List reflexes for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list reflexes 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.

reflex_update

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

Update a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
reflex_id	str	The id of the reflex to update.	required
display_name	str | None	The display name of the reflex.	None
description	str | None	The description of the reflex.	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.

reflex_delete

reflex_delete(workspace_id: str, reflex_id: str, preview: bool = True) -> requests.Response

Delete a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete.	required
reflex_id	str	The id of the reflex 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.

reflex_get_definition

reflex_get_definition(workspace_id: str, reflex_id: str, format: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Get the definition of a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the reflex definition from.	required
reflex_id	str	The id of the reflex to get the definition from.	required
format	str | None	The format of the reflex definition. Supported format is "ipynb".	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.

reflex_update_definition

reflex_update_definition(workspace_id: str, reflex_id: str, reflex_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of a reflex.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
reflex_id	str	The id of the reflex to update.	required
reflex_path	str	The path to the reflex to load content from.	required
update_metadata	bool | None	When set to true, the item's metadata is updated using the metadata in the .platform file.	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.