snowflake.ingest.streaming.ChannelStatus

class ChannelStatus(channel_name: str, status_code: str, latest_committed_offset_token: str | None)

Channel status information returned to users.

Provides access to channel status information including the channel name, status code, and latest committed offset token from Snowflake server.

property channel_name: str

Get the channel name.

Returns:

The name of the channel

Return type:

str

property status_code: str

Get the status code for the channel.

Returns:

The status code from Snowflake server

Return type:

str

property latest_committed_offset_token: str | None

Get the latest committed offset token for the channel.

Returns:

The latest committed offset token, or None if no commits yet

Return type:

Optional[str]