luciano/amazon-kinesis-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Java doc for internal Api annotation (#1466)

Browse source
This commit is contained in:
chenylee-aws 2025-04-14 09:32:16 -07:00 committed by GitHub
parent 133374706c
commit 6990fc513f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/scripts/backwards_compatibility_check.sh vendored
View file

@ -92,7 +92,7 @@ find_removed_methods() {
grep -v 'software\.amazon\.kinesis\.retrieval\.kpl\.Messages') grep -v 'software\.amazon\.kinesis\.retrieval\.kpl\.Messages')
for class in $latest_classes for class in $latest_classes
do do
if (is_kinesis_client_internal_api "$class" && (is_new_minor_release || is_new_major_release)) || is_non_public_class "$class" if is_kinesis_client_internal_api "$class" || is_non_public_class "$class"
then then
continue continue
fi fi
@ -117,10 +117,6 @@ find_removed_methods() {
if [[ "$removed_methods" != "" ]] if [[ "$removed_methods" != "" ]]
then then
REMOVED_METHODS_FLAG=$TRUE REMOVED_METHODS_FLAG=$TRUE
if is_kinesis_client_internal_api "$class"
then
echo "Found removed methods in class with @KinesisClientInternalApi annotation. To resolve these issues, upgrade the current minor version or address these changes."
fi
echo "$class does not have method(s):" echo "$class does not have method(s):"
echo "$removed_methods" echo "$removed_methods"
fi fi

4
amazon-kinesis-client/src/main/java/software/amazon/kinesis/annotations/KinesisClientInternalApi.java
View file

@ -19,7 +19,9 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
/** /**
* Any class/method/variable marked with this annotation is subject to breaking changes between minor releases. * Marker interface for 'internal' APIs that should not be used outside the core module.
* Breaking changes can and will be introduced to elements marked as KinesisClientInternalApi.
* Users of the KCL should not depend on any packages, types, fields, constructors, or methods with this annotation.
*/ */
@Retention(RetentionPolicy.CLASS) @Retention(RetentionPolicy.CLASS)
public @interface KinesisClientInternalApi {} public @interface KinesisClientInternalApi {}