Package com.snowflake.ingest.streaming

Class ChannelStatus

java.lang.Object

com.snowflake.ingest.streaming.ChannelStatus

public class ChannelStatus
extends java.lang.Object

ChannelStatus the channel status returned to the customer.

Constructor Summary

Constructors

Constructor	Description
ChannelStatus()	ChannelStatus default constructor
ChannelStatus(java.lang.String databaseName, java.lang.String schemaName, java.lang.String pipeName, java.lang.String channelName, java.lang.String statusCode, java.lang.String latestCommittedOffsetToken, java.time.Instant createdOn, long rowsInsertedCount, long rowsParsedCount, long rowsErrorCount, java.lang.String lastErrorOffsetTokenUpperBound, java.lang.String lastErrorMessage, java.time.Instant lastErrorTimestamp, java.time.Duration snowflakeAvgProcessingLatency, java.time.Instant lastRefreshedOn)	ChannelStatus constructor

Method Summary

Modifier and Type	Method	Description
java.lang.String	getChannelName()	Get the channel name of the channel status
java.time.Instant	getCreatedOn()	Get the created on timestamp in ms for the channel
java.lang.String	getDatabaseName()	Get the database name of the channel status
java.lang.String	getLastErrorMessage()	Get the last error message for the channel
java.lang.String	getLastErrorOffsetTokenUpperBound()	Get the last error offset upper bound for the channel
java.time.Instant	getLastErrorTimestamp()	Get the last error timestamp for the channel
java.time.Instant	getLastRefreshedOn()	Get the last refreshed on timestamp for the channel
java.lang.String	getLatestCommittedOffsetToken()	Get the latest committed offset token for the channel with channel name in the snowflake server side.
java.lang.String	getLatestOffsetToken()	Deprecated. Use getLatestCommittedOffsetToken() instead.
java.lang.String	getPipeName()	Get the pipe name of the channel status
long	getRowsErrorCount()	Get the rows error count for the channel
long	getRowsInsertedCount()	Get the rows committed into the table for the channel
long	getRowsParsedCount()	Get the rows parsed for the channel
java.lang.String	getSchemaName()	Get the schema name of the channel status
java.time.Duration	getServerAvgProcessingLatency()	Get the snowflake avg processing latency for the channel
java.lang.String	getStatusCode()	Get the status code for the channel with channel name in the snowflake server side.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelStatus

public ChannelStatus()

ChannelStatus default constructor

ChannelStatus

public ChannelStatus(java.lang.String databaseName,
                     java.lang.String schemaName,
                     java.lang.String pipeName,
                     java.lang.String channelName,
                     java.lang.String statusCode,
                     @Nullable
                     java.lang.String latestCommittedOffsetToken,
                     java.time.Instant createdOn,
                     long rowsInsertedCount,
                     long rowsParsedCount,
                     long rowsErrorCount,
                     @Nullable
                     java.lang.String lastErrorOffsetTokenUpperBound,
                     @Nullable
                     java.lang.String lastErrorMessage,
                     @Nullable
                     java.time.Instant lastErrorTimestamp,
                     @Nullable
                     java.time.Duration snowflakeAvgProcessingLatency,
                     java.time.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 Detail

getDatabaseName

public java.lang.String getDatabaseName()

Get the database name of the channel status

Returns:

the database name of the channel status

getSchemaName

public java.lang.String getSchemaName()

Get the schema name of the channel status

Returns:

the schema name of the channel status

getPipeName

public java.lang.String getPipeName()

Get the pipe name of the channel status

Returns:

the pipe name of the channel status

getChannelName

public java.lang.String getChannelName()

Get the channel name of the channel status

Returns:

the channel name of the channel status

getStatusCode

public java.lang.String getStatusCode()

Get the status code for the channel with channel name in the snowflake server side.

Returns:

the status code

getLatestCommittedOffsetToken

public java.lang.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 java.lang.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 java.time.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 java.lang.String getLastErrorOffsetTokenUpperBound()

Get the last error offset upper bound for the channel

Returns:

the last error offset upper bound for the channel

getLastErrorMessage

public java.lang.String getLastErrorMessage()

Get the last error message for the channel

Returns:

the last error message for the channel

getLastErrorTimestamp

public java.time.Instant getLastErrorTimestamp()

Get the last error timestamp for the channel

Returns:

the last error timestamp for the channel

getServerAvgProcessingLatency

public java.time.Duration getServerAvgProcessingLatency()

Get the snowflake avg processing latency for the channel

Returns:

the snowflake avg processing latency for the channel

getLastRefreshedOn

public java.time.Instant getLastRefreshedOn()

Get the last refreshed on timestamp for the channel

Returns:

the last refreshed on timestamp for the channel