Index (Snowpipe Streaming Java API Reference 1.8.0)

A B C D E F G H I M N O R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

appendRow(Map<String, Object>, Object) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Insert one row into the elastic channel without waiting for acknowledgement (fire-and-forget): returns as soon as the row is buffered.
appendRow(Map<String, Object>, String) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Insert one row into the channel, the row is represented using a Map which maps Column Name to Column Value for the columns in the table.
appendRows(Iterable<Map<String, Object>>, Object) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Insert a batch of rows into the elastic channel without waiting for acknowledgement (fire-and-forget): returns as soon as the rows are buffered.
appendRows(Iterable<Map<String, Object>>, String, String) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Insert a batch of rows into the channel, each row is represented using a Map which maps Column Name to Column Value for the columns in the table.
appendRowsWithWait(Iterable<Map<String, Object>>, Object) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Insert a batch of rows into the elastic channel and return a future that completes when Snowflake acknowledges the batch (or completes exceptionally if the append fails).
appendRowWithWait(Map<String, Object>, Object) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Insert one row into the elastic channel and return a future that completes when Snowflake acknowledges the row (or completes exceptionally if the append fails).

B

BAD_REQUEST - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus
build() - Method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory.Builder: Builds a SnowflakeStreamingIngestClient with the provided parameters
builder(String, String, String, String) - Static method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory: Creates a new builder for a SnowflakeStreamingIngestClient for a specific account, database, schema, pipe with the provided name

C

ChannelStatus - Class in com.snowflake.ingest.streaming: ChannelStatus the channel status returned to the customer.
ChannelStatus() - Constructor for class com.snowflake.ingest.streaming.ChannelStatus: ChannelStatus default constructor
ChannelStatus(String, String, String, String, String, String, Instant, long, long, long, String, String, Instant, Duration, Instant) - Constructor for class com.snowflake.ingest.streaming.ChannelStatus: ChannelStatus constructor
ChannelStatusBatch - Class in com.snowflake.ingest.streaming: ChannelStatusBatch the channel status for the given channel names returned to the customer.
ChannelStatusBatch() - Constructor for class com.snowflake.ingest.streaming.ChannelStatusBatch: ChannelStatusBatch default constructor
ChannelStatusBatch(Map<String, ChannelStatus>) - Constructor for class com.snowflake.ingest.streaming.ChannelStatusBatch: ChannelStatusBatch constructor
close() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Close the channel, this function will make sure all the data in this channel is flushed to the snowflake sever side
close() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Close the client, which will flush first and then release all the resources
close(boolean, Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Close the channel.
close(boolean, Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Close the client.
CLOSED_CHANNEL_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
CLOSED_CLIENT_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
CLOSED_ELASTIC_CHANNEL_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
com.snowflake.ingest.streaming - package com.snowflake.ingest.streaming
CONFLICT - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

D

dropChannel(String) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Drop the specified channel on the server using the channel name

E

ErrorCode - Enum Class in com.snowflake.ingest.streaming: Strongly-typed error codes for Java-side errors with compile-time safety.
ErrorDetail - Interface in com.snowflake.ingest.streaming: The payload handed to an elastic-channel error handler (registered via SnowflakeStreamingIngestElasticChannel.setErrorHandler(java.util.function.Consumer<com.snowflake.ingest.streaming.ErrorDetail>)) when appends fail asynchronously.

F

FATAL - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
FFIMockRouter - Class in com.snowflake.ingest.streaming: Class provides access to native method to register mock paths for e2e testing This class is intended for internal use only and will not be released as a part of the SDK
FFIMockRouter() - Constructor for class com.snowflake.ingest.streaming.FFIMockRouter
fromString(String) - Static method in enum class com.snowflake.ingest.streaming.ErrorCode: Find an ErrorCode by its string name

G

getAppendTokens() - Method in interface com.snowflake.ingest.streaming.ErrorDetail: The opaque, caller-supplied append tokens of the appends that failed with ErrorDetail.getError().
getAppendTokens() - Method in interface com.snowflake.ingest.streaming.SuccessDetail: The opaque, caller-supplied append tokens of the appends that were acknowledged.
getChannel() - Method in class com.snowflake.ingest.streaming.OpenChannelResult: Get the channel
getChannelName() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the channel name of the channel status
getChannelName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the channel name
getChannelName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the channel name (always "ELASTIC").
getChannelStatus() - Method in class com.snowflake.ingest.streaming.OpenChannelResult: Get the channel status
getChannelStatus() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the channel status for the current channel from Snowflake.
getChannelStatus() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the channel status from Snowflake.
getChannelStatus(List<String>) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Return the channel status for the given list of channels from Snowflake
getChannelStatusBatch() - Method in class com.snowflake.ingest.streaming.ChannelStatusBatch
getClientName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Get the client name
getCode() - Method in enum class com.snowflake.ingest.streaming.HttpStatus
getCreatedOn() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the created on timestamp in ms for the channel
getDatabaseName() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the database name of the channel status
getDBName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the database name
getDBName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Get the database name
getDBName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the database name.
getDetailMessage() - Method in exception class com.snowflake.ingest.streaming.SFException: Original detail string passed to the constructor, without error-code / HTTP-status decoration.
getElasticChannel() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Get the elastic channel for this client.
getError() - Method in interface com.snowflake.ingest.streaming.ErrorDetail: The error that completed the failing appends exceptionally.
getErrorCodeName() - Method in enum class com.snowflake.ingest.streaming.ErrorCode: Get the error code name (e.g., "InvalidArgument")
getErrorCodeName() - Method in exception class com.snowflake.ingest.streaming.SFException: Get the error code name
getFullyQualifiedChannelName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the fully qualified channel name
getFullyQualifiedChannelName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the fully qualified channel name.
getFullyQualifiedPipeName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the fully qualified pipe name that the channel belongs to
getFullyQualifiedPipeName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the fully qualified pipe name.
getHttpStatusCode() - Method in enum class com.snowflake.ingest.streaming.ErrorCode: Get the HTTP status code (e.g., 400)
getHttpStatusCode() - Method in exception class com.snowflake.ingest.streaming.SFException: Get the HTTP status code
getHttpStatusName() - Method in enum class com.snowflake.ingest.streaming.ErrorCode: Get the HTTP status name (e.g., "Bad Request")
getHttpStatusName() - Method in exception class com.snowflake.ingest.streaming.SFException: Get the HTTP status code name
getLastErrorMessage() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the last error message for the channel
getLastErrorOffsetTokenUpperBound() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the last error offset upper bound for the channel
getLastErrorTimestamp() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the last error timestamp for the channel
getLastRefreshedOn() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the last refreshed on timestamp for the channel
getLatestCommittedOffsetToken() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the latest committed offset token for the channel with channel name in the snowflake server side.
getLatestCommittedOffsetToken() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the latest committed offset token for the current channel in Snowflake.
getLatestCommittedOffsetTokens(List<String>) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Return the latest committed/persisted offset token for the given list of channels in Snowflake
getLatestOffsetToken() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Deprecated.
Use ChannelStatus.getLatestCommittedOffsetToken() instead.
getMessage() - Method in exception class com.snowflake.ingest.streaming.SFException: Log-friendly message that includes error code and HTTP status.
getName() - Method in enum class com.snowflake.ingest.streaming.HttpStatus
getPipeName() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the pipe name of the channel status
getPipeName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the pipe name
getPipeName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Get the pipe name
getPipeName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the pipe name.
getRequestId() - Method in interface com.snowflake.ingest.streaming.ErrorDetail: The Snowflake requestId of the request whose failure is being reported, or null if this failure did not originate from a single identifiable request — e.g.
getRequestId() - Method in interface com.snowflake.ingest.streaming.SuccessDetail: The Snowflake requestId of the acknowledged request.
getRetryCount() - Method in interface com.snowflake.ingest.streaming.ErrorDetail: How many retries the failing request had already made: 0 when the first attempt failed, N when the SDK retried N times before giving up.
getRetryCount() - Method in interface com.snowflake.ingest.streaming.SuccessDetail: How many retries the acknowledged request took: 0 when the first attempt was acknowledged, N when the SDK retried N times before Snowflake accepted it.
getRowsErrorCount() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the rows error count for the channel
getRowsInsertedCount() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the rows committed into the table for the channel
getRowsParsedCount() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the rows parsed for the channel
getSchemaName() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the schema name of the channel status
getSchemaName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Get the schema name
getSchemaName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Get the schema name
getSchemaName() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Get the schema name.
getServerAvgProcessingLatency() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the snowflake avg processing latency for the channel
getStatusCode() - Method in class com.snowflake.ingest.streaming.ChannelStatus: Get the status code for the channel with channel name in the snowflake server side.
GONE - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

H

HttpStatus - Enum Class in com.snowflake.ingest.streaming: HTTP status codes used by Java layer with their canonical names.

I

initiateFlush() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Initiates a flush of all buffered data maintained for this Channel but does not wait for the flush to complete.
initiateFlush() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Initiates a flush by the Client which causes all outstanding buffered data to be flushed to Snowflake.
initiateFlush() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Initiates a flush of all buffered data in this channel without waiting for completion.
INTERNAL_SERVER_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus
INVALID_ARGUMENT - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
INVALID_CHANNEL_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
isClosed() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Check if the channel is closed
isClosed() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Check if the client is closed
isClosed() - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Check if the elastic channel is closed (because the client was closed).

M

main(String[]) - Static method in class com.snowflake.ingest.streaming.StreamingIngestExample

N

NOT_FOUND - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

O

openChannel(String) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Open a channel with a given channel name.
openChannel(String, String) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Open a channel with a given channel name.
OpenChannelResult - Class in com.snowflake.ingest.streaming: Result of opening a channel which contains the channel and its status
OpenChannelResult(SnowflakeStreamingIngestChannel, ChannelStatus) - Constructor for class com.snowflake.ingest.streaming.OpenChannelResult: OpenChannelResult constructor

R

registerMockRouteFFI(String, String, String, int) - Static method in class com.snowflake.ingest.streaming.FFIMockRouter
REQUEST_TIMEOUT - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

S

SERIALIZATION_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
setErrorHandler(Consumer<ErrorDetail>) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Register a handler for appends that fail asynchronously, after appendRow/appendRows has returned.
setExecutorService(ExecutorService) - Method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory.Builder: Set an optional ExecutorService for asynchronous operations.
setParameterOverrides(Map<String, Object>) - Method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory.Builder: Set the parameter overrides for the client
setProperties(Properties) - Method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory.Builder: Set the properties for the client
setSuccessHandler(Consumer<SuccessDetail>) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Register a handler for appends that are acknowledged by Snowflake, after appendRow/appendRows has returned.
SFException - Exception Class in com.snowflake.ingest.streaming: Snowflake exception in the Ingest SDK
SFException(ErrorCode, String) - Constructor for exception class com.snowflake.ingest.streaming.SFException: Construct a Snowflake exception using strongly-typed ErrorCode enum (RECOMMENDED)
SFException(ErrorCode, String, Throwable) - Constructor for exception class com.snowflake.ingest.streaming.SFException: Construct a Snowflake exception using strongly-typed ErrorCode enum (RECOMMENDED)
SFException(String, String, int, String) - Constructor for exception class com.snowflake.ingest.streaming.SFException: Constructor with explicit error details (FOR FFI USAGE) Use this when you have complete error information including HTTP status code and name.
SnowflakeStreamingIngestChannel - Interface in com.snowflake.ingest.streaming: Snowflake Streaming Ingest Channel, which is used to ingest data into Snowflake using the Snowflake Ingest SDK.
SnowflakeStreamingIngestClient - Interface in com.snowflake.ingest.streaming: A class that is the starting point for using the Streaming Ingest client APIs, a single client maps to exactly one account/database/schema/pipe in Snowflake; however, multiple clients can point to the same account/database/schema/pipe.
SnowflakeStreamingIngestClientFactory - Class in com.snowflake.ingest.streaming: Factory class used to build a SnowflakeStreamingIngestClient for a specific account/database/schema/pipe
SnowflakeStreamingIngestClientFactory() - Constructor for class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory
SnowflakeStreamingIngestClientFactory.Builder - Class in com.snowflake.ingest.streaming: Builder class to build a SnowflakeStreamingIngestClient
SnowflakeStreamingIngestElasticChannel - Interface in com.snowflake.ingest.streaming: Elastic channel for Snowflake Streaming Ingest.
StreamingIngestExample - Class in com.snowflake.ingest.streaming: Example on how to use the Snowpipe Streaming Ingest client APIs.
StreamingIngestExample() - Constructor for class com.snowflake.ingest.streaming.StreamingIngestExample
SuccessDetail - Interface in com.snowflake.ingest.streaming: The payload handed to an elastic-channel success handler (registered via SnowflakeStreamingIngestElasticChannel.setSuccessHandler(java.util.function.Consumer<com.snowflake.ingest.streaming.SuccessDetail>)) when appends are acknowledged by Snowflake.

T

tableBuilder(String, String, String, String) - Static method in class com.snowflake.ingest.streaming.SnowflakeStreamingIngestClientFactory: Creates a new builder for a table-mode SnowflakeStreamingIngestClient.
TOKEN_CHECKER_ERROR - Enum constant in enum class com.snowflake.ingest.streaming.ErrorCode
TOO_MANY_REQUESTS - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

U

UNAUTHORIZED - Enum constant in enum class com.snowflake.ingest.streaming.HttpStatus

V

valueOf(String) - Static method in enum class com.snowflake.ingest.streaming.ErrorCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.snowflake.ingest.streaming.HttpStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.snowflake.ingest.streaming.ErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.snowflake.ingest.streaming.HttpStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

waitForCommit(Predicate<String>, Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Asynchronously waits for offset token to be committed in the snowflake sever side by checking whether the latest committed offset token meets the commit condition provided by the tokenChecker.
waitForFlush(Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestChannel: Asynchronously waits for all buffered data in this channel to be flushed to the Snowflake server side.
waitForFlush(Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestClient: Asynchronously waits for all buffered data in all channels managed by this client to be flushed to the Snowflake server side.
waitForFlush(Duration) - Method in interface com.snowflake.ingest.streaming.SnowflakeStreamingIngestElasticChannel: Asynchronously waits for all buffered data in this channel to be flushed to the Snowflake server side.

A B C D E F G H I M N O R S T U V W
All Classes and Interfaces|All Packages|Serialized Form