net.snowflake.ingest.connection

Class ServiceResponseHandler

java.lang.Object

net.snowflake.ingest.connection.ServiceResponseHandler

public final class ServiceResponseHandler
extends Object

This class handles taking the HttpResponses we've gotten back, and producing an appropriate response object for usage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceResponseHandler.ApiName Enums for Snowpipe REST API: https://docs.snowflake.com/en/user-guide/data-load-snowpipe-rest-apis.html Used in handleExceptionalStatus for logging purpose

Constructor Summary

Constructors

Constructor and Description
ServiceResponseHandler()

Method Summary

Modifier and Type	Method and Description
static ConfigureClientResponse	unmarshallConfigureClientResponse(org.apache.http.HttpResponse response, UUID requestId) unmarshallConfigureClientResponse - Given an HttpResponse object, attempts to deserialize it into a ConfigureClientResponse
static ClientStatusResponse	unmarshallGetClientStatus(org.apache.http.HttpResponse response, UUID requestId) unmarshallGetClientStatus - Given an HttpResponse object, attempts to deserialize it into a ClientStatusResponse
static HistoryRangeResponse	unmarshallHistoryRangeResponse(org.apache.http.HttpResponse response, UUID requestId) Given an HttpResponse object - attempts to deserialize it into a HistoryRangeResponse
static HistoryResponse	unmarshallHistoryResponse(org.apache.http.HttpResponse response, UUID requestId) unmarshallHistoryResponse Given an HttpResponse object - attempts to deserialize it into a HistoryResponse object
static IngestResponse	unmarshallIngestResponse(org.apache.http.HttpResponse response, UUID requestId) unmarshallIngestResponse Given an HttpResponse object - attempts to deserialize it into an IngestResponse object
static <T> T	unmarshallStreamingIngestResponse(org.apache.http.HttpResponse response, Class<T> valueType, ServiceResponseHandler.ApiName apiName) unmarshallStreamingIngestResponse Given an HttpResponse object - attempts to deserialize it into an Object based on input type

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceResponseHandler

public ServiceResponseHandler()

Method Detail

unmarshallIngestResponse

public static IngestResponse unmarshallIngestResponse(org.apache.http.HttpResponse response,
                                                      UUID requestId)
                                               throws IOException,
                                                      IngestResponseException,
                                                      BackOffException

unmarshallIngestResponse Given an HttpResponse object - attempts to deserialize it into an IngestResponse object

Parameters:

response - the HTTPResponse we want to distill into an IngestResponse

requestId -

Returns:

An IngestResponse with all of the parsed out information

Throws:

IOException - if our entity is somehow corrupt or we can't get it

IngestResponseException - - if we have an uncategorized network issue

BackOffException - - if we have a 503 issue

unmarshallHistoryResponse

public static HistoryResponse unmarshallHistoryResponse(org.apache.http.HttpResponse response,
                                                        UUID requestId)
                                                 throws IOException,
                                                        IngestResponseException,
                                                        BackOffException

unmarshallHistoryResponse Given an HttpResponse object - attempts to deserialize it into a HistoryResponse object

Parameters:

response - the HttpResponse object we are trying to deserialize

requestId -

Returns:

a HistoryResponse with all the parsed out information

Throws:

IOException - if our entity is somehow corrupt or we can't get it

IngestResponseException - - if we have an uncategorized network issue

BackOffException - - if we have a 503 issue

unmarshallHistoryRangeResponse

public static HistoryRangeResponse unmarshallHistoryRangeResponse(org.apache.http.HttpResponse response,
                                                                  UUID requestId)
                                                           throws IOException,
                                                                  IngestResponseException,
                                                                  BackOffException

Given an HttpResponse object - attempts to deserialize it into a HistoryRangeResponse

Parameters:

response - the HttpResponse object we are trying to deserialize

requestId -

Returns:

HistoryRangeResponse

Throws:

IOException - if our entity is somehow corrupt or we can't get it

IngestResponseException - - if we have an uncategorized network issue

BackOffException - - if we have a 503 issue

unmarshallConfigureClientResponse

public static ConfigureClientResponse unmarshallConfigureClientResponse(org.apache.http.HttpResponse response,
                                                                        UUID requestId)
                                                                 throws IOException,
                                                                        IngestResponseException,
                                                                        BackOffException

unmarshallConfigureClientResponse - Given an HttpResponse object, attempts to deserialize it into a ConfigureClientResponse

Parameters:

response - HttpResponse

requestId -

Returns:

ConfigureClientResponse

Throws:

IOException - if our entity is somehow corrupt or we can't get it

IngestResponseException - - if we have an uncategorized network issue

BackOffException - - if we have a 503 issue

unmarshallGetClientStatus

public static ClientStatusResponse unmarshallGetClientStatus(org.apache.http.HttpResponse response,
                                                             UUID requestId)
                                                      throws IOException,
                                                             IngestResponseException,
                                                             BackOffException

unmarshallGetClientStatus - Given an HttpResponse object, attempts to deserialize it into a ClientStatusResponse

Parameters:

response - HttpResponse

requestId -

Returns:

ClientStatusResponse

Throws:

IOException - if our entity is somehow corrupt or we can't get it

IngestResponseException - - if we have an uncategorized network issue

BackOffException - - if we have a 503 issue

unmarshallStreamingIngestResponse

public static <T> T unmarshallStreamingIngestResponse(org.apache.http.HttpResponse response,
                                                      Class<T> valueType,
                                                      ServiceResponseHandler.ApiName apiName)
                                               throws IOException,
                                                      IngestResponseException

unmarshallStreamingIngestResponse Given an HttpResponse object - attempts to deserialize it into an Object based on input type

Parameters:

response - http response from server

valueType - the class type

apiName - enum to represent the corresponding api name

Returns:

the corresponding response object based on input class type

Throws:

IOException - if a low-level I/O problem

IngestResponseException - if received an exceptional status code