Package net.snowflake.ingest.streaming
Interface SnowflakeStreamingIngestClient
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
SnowflakeStreamingIngestClientInternal
public interface SnowflakeStreamingIngestClient extends AutoCloseable
A class that is the starting point for using the Streaming Ingest client APIs, a single client maps to exactly one account in Snowflake; however, multiple clients can point to the same account. Each client will contain information for Snowflake authentication and authorization, and it will be used to create one or moreSnowflakeStreamingIngestChannelThread safety note: Implementations of this interface are required to be thread safe.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetName()Get the client namebooleanisClosed()Check whether the client is closed or not, if you want to make sure all data are committed before closing, please callAutoCloseable.close()before closing the entire clientSnowflakeStreamingIngestChannelopenChannel(OpenChannelRequest request)Open a channel against a Snowflake table using aOpenChannelRequest-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
openChannel
SnowflakeStreamingIngestChannel openChannel(OpenChannelRequest request)
Open a channel against a Snowflake table using aOpenChannelRequest- Parameters:
request- the open channel request- Returns:
- a
SnowflakeStreamingIngestChannelobject
-
getName
String getName()
Get the client name- Returns:
- the client name
-
isClosed
boolean isClosed()
Check whether the client is closed or not, if you want to make sure all data are committed before closing, please callAutoCloseable.close()before closing the entire client- Returns:
- a boolean to indicate whether the client is closed
-
-