Index (Oxia Java Client API)

A B C D E G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AsEphemeralRecord - Static variable in interface PutOption: Indicates that the record should be treated as ephemeral.
asyncClient() - Method in interface OxiaClientBuilder: Create an asynchronous client.
AsyncOxiaClient - Interface in io.oxia.client.api: Asynchronous client for the Oxia service.
authentication(Authentication) - Method in interface OxiaClientBuilder: Configure the authentication plugin and its parameters.
authentication(String, String) - Method in interface OxiaClientBuilder: Configure the authentication plugin and its parameters.
Authentication - Interface in io.oxia.client.api: Represents an interface for implementing authentication mechanisms.

B

batchLinger(Duration) - Method in interface OxiaClientBuilder: Specify the maximum time to wait for a batch to be sent.

C

clientIdentifier() - Method in record class Version: Returns the value of the clientIdentifier record component.
clientIdentifier(String) - Method in interface OxiaClientBuilder: Specify the client identifier for this client instance.
clientIdentifier(Supplier<String>) - Method in interface OxiaClientBuilder: Specify the client identifier for this client instance.
ComparisonCeiling - Static variable in interface GetOption: ComparisonCeiling option will make the get operation to search for the record whose key is the lowest key ≥ to the supplied key.
ComparisonEqual - Static variable in interface GetOption: ComparisonEqual sets the Get() operation to compare the stored key for equality.
ComparisonFloor - Static variable in interface GetOption: ComparisonFloor option will make the get operation to search for the record whose key is the highest key ≤ to the supplied key.
ComparisonHigher - Static variable in interface GetOption: ComparisonHigher option will make the get operation to search for the record whose key is strictly > to the supplied key.
ComparisonLower - Static variable in interface GetOption: ComparisonLower option will make the get operation to search for the record whose key is strictly < to the supplied key.
configure(String) - Method in interface Authentication: Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface.
connectionBackoff(Duration, Duration) - Method in interface OxiaClientBuilder: Configure the connection backoff policy.
connectionKeepAliveTime(Duration) - Method in interface OxiaClientBuilder: Configure the keep alive interval for the connection.
connectionKeepAliveTimeout(Duration) - Method in interface OxiaClientBuilder: Configure the keep alive timeout for the connection.
create(String) - Static method in interface OxiaClientBuilder: Create a new client builder.
createdTimestamp() - Method in record class Version: Returns the value of the createdTimestamp record component.

D

delete(String) - Method in interface AsyncOxiaClient: Unconditionally deletes the record associated with the key if the record exists.
delete(String) - Method in interface SyncOxiaClient: Unconditionally deletes the record associated with the key if the record exists.
delete(String, Set<DeleteOption>) - Method in interface AsyncOxiaClient: Conditionally deletes the record associated with the key if the record exists, and the server's versionId of the record is as specified, at the instant when the delete is applied.
delete(String, Set<DeleteOption>) - Method in interface SyncOxiaClient: Conditionally deletes the record associated with the key if the record exists, and the server's versionId of the record is as specified, at the instant when the delete is applied.
DeleteOption - Interface in io.oxia.client.api.options: Options for deleting a record.
deleteRange(String, String) - Method in interface AsyncOxiaClient: Deletes any records with keys within the specified range.
deleteRange(String, String) - Method in interface SyncOxiaClient: Deletes any records with keys within the specified range.
deleteRange(String, String, Set<DeleteRangeOption>) - Method in interface AsyncOxiaClient: Deletes any records with keys within the specified range.
deleteRange(String, String, Set<DeleteRangeOption>) - Method in interface SyncOxiaClient: Deletes any records with keys within the specified range.
DeleteRangeOption - Interface in io.oxia.client.api.options: Options for deleting a range of records.

E

enableTls(boolean) - Method in interface OxiaClientBuilder: Configures whether to enable TLS (Transport Layer Security) for the client connection.
endKeyExclusive() - Method in record class Notification.KeyRangeDelete: Returns the value of the endKeyExclusive record component.
equals(Object) - Method in record class GetResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class Notification.KeyCreated: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class Notification.KeyDeleted: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class Notification.KeyModified: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class Notification.KeyRangeDelete: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class PutResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class Version: Indicates whether some other object is "equal to" this one.
ExcludeValue - Static variable in interface GetOption: The specified value will be excluded from the result.

G

generateCredentials() - Method in interface Authentication: Generates a set of credentials represented as key-value pairs.
get(String) - Method in interface AsyncOxiaClient: Returns the record associated with the specified key.
get(String) - Method in interface SyncOxiaClient: Returns the record associated with the specified key.
get(String, Set<GetOption>) - Method in interface AsyncOxiaClient: Returns the record associated with the specified key.
get(String, Set<GetOption>) - Method in interface SyncOxiaClient: Returns the record associated with the specified key.
GetOption - Interface in io.oxia.client.api.options: Options for getting a record.
GetResult - Record Class in io.oxia.client.api: The result of a client get request.
GetResult(String, byte[], Version) - Constructor for record class GetResult: Creates an instance of a GetResult record class.
getSequenceUpdates(String, Consumer<String>, Set<GetSequenceUpdatesOption>) - Method in interface AsyncOxiaClient: GetSequenceUpdates allows to subscribe to the updates happening on a sequential key The channel will report the current latest sequence for a given key.
getSequenceUpdates(String, Consumer<String>, Set<GetSequenceUpdatesOption>) - Method in interface SyncOxiaClient: GetSequenceUpdates allows to subscribe to the updates happening on a sequential key The channel will report the current latest sequence for a given key.
GetSequenceUpdatesOption - Interface in io.oxia.client.api.options: Options for getting sequence updates.

H

hashCode() - Method in record class GetResult: Returns a hash code value for this object.
hashCode() - Method in record class Notification.KeyCreated: Returns a hash code value for this object.
hashCode() - Method in record class Notification.KeyDeleted: Returns a hash code value for this object.
hashCode() - Method in record class Notification.KeyModified: Returns a hash code value for this object.
hashCode() - Method in record class Notification.KeyRangeDelete: Returns a hash code value for this object.
hashCode() - Method in record class PutResult: Returns a hash code value for this object.
hashCode() - Method in record class Version: Returns a hash code value for this object.

I

IfRecordDoesNotExist - Static variable in interface PutOption: Specifies that the operation should only proceed if the record does not already exist.
IfVersionIdEquals(long) - Static method in interface DeleteOption: Conditional delete will only succeed if the record's version matches the supplied versionId.
IfVersionIdEquals(long) - Static method in interface PutOption: Only put the record if the versionId matches the current versionId.
IncludeValue - Static variable in interface GetOption: The specified value will be included in the result.
IncludeValue(boolean) - Static method in interface GetOption: Creates and returns a GetOption that specifies whether to include a value.
io.oxia.client.api - package io.oxia.client.api: The public API for interacting with Oxia.
io.oxia.client.api.exceptions - package io.oxia.client.api.exceptions: Defines the exceptions that can be thrown by the Oxia client.
io.oxia.client.api.options - package io.oxia.client.api.options: The definitions for options that can be passed to the Oxia client operations.
io.oxia.client.api.options.defs - package io.oxia.client.api.options.defs
io.oxia.client.internal - package io.oxia.client.internal

K

key() - Method in record class GetResult: Returns the value of the key record component.
key() - Method in interface Notification
key() - Method in record class Notification.KeyCreated: Returns the value of the key record component.
key() - Method in record class Notification.KeyDeleted: Returns the value of the key record component.
key() - Method in record class Notification.KeyModified: Returns the value of the key record component.
key() - Method in record class Notification.KeyRangeDelete
key() - Method in record class PutResult: Returns the value of the key record component.
KeyAlreadyExistsException - Exception in io.oxia.client.api.exceptions: The key already exists at the server.
KeyAlreadyExistsException(String) - Constructor for exception KeyAlreadyExistsException: Creates an instance of the exception.
KeyCreated(String, long) - Constructor for record class Notification.KeyCreated: Creates an instance of a KeyCreated record class.
KeyDeleted(String) - Constructor for record class Notification.KeyDeleted: Creates an instance of a KeyDeleted record class.
KeyModified(String, long) - Constructor for record class Notification.KeyModified: Creates an instance of a KeyModified record class.
KeyRangeDelete(String, String) - Constructor for record class Notification.KeyRangeDelete: Creates an instance of a KeyRangeDelete record class.

L

list(String, String) - Method in interface AsyncOxiaClient: Lists any existing keys within the specified range.
list(String, String) - Method in interface SyncOxiaClient: Lists any existing keys within the specified range.
list(String, String, Set<ListOption>) - Method in interface AsyncOxiaClient: Lists any existing keys within the specified range.
list(String, String, Set<ListOption>) - Method in interface SyncOxiaClient: Lists any existing keys within the specified range.
ListOption - Interface in io.oxia.client.api.options: Options for listing records.
loadConfig(File) - Method in interface OxiaClientBuilder: Load the configuration from the specified configuration file.
loadConfig(String) - Method in interface OxiaClientBuilder: Load the configuration from the specified configuration file.
loadConfig(Properties) - Method in interface OxiaClientBuilder: Load the configuration from the specified properties.

M

maxConnectionPerNode(int) - Method in interface OxiaClientBuilder: Configure the maximum number of connections to each Oxia server node.
maxRequestsPerBatch(int) - Method in interface OxiaClientBuilder: Specify the maximum number of requests to include in a batch.
modificationsCount() - Method in record class Version: Returns the value of the modificationsCount record component.
modifiedTimestamp() - Method in record class Version: Returns the value of the modifiedTimestamp record component.

N

namespace(String) - Method in interface OxiaClientBuilder: Specify the Oxia namesace to use for this client instance.
Notification - Interface in io.oxia.client.api: A notification from an Oxia server indicating a change to a record associated with a key.
Notification.KeyCreated - Record Class in io.oxia.client.api: A record associated with the key has been created.
Notification.KeyDeleted - Record Class in io.oxia.client.api: The record associated with the key has been deleted.
Notification.KeyModified - Record Class in io.oxia.client.api: The record associated with the key has been modified (updated).
Notification.KeyRangeDelete - Record Class in io.oxia.client.api: The record associated with the key range has been deleted.
notifications(Consumer<Notification>) - Method in interface AsyncOxiaClient: Registers a callback to receive Oxia record change notifications.
notifications(Consumer<Notification>) - Method in interface SyncOxiaClient: Registers a callback to receive Oxia record change notifications.

O

onCompleted() - Method in interface RangeScanConsumer: Invoked when the range scan operation completes.
onError(Throwable) - Method in interface RangeScanConsumer: Invoked when an error occurs during the range scan operation.
onNext(GetResult) - Method in interface RangeScanConsumer: Invoked for each record returned by the range scan operation.
openTelemetry(OpenTelemetry) - Method in interface OxiaClientBuilder: Specify the OpenTelemetry instance to use for this client instance.
OxiaClientBuilder - Interface in io.oxia.client.api: Builder for SyncOxiaClient and AsyncOxiaClient.
OxiaException - Exception in io.oxia.client.api.exceptions: A super-class of exceptions describing errors that occurred on an Oxia server.

P

PartitionKey(String) - Static method in interface DeleteOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface DeleteRangeOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface GetOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface GetSequenceUpdatesOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface ListOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface PutOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
PartitionKey(String) - Static method in interface RangeScanOption: PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.
put(String, byte[]) - Method in interface AsyncOxiaClient: Conditionally associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied.
put(String, byte[]) - Method in interface SyncOxiaClient: Associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied.
put(String, byte[], Set<PutOption>) - Method in interface AsyncOxiaClient: Conditionally associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied.
put(String, byte[], Set<PutOption>) - Method in interface SyncOxiaClient: Conditionally associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied.
PutOption - Interface in io.oxia.client.api.options: The PutOption interface defines a set of options for customizing the behavior of a "put" operation in a data store.
PutResult - Record Class in io.oxia.client.api: The result of a client get request.
PutResult(String, Version) - Constructor for record class PutResult: Creates an instance of a PutResult record class.

R

rangeScan(String, String) - Method in interface SyncOxiaClient: Scan any existing records within the specified range of keys.
rangeScan(String, String, RangeScanConsumer) - Method in interface AsyncOxiaClient: Scan any existing records within the specified range of keys.
rangeScan(String, String, RangeScanConsumer, Set<RangeScanOption>) - Method in interface AsyncOxiaClient: Scan any existing records within the specified range of keys.
rangeScan(String, String, Set<RangeScanOption>) - Method in interface SyncOxiaClient: Scan any existing records within the specified range of keys.
RangeScanConsumer - Interface in io.oxia.client.api: Interface defining a consumer for Range Scan operations, allowing handling of chunked results, errors, or completion signals for a range scan process.
RangeScanOption - Interface in io.oxia.client.api.options: RangeScanOption is a sealed interface that represents options for controlling range scan operations.
requestTimeout(Duration) - Method in interface OxiaClientBuilder: Specify a custom timeout for all requests.

S

SecondaryIndex(String, String) - Static method in interface PutOption: SecondaryIndex let the users specify additional keys to index the record Index names are arbitrary strings and can be used in SyncOxiaClient.list(String, String, Set) and SyncOxiaClient.rangeScan(String, String, Set) requests.
SequenceKeysDeltas(List<Long>) - Static method in interface PutOption: SequenceKeysDeltas will request that the final record key to be assigned by the server, based on the prefix record key and appending one or more sequences.
SessionDoesNotExistException - Exception in io.oxia.client.api.exceptions: The session does not exist on the server.
SessionDoesNotExistException() - Constructor for exception SessionDoesNotExistException: Creates an instance of the exception.
sessionId() - Method in record class Version: Returns the value of the sessionId record component.
sessionTimeout(Duration) - Method in interface OxiaClientBuilder: Specify the session timeout for this client instance.
startKeyInclusive() - Method in record class Notification.KeyRangeDelete: Returns the value of the startKeyInclusive record component.
syncClient() - Method in interface OxiaClientBuilder: Create a synchronous client.
SyncOxiaClient - Interface in io.oxia.client.api: Synchronous client for the Oxia service.

T

toString() - Method in record class GetResult: Returns a string representation of this record class.
toString() - Method in record class Notification.KeyCreated: Returns a string representation of this record class.
toString() - Method in record class Notification.KeyDeleted: Returns a string representation of this record class.
toString() - Method in record class Notification.KeyModified: Returns a string representation of this record class.
toString() - Method in record class Notification.KeyRangeDelete: Returns a string representation of this record class.
toString() - Method in record class PutResult: Returns a string representation of this record class.
toString() - Method in record class Version: Returns a string representation of this record class.

U

UnexpectedVersionIdException - Exception in io.oxia.client.api.exceptions: The versionId at the server did not that match supplied in the call.
UnexpectedVersionIdException(String, long) - Constructor for exception UnexpectedVersionIdException: Creates an instance of the exception.
UnsupportedAuthenticationException - Exception in io.oxia.client.api.exceptions: Unsupported authentication exception thrown by Oxia client.
UnsupportedAuthenticationException(String) - Constructor for exception UnsupportedAuthenticationException: Constructs an UnsupportedAuthenticationException with the specified detail message.
UnsupportedAuthenticationException(String, Throwable) - Constructor for exception UnsupportedAuthenticationException: Constructs an UnsupportedAuthenticationException with the specified detail message and cause.
UseIndex(String) - Static method in interface GetOption: UseIndex let the users specify a different index to follow for the list operation
UseIndex(String) - Static method in interface ListOption: UseIndex let the users specify a different index to follow for the list operation
UseIndex(String) - Static method in interface RangeScanOption: UseIndex let the users specify a different index to follow for the range scan operation

V

value() - Method in record class GetResult: Returns the value of the value record component.
version() - Method in record class GetResult: Returns the value of the version record component.
version() - Method in record class Notification.KeyCreated: Returns the value of the version record component.
version() - Method in record class Notification.KeyModified: Returns the value of the version record component.
version() - Method in record class PutResult: Returns the value of the version record component.
Version - Record Class in io.oxia.client.api: Oxia record metadata.
Version(long, long, long, long, Optional<Long>, Optional<String>) - Constructor for record class Version: Creates an instance of a Version record class.
versionId() - Method in record class Version: Returns the value of the versionId record component.

A B C D E G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form