From 84e089d0411834c1d63ae23dd7c8f137e129a020 Mon Sep 17 00:00:00 2001 From: Jay Patel Date: Wed, 25 Oct 2023 21:48:08 -0700 Subject: [PATCH] Add more comments --- .../internal/streaming/ChannelExistenceCheckerRequest.java | 5 ++++- .../internal/streaming/ChannelExistenceCheckerResponse.java | 5 ++++- .../streaming/StreamingChannelExistenceCheckerTestIT.java | 1 + 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerRequest.java b/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerRequest.java index 9bdde30d39..dc4a796f8f 100644 --- a/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerRequest.java +++ b/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerRequest.java @@ -3,7 +3,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; -/** Class to deserialize a request from a channel status request */ +/** + * Class to deserialize a request from a channel status request Please keep this upto date with + * {@link net.snowflake.ingest.streaming.internal.ChannelsStatusRequest} + */ class ChannelExistenceCheckerRequest { // Used to deserialize a channel request diff --git a/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerResponse.java b/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerResponse.java index 9ede251d4b..6c66bc26f2 100644 --- a/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerResponse.java +++ b/src/main/java/com/snowflake/kafka/connector/internal/streaming/ChannelExistenceCheckerResponse.java @@ -3,7 +3,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; -/** Class used to serialize a response for the channels status endpoint */ +/** + * Class used to serialize a response for the channels status endpoint. Please keep this upto date + * with {@link net.snowflake.ingest.streaming.internal.ChannelsStatusResponse} + */ public class ChannelExistenceCheckerResponse { static class ChannelStatusResponseDTO { diff --git a/src/test/java/com/snowflake/kafka/connector/internal/streaming/StreamingChannelExistenceCheckerTestIT.java b/src/test/java/com/snowflake/kafka/connector/internal/streaming/StreamingChannelExistenceCheckerTestIT.java index e984f8587c..853fd093d4 100644 --- a/src/test/java/com/snowflake/kafka/connector/internal/streaming/StreamingChannelExistenceCheckerTestIT.java +++ b/src/test/java/com/snowflake/kafka/connector/internal/streaming/StreamingChannelExistenceCheckerTestIT.java @@ -18,6 +18,7 @@ import org.junit.Before; import org.junit.Test; +/** IT test related to ChannelExistenceCheckerRequest which Makes server side Calls */ public class StreamingChannelExistenceCheckerTestIT { private SnowflakeConnectionService conn = TestUtils.getConnectionServiceForStreaming();