Skip to content

Commit

Permalink
docs: Add warning about internal classes.
Browse files Browse the repository at this point in the history
  • Loading branch information
hessjcg committed Oct 30, 2023
1 parent 5fa87ff commit a5d2892
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
import com.google.cloud.sql.ConnectionConfig;

/**
* Implementation of informally used java API to preserve compatibility with older code that uses
* CoreSocketFactory.
* WARNING: This class is not a stable, public Java API. The class definition may change without
* notice. Implementation of informally used java API to preserve compatibility with older code that
* uses CoreSocketFactory.
*
* @deprecated This will soon be replaced.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* <p>This class should not be used directly, but only through the JDBC driver specific {@code
* SocketFactory} implementations.
*
* <p>The API of this class is subject to change without notice.
* <p>WARNING: This is an internal class. The API is subject to change without notice.
*/
public final class InternalConnectorRegistry {
static final long DEFAULT_MAX_REFRESH_MS = 30000;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@
*/

/**
* Package com.google.cloud.sql.core holds internal shared packages that implement logic to create a
* socket to a Cloud SQL database. Classes in this package are considered internal and subject to
* WARNING: This package does not contain any stable, public Java API. The class definitions may
* change without notice.
*
* <p>Package com.google.cloud.sql.core holds internal shared packages that implement logic to
* create a socket to a Cloud SQL database.
*/
package com.google.cloud.sql.core;

0 comments on commit a5d2892

Please sign in to comment.