Skip to content

[FLINK-39331] Add @Experimental annotation to public Native S3 classes#27833

Open
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:Add-experimental-annotation
Open

[FLINK-39331] Add @Experimental annotation to public Native S3 classes#27833
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:Add-experimental-annotation

Conversation

@Samrat002
Copy link
Contributor

What is the purpose of the change

Mark the public API classes in flink-s3-fs-native as experimental to signal to users that this feature is still evolving and may undergo changes in future releases.

Brief change log

Mark following public class with @Experimental

  1. NativeS3FileSystemFactory
  2. NativeS3AFileSystemFactory
  3. NativeS3OutputStream
  4. NativeS3RecoverableFsDataOutputStream
  5. NativeS3Committer

Verifying this change

Existing UT suffices.

Does this pull request potentially affect one of the following parts:

  • Dependencies: no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): yes (marked as @Experimental)
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: no
  • The S3 file system connector: yes

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

@flinkbot
Copy link
Collaborator

flinkbot commented Mar 26, 2026

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Contributor

@Izeren Izeren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR @Samrat002, I wonder if we should rather reduce visibility of the classes than adding experimental annotation to them (except for factories)

* operation, a multipart upload should always have at least one part before committing.
*/
@Experimental
public class NativeS3Committer implements RecoverableFsDataOutputStream.Committer {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this class to be public?

*/
@Experimental
@NotThreadSafe
public class NativeS3RecoverableFsDataOutputStream extends RecoverableFsDataOutputStream {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same

* can be safely invoked from another thread (e.g. during task cancellation) per {@link
* org.apache.flink.core.fs.FSDataOutputStream} contract.
*/
@Experimental
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@Izeren
Copy link
Contributor

Izeren commented Mar 26, 2026

@Samrat002, In addition, should we downgrade: NativeS3FileSystem, NativeS3InputStream, NativeS3Recoverable, NativeS3RecoverableSerializer to package-private or Internal@?

Also, NativeS3RecoverableWriter is marked as @PublicEvolving, and it should be Experimental@ as well

@github-actions github-actions bot added the community-reviewed PR has been reviewed by the community. label Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants