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 constructorChannelStatus(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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getChannelName()
Get the channel name of the channel statusjava.time.Instant
getCreatedOn()
Get the created on timestamp in ms for the channeljava.lang.String
getDatabaseName()
Get the database name of the channel statusjava.lang.String
getLastErrorMessage()
Get the last error message for the channeljava.lang.String
getLastErrorOffsetTokenUpperBound()
Get the last error offset upper bound for the channeljava.time.Instant
getLastErrorTimestamp()
Get the last error timestamp for the channeljava.time.Instant
getLastRefreshedOn()
Get the last refreshed on timestamp for the channeljava.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.UsegetLatestCommittedOffsetToken()
instead.java.lang.String
getPipeName()
Get the pipe name of the channel statuslong
getRowsErrorCount()
Get the rows error count for the channellong
getRowsInsertedCount()
Get the rows committed into the table for the channellong
getRowsParsedCount()
Get the rows parsed for the channeljava.lang.String
getSchemaName()
Get the schema name of the channel statusjava.time.Duration
getServerAvgProcessingLatency()
Get the snowflake avg processing latency for the channeljava.lang.String
getStatusCode()
Get the status code for the channel with channel name in the snowflake server side.
-
-
-
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 statusschemaName
- the schema name of the channel statuspipeName
- the pipe name of the channel statuschannelName
- the channel name of the channel statusstatusCode
- the status code for the channel with channel name in the snowflake serverlatestCommittedOffsetToken
- the last committed offset token for the channel with channel name in the snowflake server sidecreatedOn
- the created on timestamp for the channelrowsInsertedCount
- the rows committed into the table for the channelrowsParsedCount
- the rows parsed for the channelrowsErrorCount
- the rows error count for the channellastErrorOffsetTokenUpperBound
- the last error offset upper bound for the channellastErrorMessage
- the last error message for the channellastErrorTimestamp
- the last error timestamp for the channelsnowflakeAvgProcessingLatency
- the snowflake avg processing latency for the channellastRefreshedOn
- 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.UsegetLatestCommittedOffsetToken()
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
-
-