Package com.datastax.astra.client.core.options

Class TimeoutOptions

java.lang.Object
com.datastax.astra.client.core.options.TimeoutOptions
All Implemented Interfaces:
Cloneable
public class TimeoutOptions extends Object implements Cloneable
This class is used to define the timeout options for the client.

  • Field Details

    • DEFAULT_CONNECT_TIMEOUT_MILLIS

      public static final long DEFAULT_CONNECT_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_REQUEST_TIMEOUT_MILLIS

      public static final long DEFAULT_REQUEST_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_GENERAL_METHOD_TIMEOUT_MILLIS

      public static final long DEFAULT_GENERAL_METHOD_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_COLLECTION_ADMIN_TIMEOUT_MILLIS

      public static final long DEFAULT_COLLECTION_ADMIN_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_TABLE_ADMIN_TIMEOUT_MILLIS

      public static final long DEFAULT_TABLE_ADMIN_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_DATABASE_ADMIN_TIMEOUT_MILLIS

      public static final long DEFAULT_DATABASE_ADMIN_TIMEOUT_MILLIS
      Default timeout values
      See Also:

    • DEFAULT_KEYSPACE_ADMIN_TIMEOUT_MILLIS

      public static final long DEFAULT_KEYSPACE_ADMIN_TIMEOUT_MILLIS
      Default timeout values
      See Also:

  • Constructor Details

    • TimeoutOptions

      public TimeoutOptions()
      Default constructor

  • Method Details

    • clone

      public TimeoutOptions clone()
      Overrides:
      clone in class Object

    • connectTimeout

      public TimeoutOptions connectTimeout(Duration timeout)
      Sets the connection timeout.
      Parameters:
      timeout - the connection timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • requestTimeout

      public TimeoutOptions requestTimeout(Duration timeout)
      Sets the request timeout.
      Parameters:
      timeout - the request timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • generalMethodTimeout

      public TimeoutOptions generalMethodTimeout(Duration timeout)
      Sets the general method timeout.
      Parameters:
      timeout - the timeout for general methods, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • databaseAdminTimeout

      public TimeoutOptions databaseAdminTimeout(Duration timeout)
      Sets the timeout for database administration operations.
      Parameters:
      timeout - the database admin timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • keyspaceAdminTimeout

      public TimeoutOptions keyspaceAdminTimeout(Duration timeout)
      Sets the timeout for keyspace administration operations.
      Parameters:
      timeout - the keyspace admin timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • collectionAdminTimeout

      public TimeoutOptions collectionAdminTimeout(Duration timeout)
      Sets the timeout for collection administration operations.
      Parameters:
      timeout - the collection admin timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • tableAdminTimeout

      public TimeoutOptions tableAdminTimeout(Duration timeout)
      Sets the timeout for table administration operations.
      Parameters:
      timeout - the table admin timeout, must not be null
      Returns:
      the current TimeoutOptions instance for method chaining
      Throws:
      IllegalArgumentException - if timeout is null

    • getConnectTimeoutMillis

      public long getConnectTimeoutMillis()
      Gets connectTimeoutMillis
      Returns:
      value of connectTimeoutMillis

    • getRequestTimeoutMillis

      public long getRequestTimeoutMillis()
      Gets requestTimeoutMillis
      Returns:
      value of requestTimeoutMillis

    • getGeneralMethodTimeoutMillis

      public long getGeneralMethodTimeoutMillis()
      Gets dataOperationTimeoutMillis
      Returns:
      value of dataOperationTimeoutMillis

    • getTableAdminTimeoutMillis

      public long getTableAdminTimeoutMillis()
      Gets schemaOperationTimeoutMillis
      Returns:
      value of schemaOperationTimeoutMillis

    • getDatabaseAdminTimeoutMillis

      public long getDatabaseAdminTimeoutMillis()
      Gets databaseAdminTimeoutMillis
      Returns:
      value of databaseAdminTimeoutMillis

    • getKeyspaceAdminTimeoutMillis

      public long getKeyspaceAdminTimeoutMillis()
      Gets keyspaceAdminTimeoutMillis
      Returns:
      value of keyspaceAdminTimeoutMillis

    • getCollectionAdminTimeoutMillis

      public long getCollectionAdminTimeoutMillis()
      Gets collectionAdminTimeoutMillis
      Returns:
      value of collectionAdminTimeoutMillis