Eventhouse

Warning

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

eventhouse_create

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

Create an eventhouse.

Parameters:

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

eventhouse_get

eventhouse_get(workspace_id: str, eventhouse_id: str, preview: bool = True) -> requests.Response

Get an eventhouse.

Parameters:

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

eventhouse_list

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

List eventhouses for a workspace.

Parameters:

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

eventhouse_update

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

Update an eventhouse.

Parameters:

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

eventhouse_delete

eventhouse_delete(workspace_id: str, eventhouse_id: str, preview: bool = True) -> requests.Response

Delete an eventhouse.

Parameters:

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

eventhouse_get_definition

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

Get the definition of an eventhouse.

Parameters:

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

eventhouse_update_definition

eventhouse_update_definition(workspace_id: str, eventhouse_id: str, eventhouse_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of an eventhouse.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
eventhouse_id	str	The id of the eventhouse to update.	required
eventhouse_path	str	The path to the eventhouse 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.