Package com.datastax.astra.client.admin

Class AdminOptions

java.lang.Object

com.datastax.astra.client.core.options.BaseOptions<AdminOptions>

com.datastax.astra.client.admin.AdminOptions

All Implemented Interfaces:

Cloneable

public class AdminOptions
extends BaseOptions<AdminOptions>

Represents the configuration options for administrative operations in the database API. This class extends BaseOptions to inherit common configuration options and provides additional functionality specific to administrative commands.

Example usage:

 
 AdminOptions options = new AdminOptions()
     .token("your-token-here")
     .options(new DataAPIClientOptions())
     .serializer(new CustomSerializer());
 
 

Key Features:

• Provides default serialization through DatabaseSerializer.
• Fluent and chainable setter methods for seamless configuration.
• Supports administrative command types via CommandType.DATABASE_ADMIN.

Field Summary

Fields inherited from class com.datastax.astra.client.core.options.BaseOptions

commandType, dataAPIClientOptions, serializer, token

Constructor Summary

Constructors

Constructor	Description
AdminOptions()	Serializer for the collections.
AdminOptions(String token, DataAPIClientOptions options)	Constructs an AdminOptions instance with the specified token and options.

Method Summary

Methods inherited from class com.datastax.astra.client.core.options.BaseOptions

adminAdditionalHeaders, clone, commandType, dataAPIClientOptions, databaseAdditionalHeaders, embeddingApiKey, embeddingAuthProvider, getCommandType, getDataAPIClientOptions, getRequestTimeout, getRequestTimeout, getSerializer, getTimeout, getTimeout, getToken, httpClientOptions, registerObserver, serializer, timeout, timeout, timeout, timeoutOptions, token, toString, unregisterObserver

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AdminOptions

public AdminOptions()

Serializer for the collections. Defaults to DatabaseSerializer.

AdminOptions

public AdminOptions(String token,
 DataAPIClientOptions options)

Constructs an AdminOptions instance with the specified token and options.

Parameters:

token - the authentication token to use.

options - additional configuration options for the Data API client.