Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java: update API docs #1852

Merged
merged 1 commit into from
Jul 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* Supports commands and transactions for the "Bitmap Commands" group for standalone and cluster
* clients.
*
* @see <a href="https://redis.io/commands/?group=bitmap">Bitmap Commands</a>
* @see <a href="https://valkey.io/commands/?group=bitmap">Bitmap Commands</a>
*/
public interface BitmapBaseCommands {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/**
* Supports commands for the "Connection Management" group for a cluster client.
*
* @see <a href="https://redis.io/commands/?group=connection">Connection Management Commands</a>
* @see <a href="https://valkey.io/commands/?group=connection">Connection Management Commands</a>
*/
public interface ConnectionManagementClusterCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Supports commands and transactions for the "Connection Management" group for a standalone client.
*
* @see <a href="https://redis.io/commands/?group=connection">Connection Management Commands</a>
* @see <a href="https://valkey.io/commands/?group=connection">Connection Management Commands</a>
*/
public interface ConnectionManagementCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* Supports commands and transactions for the "Generic Commands" group for standalone and cluster
* clients.
*
* @see <a href="https://redis.io/commands/?group=generic">Generic Commands</a>
* @see <a href="https://valkey.io/commands/?group=generic">Generic Commands</a>
*/
public interface GenericBaseCommands {
/** Valkey API keyword used to replace the destination key. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
/**
* Supports commands for the "Generic Commands" group for a cluster client.
*
* @see <a href="https://redis.io/commands/?group=generic">Generic Commands</a>
* @see <a href="https://valkey.io/commands/?group=generic">Generic Commands</a>
*/
public interface GenericClusterCommands {

Expand Down Expand Up @@ -46,13 +46,12 @@ public interface GenericClusterCommands {
* <p>Client will route the command to the nodes defined by <code>route</code>.
*
* @apiNote See <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Glide
* for Redis Wiki</a> for details on the restrictions and limitations of the custom command
* API.
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Valkey
* GLIDE Wiki</a> for details on the restrictions and limitations of the custom command API.
* @param args Arguments for the custom command including the command name
* @param route Specifies the routing configuration for the command. The client will route the
* command to the nodes defined by <code>route</code>.
* @return Response from Redis containing an <code>Object</code>.
* @return The returning value depends on the executed command.
* @example
* <pre>{@code
* ClusterValue<Object> result = clusterClient.customCommand(new String[]{ "CONFIG", "GET", "maxmemory"}, ALL_NODES).get();
Expand All @@ -69,7 +68,7 @@ public interface GenericClusterCommands {
* <p>The transaction will be routed to the slot owner of the first key found in the transaction.
* If no key is found, the command will be sent to a random node.
*
* @see <a href="https://redis.io/topics/Transactions/">valkey.io</a> for details on Redis
* @see <a href="https://valkey.io/docs/topics/transactions/">valkey.io</a> for details on
* Transactions.
* @param transaction A {@link Transaction} object containing a list of commands to be executed.
* @return A list of results corresponding to the execution of each command in the transaction.
Expand All @@ -93,7 +92,7 @@ public interface GenericClusterCommands {
/**
* Executes a transaction by processing the queued commands.
*
* @see <a href="https://redis.io/topics/Transactions/">valkey.io</a> for details on Redis
* @see <a href="https://valkey.io/docs/topics/transactions/">valkey.io</a> for details on
* Transactions.
* @param transaction A {@link Transaction} object containing a list of commands to be executed.
* @param route A single-node routing configuration for the transaction. The client will route the
Expand Down Expand Up @@ -139,7 +138,7 @@ public interface GenericClusterCommands {
/**
* Returns a random key.
*
* @see <a href="https://redis.io/docs/latest/commands/randomkey/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/randomkey/">valkey.io</a> for details.
* @param route Specifies the routing configuration for the command. The client will route the
* command to the nodes defined by <code>route</code>, and will return the first successful
* result.
Expand Down Expand Up @@ -176,7 +175,7 @@ public interface GenericClusterCommands {
* Returns a random key.<br>
* The command will be routed to all primary nodes, and will return the first successful result.
*
* @see <a href="https://redis.io/docs/latest/commands/randomkey/">redis.io</a> for details.
* @see <a href="https://valkey.io/docs/commands/randomkey/">valkey.io</a> for details.
* @return A random <code>key</code> from the database.
* @example
* <pre>{@code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,21 @@
/**
* Supports commands and transactions for the "Generic Commands" group for a standalone client.
*
* @see <a href="https://redis.io/commands/?group=generic">Generic Commands</a>
* @see <a href="https://valkey.io/commands/?group=generic">Generic Commands</a>
*/
public interface GenericCommands {
/** Redis API keyword used to denote the destination db index. */
/** Valkey API keyword used to denote the destination db index. */
String DB_VALKEY_API = "DB";

/**
* Executes a single command, without checking inputs. Every part of the command, including
* subcommands, should be added as a separate value in <code>args</code>.
*
* @apiNote See <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Glide
* for Redis Wiki</a> for details on the restrictions and limitations of the custom command
* API.
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Valkey
* GLIDE Wiki</a> for details on the restrictions and limitations of the custom command API.
* @param args Arguments for the custom command.
* @return Response from Redis containing an <code>Object</code>.
* @return The returning value depends on the executed command.
* @example
* <pre>{@code
* Object response = (String) client.customCommand(new String[] {"ping", "GLIDE"}).get();
Expand All @@ -41,7 +40,7 @@ public interface GenericCommands {
/**
* Executes a transaction by processing the queued commands.
*
* @see <a href="https://redis.io/topics/Transactions/">valkey.io</a> for details on Redis
* @see <a href="https://valkey.io/docs/topics/transactions/">valkey.io</a> for details on
* Transactions.
* @param transaction A {@link Transaction} object containing a list of commands to be executed.
* @return A list of results corresponding to the execution of each command in the transaction.
Expand Down Expand Up @@ -201,7 +200,7 @@ CompletableFuture<Boolean> copy(
/**
* Returns a random key from currently selected database.
*
* @see <a href="https://redis.io/docs/latest/commands/randomkey/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/randomkey/">valkey.io</a> for details.
* @return A random <code>key</code> from the database.
* @example
* <pre>{@code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* Supports commands and transactions for the "Geospatial Indices Commands" group for standalone and
* cluster clients.
*
* @see <a href="https://redis.io/commands/?group=geo">Geospatial Indices Commands</a>
* @see <a href="https://valkey.io/commands/?group=geo">Geospatial Indices Commands</a>
*/
public interface GeospatialIndicesBaseCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
* Supports commands and transactions for the "Hash Commands" group for standalone and cluster
* clients.
*
* @see <a href="https://redis.io/commands/?group=hash">Hash Commands</a>
* @see <a href="https://valkey.io/commands/?group=hash">Hash Commands</a>
*/
public interface HashBaseCommands {
/** Redis API keyword used to query hash members with their values. */
/** Valkey API keyword used to query hash members with their values. */
String WITH_VALUES_VALKEY_API = "WITHVALUES";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* Supports commands and transactions for the "HyperLogLog Commands" group for standalone and
* cluster clients.
*
* @see <a href="https://redis.io/commands/?group=hyperloglog">HyperLogLog Commands</a>
* @see <a href="https://valkey.io/commands/?group=hyperloglog">HyperLogLog Commands</a>
*/
public interface HyperLogLogBaseCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
* Supports commands and transactions for the "List Commands" group for standalone and cluster
* clients.
*
* @see <a href="https://redis.io/commands/?group=list">List Commands</a>
* @see <a href="https://valkey.io/commands/?group=list">List Commands</a>
*/
public interface ListBaseCommands {
/** Redis API keyword used to extract specific count of members from a sorted set. */
/** Valkey API keyword used to extract specific count of members from a sorted set. */
String COUNT_FOR_LIST_VALKEY_API = "COUNT";

/**
Expand Down Expand Up @@ -84,7 +84,7 @@ public interface ListBaseCommands {
* Removes and returns the first elements of the list stored at <code>key</code>. The command pops
* a single element from the beginning of the list.
*
* @see <a href="https://redis.io/commands/lpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/lpop/">valkey.io</a> for details.
* @param key The key of the list.
* @return The value of the first element.<br>
* If <code>key</code> does not exist, null will be returned.
Expand Down Expand Up @@ -317,7 +317,7 @@ CompletableFuture<Long[]> lposCount(
* Removes and returns up to <code>count</code> elements of the list stored at <code>key</code>,
* depending on the list's length.
*
* @see <a href="https://redis.io/commands/lpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/lpop/">valkey.io</a> for details.
* @param key The key of the list.
* @param count The count of the elements to pop from the list.
* @return An array of the popped elements will be returned depending on the list's length.<br>
Expand Down Expand Up @@ -642,7 +642,7 @@ CompletableFuture<Long[]> lposCount(
* Removes and returns the last elements of the list stored at <code>key</code>.<br>
* The command pops a single element from the end of the list.
*
* @see <a href="https://redis.io/commands/rpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/rpop/">valkey.io</a> for details.
* @param key The key of the list.
* @return The value of the last element.<br>
* If <code>key</code> does not exist, <code>null</code> will be returned.
Expand Down Expand Up @@ -681,7 +681,7 @@ CompletableFuture<Long[]> lposCount(
* Removes and returns up to <code>count</code> elements from the list stored at <code>key</code>,
* depending on the list's length.
*
* @see <a href="https://redis.io/commands/rpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/rpop/">valkey.io</a> for details.
* @param key The key of the list.
* @param count The count of the elements to pop from the list.
* @return An array of popped elements will be returned depending on the list's length.<br>
Expand Down Expand Up @@ -784,7 +784,7 @@ CompletableFuture<Long> linsert(
* Commands</a> for more details and best practices.
* </ul>
*
* @see <a href="https://redis.io/commands/blpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/blpop/">valkey.io</a> for details.
* @param keys The <code>keys</code> of the lists to pop from.
* @param timeout The number of seconds to wait for a blocking operation to complete. A value of
* <code>0</code> will block indefinitely.
Expand Down Expand Up @@ -844,7 +844,7 @@ CompletableFuture<Long> linsert(
* Commands</a> for more details and best practices.
* </ul>
*
* @see <a href="https://redis.io/commands/brpop/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/brpop/">valkey.io</a> for details.
* @param keys The <code>keys</code> of the lists to pop from.
* @param timeout The number of seconds to wait for a blocking operation to complete. A value of
* <code>0</code> will block indefinitely.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Supports commands for the "Pub/Sub" group for standalone and cluster clients.
*
* @see <a href="https://redis.io/commands/?group=pubsub">Pub/Sub Commands</a>
* @see <a href="https://valkey.io/commands/?group=pubsub">Pub/Sub Commands</a>
*/
public interface PubSubBaseCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public interface PubSubClusterCommands {
* @param message The message to publish.
* @param channel The channel to publish the message on.
* @param sharded Indicates that this should be run in sharded mode. Setting <code>sharded</code>
* to <code>true</code> is only applicable with Redis 7.0+.
* to <code>true</code> is only applicable with Valkey 7.0+.
* @return <code>OK</code>.
* @example
* <pre>{@code
Expand All @@ -37,7 +37,7 @@ public interface PubSubClusterCommands {
* @param message The message to publish.
* @param channel The channel to publish the message on.
* @param sharded Indicates that this should be run in sharded mode. Setting <code>sharded</code>
* to <code>true</code> is only applicable with Redis 7.0+.
* to <code>true</code> is only applicable with Valkey 7.0+.
* @return <code>OK</code>.
* @example
* <pre>{@code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Supports commands and transactions for the "Scripting and Function" group for standalone and
* cluster clients.
*
* @see <a href="https://redis.io/commands/?group=scripting">Scripting and Function Commands</a>
* @see <a href="https://valkey.io/commands/?group=scripting">Scripting and Function Commands</a>
*/
public interface ScriptingAndFunctionsBaseCommands {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
/**
* Supports commands and transactions for the "Scripting and Function" group for a cluster client.
*
* @see <a href="https://redis.io/commands/?group=scripting">Scripting and Function Commands</a>
* @see <a href="https://valkey.io/commands/?group=scripting">Scripting and Function Commands</a>
*/
public interface ScriptingAndFunctionsClusterCommands {

/**
* Loads a library to Redis.<br>
* Loads a library to Valkey.<br>
* The command will be routed to all primary nodes.
*
* @since Valkey 7.0 and above.
Expand All @@ -37,7 +37,7 @@ public interface ScriptingAndFunctionsClusterCommands {
CompletableFuture<String> functionLoad(String libraryCode, boolean replace);

/**
* Loads a library to Redis.<br>
* Loads a library to Valkey.<br>
* The command will be routed to all primary nodes.
*
* @since Valkey 7.0 and above.
Expand All @@ -56,7 +56,7 @@ public interface ScriptingAndFunctionsClusterCommands {
CompletableFuture<GlideString> functionLoad(GlideString libraryCode, boolean replace);

/**
* Loads a library to Redis.
* Loads a library to Valkey.
*
* @since Valkey 7.0 and above.
* @see <a href="https://valkey.io/commands/function-load/">valkey.io</a> for details.
Expand All @@ -77,7 +77,7 @@ public interface ScriptingAndFunctionsClusterCommands {
CompletableFuture<String> functionLoad(String libraryCode, boolean replace, Route route);

/**
* Loads a library to Redis.
* Loads a library to Valkey.
*
* @since Valkey 7.0 and above.
* @see <a href="https://valkey.io/commands/function-load/">valkey.io</a> for details.
Expand Down Expand Up @@ -469,7 +469,7 @@ CompletableFuture<ClusterValue<Map<GlideString, Object>[]>> functionListBinary(
* @example
* <pre>{@code
* byte[] data = client.functionDump().get();
* // data can be used to restore loaded functions on any Redis instance
* // data can be used to restore loaded functions on any Valkey instance
* }</pre>
*/
CompletableFuture<byte[]> functionDump();
Expand All @@ -485,7 +485,7 @@ CompletableFuture<ClusterValue<Map<GlideString, Object>[]>> functionListBinary(
* @example
* <pre>{@code
* byte[] data = client.functionDump(RANDOM).get().getSingleValue();
* // data can be used to restore loaded functions on any Redis instance
* // data can be used to restore loaded functions on any Valkey instance
* }</pre>
*/
CompletableFuture<ClusterValue<byte[]>> functionDump(Route route);
Expand Down Expand Up @@ -935,7 +935,7 @@ CompletableFuture<ClusterValue<Object>> fcallReadOnly(
* The command will be routed to all primary nodes.
*
* @since Valkey 7.0 and above.
* @see <a href="https://redis.io/docs/latest/commands/function-stats/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/function-stats/">valkey.io</a> for details.
* @return A <code>Map</code> with two keys:
* <ul>
* <li><code>running_script</code> with information about the running script.
Expand Down Expand Up @@ -1001,7 +1001,7 @@ CompletableFuture<ClusterValue<Object>> fcallReadOnly(
* available execution engines.
*
* @since Valkey 7.0 and above.
* @see <a href="https://redis.io/docs/latest/commands/function-stats/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/function-stats/">valkey.io</a> for details.
* @param route Specifies the routing configuration for the command. The client will route the
* command to the nodes defined by <code>route</code>.
* @return A <code>Map</code> with two keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
* Supports commands and transactions for the "Scripting and Function" group for a standalone
* client.
*
* @see <a href="https://redis.io/commands/?group=scripting">Scripting and Function Commands</a>
* @see <a href="https://valkey.io/commands/?group=scripting">Scripting and Function Commands</a>
*/
public interface ScriptingAndFunctionsCommands {

/**
* Loads a library to Redis.
* Loads a library to Valkey.
*
* @since Valkey 7.0 and above.
* @see <a href="https://valkey.io/commands/function-load/">valkey.io</a> for details.
Expand All @@ -35,7 +35,7 @@ public interface ScriptingAndFunctionsCommands {
CompletableFuture<String> functionLoad(String libraryCode, boolean replace);

/**
* Loads a library to Redis.
* Loads a library to Valkey.
*
* @since Valkey 7.0 and above.
* @see <a href="https://valkey.io/commands/function-load/">valkey.io</a> for details.
Expand Down Expand Up @@ -224,7 +224,7 @@ CompletableFuture<Map<GlideString, Object>[]> functionListBinary(
* @example
* <pre>{@code
* byte[] data = client.functionDump().get();
* // now data could be saved to restore loaded functions on any Redis instance
* // now data could be saved to restore loaded functions on any Valkey instance
* }</pre>
*/
CompletableFuture<byte[]> functionDump();
Expand Down Expand Up @@ -377,7 +377,7 @@ CompletableFuture<Map<GlideString, Object>[]> functionListBinary(
* available execution engines.
*
* @since Valkey 7.0 and above.
* @see <a href="https://redis.io/docs/latest/commands/function-stats/">redis.io</a> for details.
* @see <a href="https://valkey.io/commands/function-stats/">valkey.io</a> for details.
* @return A <code>Map</code> with two keys:
* <ul>
* <li><code>running_script</code> with information about the running script.
Expand Down
Loading
Loading