deprecate .withStreamId(...) methods for source/sink builders (#87)

hpgrahsl · web-flow · commit afe670332bec · 2025-06-02T14:16:04.000+02:00
- fixes #47
diff --git a/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java b/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSinkBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to write to. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to write to. */
   DecodableStreamSinkBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to write to. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to write to. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSinkBuilder<T> withStreamId(String streamId);
 
   /** Specifies the serialization schema to be used. */
diff --git a/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java b/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSourceBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to read from. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to read from. */
   DecodableStreamSourceBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to read from. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to read from. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSourceBuilder<T> withStreamId(String streamId);
 
   /** Specifies the start-up mode to use when reading from the stream. */
diff --git a/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java b/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java
@@ -33,6 +33,7 @@ public DecodableStreamSinkBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSinkBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java b/sdk/flink-1.16/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java
@@ -35,6 +35,7 @@ public DecodableStreamSourceBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSourceBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java b/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSinkBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to write to. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to write to. */
   DecodableStreamSinkBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to write to. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to write to. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSinkBuilder<T> withStreamId(String streamId);
 
   /** Specifies the serialization schema to be used. */
diff --git a/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java b/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSourceBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to read from. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to read from. */
   DecodableStreamSourceBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to read from. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to read from. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSourceBuilder<T> withStreamId(String streamId);
 
   /** Specifies the start-up mode to use when reading from the stream. */
diff --git a/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java b/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java
@@ -33,6 +33,7 @@ public DecodableStreamSinkBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSinkBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java b/sdk/flink-1.18/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java
@@ -35,6 +35,7 @@ public DecodableStreamSourceBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSourceBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java b/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSinkBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to write to. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to write to. */
   DecodableStreamSinkBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to write to. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to write to. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSinkBuilder<T> withStreamId(String streamId);
 
   /** Specifies the serialization schema to be used. */
diff --git a/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java b/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSourceBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to read from. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to read from. */
   DecodableStreamSourceBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to read from. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to read from. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSourceBuilder<T> withStreamId(String streamId);
 
   /** Specifies the start-up mode to use when reading from the stream. */
diff --git a/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java b/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java
@@ -33,6 +33,7 @@ public DecodableStreamSinkBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSinkBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java b/sdk/flink-1.19/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java
@@ -35,6 +35,7 @@ public DecodableStreamSourceBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSourceBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java b/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSinkBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSinkBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to write to. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to write to. */
   DecodableStreamSinkBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to write to. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to write to. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSinkBuilder<T> withStreamId(String streamId);
 
   /** Specifies the serialization schema to be used. */
diff --git a/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java b/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/DecodableStreamSourceBuilder.java
@@ -14,16 +14,14 @@
 @Incubating
 public interface DecodableStreamSourceBuilder<T> {
 
-  /**
-   * Specifies the name of the stream to read from. Either this or {@link #withStreamId(String)} may
-   * be used, but not both.
-   */
+  /** Specifies the name of the stream to read from. */
   DecodableStreamSourceBuilder<T> withStreamName(String streamName);
 
   /**
-   * Specifies the id of the stream to read from. Either this or {@link #withStreamName(String)} may
-   * be used, but not both.
+   * @deprecated Specifies the id of the stream to read from. Use {@link #withStreamName(String)}
+   *     instead.
    */
+  @Deprecated
   DecodableStreamSourceBuilder<T> withStreamId(String streamId);
 
   /** Specifies the start-up mode to use when reading from the stream. */
diff --git a/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java b/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSinkBuilderImpl.java
@@ -33,6 +33,7 @@ public DecodableStreamSinkBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSinkBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;
diff --git a/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java b/sdk/flink-1.20/src/main/java/co/decodable/sdk/pipeline/internal/DecodableStreamSourceBuilderImpl.java
@@ -35,6 +35,7 @@ public DecodableStreamSourceBuilder<T> withStreamName(String streamName) {
   }
 
   @Override
+  @Deprecated
   public DecodableStreamSourceBuilder<T> withStreamId(String streamId) {
     this.streamId = streamId;
     return this;

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ public DecodableStreamSinkBuilder<T> withStreamName(String streamName) {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
	`36`	`+ @Deprecated`
`36`	`37`	`public DecodableStreamSinkBuilder<T> withStreamId(String streamId) {`
`37`	`38`	`this.streamId = streamId;`
`38`	`39`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public DecodableStreamSourceBuilder<T> withStreamName(String streamName) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`@Override`
	`38`	`+ @Deprecated`
`38`	`39`	`public DecodableStreamSourceBuilder<T> withStreamId(String streamId) {`
`39`	`40`	`this.streamId = streamId;`
`40`	`41`	`return this;`