Code refactor for Iceberg support

src/main/java/net/snowflake/ingest/streaming/OpenChannelRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 Snowflake Computing Inc. All rights reserved.
+ * Copyright (c) 2021-2024 Snowflake Computing Inc. All rights reserved.
  */
 
 package net.snowflake.ingest.streaming;
@@ -41,7 +41,6 @@ public enum OnErrorOption {
   private final ZoneId defaultTimezone;
 
   private final String offsetToken;
-  private final boolean isOffsetTokenProvided;
 
   private final OffsetTokenVerificationFunction offsetTokenVerificationFunction;
 
@@ -59,7 +58,6 @@ public static class OpenChannelRequestBuilder {
     private ZoneId defaultTimezone;
 
     private String offsetToken;
-    private boolean isOffsetTokenProvided = false;
 
     private OffsetTokenVerificationFunction offsetTokenVerificationFunction;
 
@@ -95,7 +93,6 @@ public OpenChannelRequestBuilder setDefaultTimezone(ZoneId defaultTimezone) {
 
     public OpenChannelRequestBuilder setOffsetToken(String offsetToken) {
       this.offsetToken = offsetToken;
-      this.isOffsetTokenProvided = true;
       return this;
     }
 
@@ -125,7 +122,6 @@ private OpenChannelRequest(OpenChannelRequestBuilder builder) {
     this.onErrorOption = builder.onErrorOption;
     this.defaultTimezone = builder.defaultTimezone;
     this.offsetToken = builder.offsetToken;
-    this.isOffsetTokenProvided = builder.isOffsetTokenProvided;
     this.offsetTokenVerificationFunction = builder.offsetTokenVerificationFunction;
   }
 
@@ -150,7 +146,7 @@ public ZoneId getDefaultTimezone() {
   }
 
   public String getFullyQualifiedTableName() {
-    return String.format("%s.%s.%s", this.dbName, this.schemaName, this.tableName);
+    return Utils.getFullyQualifiedTableName(this.dbName, this.schemaName, this.tableName);
   }
 
   public OnErrorOption getOnErrorOption() {
@@ -161,10 +157,6 @@ public String getOffsetToken() {
     return this.offsetToken;
   }
 
-  public boolean isOffsetTokenProvided() {
-    return this.isOffsetTokenProvided;
-  }
-
   public OffsetTokenVerificationFunction getOffsetTokenVerificationFunction() {
     return this.offsetTokenVerificationFunction;
   }

src/main/java/net/snowflake/ingest/streaming/internal/ChannelFlushContext.java

@@ -1,9 +1,11 @@
 /*
- * Copyright (c) 2022 Snowflake Computing Inc. All rights reserved.
+ * Copyright (c) 2022-2024 Snowflake Computing Inc. All rights reserved.
  */
 
 package net.snowflake.ingest.streaming.internal;
 
+import net.snowflake.ingest.utils.Utils;
+
 /**
  * Channel immutable identification and encryption attributes.
  *
@@ -36,12 +38,12 @@ class ChannelFlushContext {
       String encryptionKey,
       Long encryptionKeyId) {
     this.name = name;
-    this.fullyQualifiedName = String.format("%s.%s.%s.%s", dbName, schemaName, tableName, name);
+    this.fullyQualifiedName =
+        Utils.getFullyQualifiedChannelName(dbName, schemaName, tableName, name);
     this.dbName = dbName;
     this.schemaName = schemaName;
     this.tableName = tableName;
-    this.fullyQualifiedTableName =
-        String.format("%s.%s.%s", this.getDbName(), this.getSchemaName(), this.getTableName());
+    this.fullyQualifiedTableName = Utils.getFullyQualifiedTableName(dbName, schemaName, tableName);
     this.channelSequencer = channelSequencer;
     this.encryptionKey = encryptionKey;
     this.encryptionKeyId = encryptionKeyId;

src/main/java/net/snowflake/ingest/streaming/internal/ChannelsStatusRequest.java

@@ -1,14 +1,16 @@
 /*
- * Copyright (c) 2021 Snowflake Computing Inc. All rights reserved.
+ * Copyright (c) 2021-2024 Snowflake Computing Inc. All rights reserved.
  */
 
 package net.snowflake.ingest.streaming.internal;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.List;
+import java.util.stream.Collectors;
+import net.snowflake.ingest.utils.Utils;
 
 /** Class to deserialize a request from a channel status request */
-class ChannelsStatusRequest {
+class ChannelsStatusRequest implements StreamingIngestRequest {
 
   // Used to deserialize a channel request
   static class ChannelStatusRequestDTO {
@@ -86,4 +88,20 @@ void setChannels(List<ChannelStatusRequestDTO> channels) {
   List<ChannelStatusRequestDTO> getChannels() {
     return channels;
   }
+
+  @Override
+  public String getStringForLogging() {
+    return String.format(
+        "ChannelsStatusRequest(role=%s, channels=[%s])",
+        role,
+        channels.stream()
+            .map(
+                r ->
+                    Utils.getFullyQualifiedChannelName(
+                        r.getDatabaseName(),
+                        r.getSchemaName(),
+                        r.getTableName(),
+                        r.getChannelName()))
+            .collect(Collectors.joining(", ")));
+  }
 }

src/main/java/net/snowflake/ingest/streaming/internal/ClientConfigureRequest.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2024 Snowflake Computing Inc. All rights reserved.
+ */
+
+package net.snowflake.ingest.streaming.internal;
+
+/** Class used to serialize client configure request */
+class ClientConfigureRequest extends ConfigureRequest {
+  /**
+   * Constructor for client configure request
+   *
+   * @param role Role to be used for the request.
+   */
+  ClientConfigureRequest(String role) {
+    setRole(role);
+  }
+
+  @Override
+  public String getStringForLogging() {
+    return String.format("ClientConfigureRequest(role=%s, file_name=%s)", getRole(), getFileName());
+  }
+}

src/main/java/net/snowflake/ingest/streaming/internal/ClientConfigureResponse.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2024 Snowflake Computing Inc. All rights reserved.
+ */
+
+package net.snowflake.ingest.streaming.internal;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Class used to deserialize responses from configure endpoint */
+@JsonIgnoreProperties(ignoreUnknown = true)
+class ClientConfigureResponse extends StreamingIngestResponse {
+  @JsonProperty("prefix")
+  private String prefix;
+
+  @JsonProperty("status_code")
+  private Long statusCode;
+
+  @JsonProperty("message")
+  private String message;
+
+  @JsonProperty("stage_location")
+  private FileLocationInfo stageLocation;
+
+  @JsonProperty("deployment_id")
+  private Long deploymentId;
+
+  String getPrefix() {
+    return prefix;
+  }
+
+  void setPrefix(String prefix) {
+    this.prefix = prefix;
+  }
+
+  @Override
+  Long getStatusCode() {
+    return statusCode;
+  }
+
+  void setStatusCode(Long statusCode) {
+    this.statusCode = statusCode;
+  }
+
+  String getMessage() {
+    return message;
+  }
+
+  void setMessage(String message) {
+    this.message = message;
+  }
+
+  FileLocationInfo getStageLocation() {
+    return stageLocation;
+  }
+
+  void setStageLocation(FileLocationInfo stageLocation) {
+    this.stageLocation = stageLocation;
+  }
+
+  Long getDeploymentId() {
+    return deploymentId;
+  }
+
+  void setDeploymentId(Long deploymentId) {
+    this.deploymentId = deploymentId;
+  }
+
+  String getClientPrefix() {
+    if (this.deploymentId == null) {
+      return this.prefix;
+    }
+    return this.prefix + "_" + this.deploymentId;
+  }
+}

src/main/java/net/snowflake/ingest/streaming/internal/ConfigureRequest.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2024 Snowflake Computing Inc. All rights reserved.
+ */
+
+package net.snowflake.ingest.streaming.internal;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Abstract class for {@link ChannelConfigureRequest} and {@link ClientConfigureRequest} */
+abstract class ConfigureRequest implements StreamingIngestRequest {
+  @JsonProperty("role")
+  private String role;
+
+  // File name for the GCS signed url request
+  @JsonInclude(JsonInclude.Include.NON_NULL)
+  @JsonProperty("file_name")
+  private String fileName;
+
+  String getRole() {
+    return role;
+  }
+
+  void setRole(String role) {
+    this.role = role;
+  }
+
+  String getFileName() {
+    return fileName;
+  }
+
+  void setFileName(String fileName) {
+    this.fileName = fileName;
+  }
+
+  @Override
+  public abstract String getStringForLogging();
+}

src/main/java/net/snowflake/ingest/streaming/internal/DropChannelRequestInternal.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2024 Snowflake Computing Inc. All rights reserved.
+ */
+
+package net.snowflake.ingest.streaming.internal;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import net.snowflake.ingest.streaming.DropChannelRequest;
+import net.snowflake.ingest.utils.Utils;
+
+/** Class used to serialize the {@link DropChannelRequest} */
+class DropChannelRequestInternal implements StreamingIngestRequest {
+  @JsonProperty("request_id")
+  private String requestId;
+
+  @JsonProperty("role")
+  private String role;
+
+  @JsonProperty("channel")
+  private String channel;
+
+  @JsonProperty("table")
+  private String table;
+
+  @JsonProperty("database")
+  private String database;
+
+  @JsonProperty("schema")
+  private String schema;
+
+  @JsonInclude(JsonInclude.Include.NON_NULL)
+  @JsonProperty("client_sequencer")
+  Long clientSequencer;
+
+  DropChannelRequestInternal(
+      String requestId,
+      String role,
+      String database,
+      String schema,
+      String table,
+      String channel,
+      Long clientSequencer) {
+    this.requestId = requestId;
+    this.role = role;
+    this.database = database;
+    this.schema = schema;
+    this.table = table;
+    this.channel = channel;
+    this.clientSequencer = clientSequencer;
+  }
+
+  String getRequestId() {
+    return requestId;
+  }
+
+  String getRole() {
+    return role;
+  }
+
+  String getChannel() {
+    return channel;
+  }
+
+  String getTable() {
+    return table;
+  }
+
+  String getDatabase() {
+    return database;
+  }
+
+  String getSchema() {
+    return schema;
+  }
+
+  Long getClientSequencer() {
+    return clientSequencer;
+  }
+
+  String getFullyQualifiedTableName() {
+    return Utils.getFullyQualifiedTableName(database, schema, table);
+  }
+
+  @Override
+  public String getStringForLogging() {
+    return String.format(
+        "DropChannelRequest(requestId=%s, role=%s, db=%s, schema=%s, table=%s, channel=%s,"
+            + " clientSequencer=%s)",
+        requestId, role, database, schema, table, channel, clientSequencer);
+  }
+}