Eventstream

Warning

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

eventstream_create

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

Create an eventstream.

Parameters:

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

eventstream_get

eventstream_get(workspace_id: str, eventstream_id: str, preview: bool = True) -> requests.Response

Get an eventstream.

Parameters:

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

eventstream_list

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

List eventstreams for a workspace.

Parameters:

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

eventstream_update

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

Update an eventstream.

Parameters:

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

eventstream_delete

eventstream_delete(workspace_id: str, eventstream_id: str, preview: bool = True) -> requests.Response

Delete an eventstream.

Parameters:

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

eventstream_get_definition

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

Get the definition of an eventstream.

Parameters:

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

eventstream_update_definition

eventstream_update_definition(workspace_id: str, eventstream_id: str, eventstream_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of an eventstream.

Parameters:

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