All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.snowflake.ingest.streaming.internal.SnowflakeServiceClient Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * Copyright (c) 2024 Snowflake Computing Inc. All rights reserved.
 */

package net.snowflake.ingest.streaming.internal;

import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_CHANNEL_CONFIGURE;
import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_CHANNEL_STATUS;
import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_CLIENT_CONFIGURE;
import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_DROP_CHANNEL;
import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_OPEN_CHANNEL;
import static net.snowflake.ingest.connection.ServiceResponseHandler.ApiName.STREAMING_REGISTER_BLOB;
import static net.snowflake.ingest.streaming.internal.StreamingIngestUtils.executeWithRetries;
import static net.snowflake.ingest.utils.Constants.CHANNEL_CONFIGURE_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.CHANNEL_STATUS_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.CLIENT_CONFIGURE_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.DROP_CHANNEL_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.OPEN_CHANNEL_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.REGISTER_BLOB_ENDPOINT;
import static net.snowflake.ingest.utils.Constants.RESPONSE_SUCCESS;

import java.io.IOException;
import net.snowflake.client.jdbc.internal.apache.http.impl.client.CloseableHttpClient;
import net.snowflake.ingest.connection.IngestResponseException;
import net.snowflake.ingest.connection.RequestBuilder;
import net.snowflake.ingest.connection.ServiceResponseHandler;
import net.snowflake.ingest.utils.ErrorCode;
import net.snowflake.ingest.utils.Logging;
import net.snowflake.ingest.utils.SFException;

/**
 * The SnowflakeServiceClient class is responsible for making API requests to the Snowflake service.
 */
class SnowflakeServiceClient {
  private static final Logging logger = new Logging(SnowflakeServiceClient.class);

  /** HTTP client used for making requests */
  private final CloseableHttpClient httpClient;

  /** Request builder for building streaming API request */
  private final RequestBuilder requestBuilder;

  /**
   * Default constructor
   *
   * @param httpClient the HTTP client used for making requests
   * @param requestBuilder the request builder for building streaming API requests
   */
  SnowflakeServiceClient(CloseableHttpClient httpClient, RequestBuilder requestBuilder) {
    this.httpClient = httpClient;
    this.requestBuilder = requestBuilder;
  }

  /**
   * Configures the client given a {@link ClientConfigureRequest}.
   *
   * @param request the client configuration request
   * @return the response from the configuration request
   */
  ClientConfigureResponse clientConfigure(ClientConfigureRequest request)
      throws IngestResponseException, IOException {
    ClientConfigureResponse response =
        executeApiRequestWithRetries(
            ClientConfigureResponse.class,
            request,
            CLIENT_CONFIGURE_ENDPOINT,
            "client configure",
            STREAMING_CLIENT_CONFIGURE);
    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Client configure request failed, request={}, message={}",
          request.getStringForLogging(),
          response.getMessage());
      throw new SFException(ErrorCode.CLIENT_CONFIGURE_FAILURE, response.getMessage());
    }
    return response;
  }

  /**
   * Configures a channel's storage info given a {@link ChannelConfigureRequest}.
   *
   * @param request the channel configuration request
   * @return the response from the configuration request
   */
  ChannelConfigureResponse channelConfigure(ChannelConfigureRequest request)
      throws IngestResponseException, IOException {
    ChannelConfigureResponse response =
        executeApiRequestWithRetries(
            ChannelConfigureResponse.class,
            request,
            CHANNEL_CONFIGURE_ENDPOINT,
            "channel configure",
            STREAMING_CHANNEL_CONFIGURE);

    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Channel configure request failed, request={}, response={}",
          request.getStringForLogging(),
          response.getMessage());
      throw new SFException(ErrorCode.CHANNEL_CONFIGURE_FAILURE, response.getMessage());
    }
    return response;
  }

  /**
   * Opens a channel given a {@link OpenChannelRequestInternal}.
   *
   * @param request the open channel request
   * @return the response from the open channel request
   */
  OpenChannelResponse openChannel(OpenChannelRequestInternal request)
      throws IngestResponseException, IOException {
    OpenChannelResponse response =
        executeApiRequestWithRetries(
            OpenChannelResponse.class,
            request,
            OPEN_CHANNEL_ENDPOINT,
            "open channel",
            STREAMING_OPEN_CHANNEL);

    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Open channel request failed, request={}, response={}",
          request.getStringForLogging(),
          response.getMessage());
      throw new SFException(ErrorCode.OPEN_CHANNEL_FAILURE, response.getMessage());
    }
    return response;
  }

  /**
   * Drops a channel given a {@link DropChannelRequestInternal}.
   *
   * @param request the drop channel request
   * @return the response from the drop channel request
   */
  DropChannelResponse dropChannel(DropChannelRequestInternal request)
      throws IngestResponseException, IOException {
    DropChannelResponse response =
        executeApiRequestWithRetries(
            DropChannelResponse.class,
            request,
            DROP_CHANNEL_ENDPOINT,
            "drop channel",
            STREAMING_DROP_CHANNEL);

    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Drop channel request failed, request={}, response={}",
          request.getStringForLogging(),
          response.getMessage());
      throw new SFException(ErrorCode.DROP_CHANNEL_FAILURE, response.getMessage());
    }
    return response;
  }

  /**
   * Gets the status of a channel given a {@link ChannelsStatusRequest}.
   *
   * @param request the channel status request
   * @return the response from the channel status request
   */
  ChannelsStatusResponse getChannelStatus(ChannelsStatusRequest request)
      throws IngestResponseException, IOException {
    ChannelsStatusResponse response =
        executeApiRequestWithRetries(
            ChannelsStatusResponse.class,
            request,
            CHANNEL_STATUS_ENDPOINT,
            "channel status",
            STREAMING_CHANNEL_STATUS);

    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Channel status request failed, request={}, response={}",
          request.getStringForLogging(),
          response.getMessage());
      throw new SFException(ErrorCode.CHANNEL_STATUS_FAILURE, response.getMessage());
    }
    return response;
  }

  /**
   * Registers a blob given a {@link RegisterBlobRequest}.
   *
   * @param request the register blob request
   * @param executionCount the number of times the request has been executed, used for logging
   * @return the response from the register blob request
   */
  RegisterBlobResponse registerBlob(RegisterBlobRequest request, final int executionCount)
      throws IngestResponseException, IOException {
    RegisterBlobResponse response =
        executeApiRequestWithRetries(
            RegisterBlobResponse.class,
            request,
            REGISTER_BLOB_ENDPOINT,
            "register blob",
            STREAMING_REGISTER_BLOB);

    if (response.getStatusCode() != RESPONSE_SUCCESS) {
      logger.logDebug(
          "Register blob request failed, request={}, response={}, executionCount={}",
          request.getStringForLogging(),
          response.getMessage(),
          executionCount);
      throw new SFException(ErrorCode.REGISTER_BLOB_FAILURE, response.getMessage());
    }
    return response;
  }

  private  T executeApiRequestWithRetries(
      Class responseClass,
      IStreamingIngestRequest request,
      String endpoint,
      String operation,
      ServiceResponseHandler.ApiName apiName)
      throws IngestResponseException, IOException {
    return executeWithRetries(
        responseClass, endpoint, request, operation, apiName, this.httpClient, this.requestBuilder);
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy