Package com.snowflake.ingest.streaming

Class ChannelStatus

java.lang.Object
com.snowflake.ingest.streaming.ChannelStatus
public class ChannelStatus extends Object
ChannelStatus the channel status returned to the customer.

  • Constructor Details

    • ChannelStatus

      public ChannelStatus()
      ChannelStatus default constructor

    • ChannelStatus

      public ChannelStatus(String databaseName, String schemaName, String pipeName, String channelName, String statusCode, @Nullable String latestCommittedOffsetToken, Instant createdOn, long rowsInsertedCount, long rowsParsedCount, long rowsErrorCount, @Nullable String lastErrorOffsetTokenUpperBound, @Nullable String lastErrorMessage, @Nullable Instant lastErrorTimestamp, @Nullable Duration snowflakeAvgProcessingLatency, Instant lastRefreshedOn)
      ChannelStatus constructor
      Parameters:
      databaseName - the database name of the channel status
      schemaName - the schema name of the channel status
      pipeName - the pipe name of the channel status
      channelName - the channel name of the channel status
      statusCode - the status code for the channel with channel name in the snowflake server
      latestCommittedOffsetToken - the last committed offset token for the channel with channel name in the snowflake server side
      createdOn - the created on timestamp for the channel
      rowsInsertedCount - the rows committed into the table for the channel
      rowsParsedCount - the rows parsed for the channel
      rowsErrorCount - the rows error count for the channel
      lastErrorOffsetTokenUpperBound - the last error offset upper bound for the channel
      lastErrorMessage - the last error message for the channel
      lastErrorTimestamp - the last error timestamp for the channel
      snowflakeAvgProcessingLatency - the snowflake avg processing latency for the channel
      lastRefreshedOn - the last refreshed on timestamp for the channel

  • Method Details

    • getDatabaseName

      public String getDatabaseName()
      Get the database name of the channel status
      Returns:
      the database name of the channel status

    • getSchemaName

      public String getSchemaName()
      Get the schema name of the channel status
      Returns:
      the schema name of the channel status

    • getPipeName

      public String getPipeName()
      Get the pipe name of the channel status
      Returns:
      the pipe name of the channel status

    • getChannelName

      public String getChannelName()
      Get the channel name of the channel status
      Returns:
      the channel name of the channel status

    • getStatusCode

      public String getStatusCode()
      Get the status code for the channel with channel name in the snowflake server side.
      Returns:
      the status code

    • getLatestCommittedOffsetToken

      public String getLatestCommittedOffsetToken()
      Get the latest committed offset token for the channel with channel name in the snowflake server side.
      Returns:
      the latest committed offset token

    • getLatestOffsetToken

      @Deprecated public String getLatestOffsetToken()
      Deprecated.
      Use getLatestCommittedOffsetToken() instead.
      Get the latest committed offset token for the channel with channel name in the snowflake server side.
      Returns:
      the latest committed offset token

    • getCreatedOn

      public Instant getCreatedOn()
      Get the created on timestamp in ms for the channel
      Returns:
      the created on timestamp for the channel

    • getRowsInsertedCount

      public long getRowsInsertedCount()
      Get the rows committed into the table for the channel
      Returns:
      the rows committed into the table for the channel

    • getRowsParsedCount

      public long getRowsParsedCount()
      Get the rows parsed for the channel
      Returns:
      the rows parsed for the channel

    • getRowsErrorCount

      public long getRowsErrorCount()
      Get the rows error count for the channel
      Returns:
      the rows error count for the channel

    • getLastErrorOffsetTokenUpperBound

      public String getLastErrorOffsetTokenUpperBound()
      Get the last error offset upper bound for the channel
      Returns:
      the last error offset upper bound for the channel

    • getLastErrorMessage

      public String getLastErrorMessage()
      Get the last error message for the channel
      Returns:
      the last error message for the channel

    • getLastErrorTimestamp

      public Instant getLastErrorTimestamp()
      Get the last error timestamp for the channel
      Returns:
      the last error timestamp for the channel

    • getServerAvgProcessingLatency

      public Duration getServerAvgProcessingLatency()
      Get the snowflake avg processing latency for the channel
      Returns:
      the snowflake avg processing latency for the channel

    • getLastRefreshedOn

      public Instant getLastRefreshedOn()
      Get the last refreshed on timestamp for the channel
      Returns:
      the last refreshed on timestamp for the channel