java.lang.Object
- com.relationalai.Client

```
public class Client
extends Object
```

Field Summary

Fields
Modifier and Type	Field	Description
`Credentials`	`credentials`
`static String`	`DEFAULT_HOST`
`static int`	`DEFAULT_PORT`
`static String`	`DEFAULT_REGION`
`static String`	`DEFAULT_SCHEME`
`String`	`host`
`int`	`port`
`String`	`region`
`String`	`scheme`

Constructor Summary

Constructors
Constructor Description

Client()

Client(Config cfg)

Client(Config cfg, org.slf4j.Logger logger)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TransactionAsyncCancelResponse`	`cancelTransaction(String id)`
`Database`	`cloneDatabase(String database, String engine, String source)`
`Database`	`cloneDatabase(String database, String engine, String source, boolean overwrite)`
`Database`	`createDatabase(String database, String engine)`
`Database`	`createDatabase(String database, String engine, boolean overwrite)`
`Engine`	`createEngine(String engine)`
`Engine`	`createEngine(String engine, String size)`
`Engine`	`createEngineWait(String engine)`
`Engine`	`createEngineWait(String engine, String size)`
`OAuthClientExtra`	`createOAuthClient(String name)`
`OAuthClientExtra`	`createOAuthClient(String name, String[] permissions)`
`User`	`createUser(String email)`
`User`	`createUser(String email, String[] roles)`
`Object`	`delete(String path)`
`Object`	`delete(String path, QueryParams params, String body)`
`DeleteDatabaseResponse`	`deleteDatabase(String database)`
`Engine`	`deleteEngine(String engine)`
`Engine`	`deleteEngineWait(String engine)`
`TransactionResult`	`deleteModel(String database, String engine, String name)`
`TransactionResult`	`deleteModel(String database, String engine, String[] names)`
`DeleteOAuthClientResponse`	`deleteOAuthClient(String id)`
`DeleteUserResponse`	`deleteUser(String id)`
`User`	`disableUser(String id)`
`User`	`enableUser(String id)`
`TransactionAsyncResult`	`execute(String database, String engine, String source, boolean readonly)`
`TransactionAsyncResult`	`execute(String database, String engine, String source, boolean readonly, Map<String,String> inputs)`
`TransactionAsyncResult`	`executeAsync(String database, String engine, String source, boolean readonly)`
`TransactionAsyncResult`	`executeAsync(String database, String engine, String source, boolean readonly, Map<String,String> inputs)`
`TransactionResult`	`executeV1(String database, String engine, String source)`
`TransactionResult`	`executeV1(String database, String engine, String source, boolean readonly)`
`TransactionResult`	`executeV1(String database, String engine, String source, boolean readonly, Map<String,String> inputs)`
`AccessToken`	`fetchAccessToken(ClientCredentials credentials)`
`OAuthClient`	`findOAuthClient(String name)`
`User`	`findUser(String email)`
`Object`	`get(String path)`
`Object`	`get(String path, QueryParams params)`
`Object`	`get(String path, Map<String,String> headers)`
`Object`	`get(String path, Map<String,String> headers, QueryParams params)`
`AccessToken`	`getAccessToken(ClientCredentials credentials)`
`Database`	`getDatabase(String database)`
`Map<String,String>`	`getDefaultHttpHeaders()`
`Engine`	`getEngine(String engine)`
`HttpClient`	`getHttpClient()`
`com.relationalai.Model`	`getModel(String database, String engine, String name)`
`OAuthClientExtra`	`getOAuthClient(String id)`
`TransactionAsyncSingleResponse`	`getTransaction(String id)`
`Message.MetadataInfo`	`getTransactionMetadata(String id)`
`List<Object>`	`getTransactionProblems(String id)`
`List<ArrowRelation>`	`getTransactionResults(String id)`
`TransactionsAsyncMultipleResponses`	`getTransactions()`
`User`	`getUser(String id)`
`Database[]`	`listDatabases()`
`Database[]`	`listDatabases(String state)`
`Edb[]`	`listEdbs(String database, String engine)`
`Engine[]`	`listEngines()`
`Engine[]`	`listEngines(String state)`
`String[]`	`listModelNames(String database, String engine)`
`com.relationalai.Model[]`	`listModels(String database, String engine)`
`OAuthClient[]`	`listOAuthClients()`
`User[]`	`listUsers()`
`TransactionResult`	`loadCsv(String database, String engine, String relation, InputStream data)`
`TransactionResult`	`loadCsv(String database, String engine, String relation, InputStream data, CsvOptions options)`
`TransactionResult`	`loadCsv(String database, String engine, String relation, String data)`
`TransactionResult`	`loadCsv(String database, String engine, String relation, String data, CsvOptions options)`
`TransactionResult`	`loadJson(String database, String engine, String relation, InputStream data)`
`TransactionResult`	`loadJson(String database, String engine, String relation, String data)`
`TransactionResult`	`loadModel(String database, String engine, String name, InputStream model)`
`TransactionResult`	`loadModel(String database, String engine, String name, String model)`
`TransactionResult`	`loadModels(String database, String engine, Map<String,String> models)`
`Object`	`patch(String path, QueryParams params, String body)`
`Object`	`post(String path, QueryParams params, String body)`
`Object`	`put(String path, QueryParams params, String body)`
`Object`	`request(String method, String path, QueryParams params)`
`Object`	`request(String method, String path, Map<String,String> headers, QueryParams params, String body)`
`void`	`setAccessTokenHandler(AccessTokenHandler handler)`
`Client`	`setHttpClient(HttpClient httpClient)`
`User`	`updateUser(String id, UpdateUserRequest req)`
`User`	`updateUser(String id, String status)`
`User`	`updateUser(String id, String[] roles)`
`User`	`updateUser(String id, String status, String[] roles)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REGION

public static final String DEFAULT_REGION

See Also:: Constant Field Values

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

See Also:: Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:: Constant Field Values

DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
See Also:

Constant Field Values

region
```
public String region
```

scheme
```
public String scheme
```

host
```
public String host
```

port
```
public int port
```

credentials
```
public Credentials credentials
```

Constructor Detail

Client
```
public Client()
```

Client
```
public Client(Config cfg)
```

Client

public Client(Config cfg,
              org.slf4j.Logger logger)

Method Detail

getHttpClient
```
public HttpClient getHttpClient()
```

setHttpClient

public Client setHttpClient(HttpClient httpClient)

getDefaultHttpHeaders

public Map<String,String> getDefaultHttpHeaders()

setAccessTokenHandler

public void setAccessTokenHandler(AccessTokenHandler handler)

fetchAccessToken

public AccessToken fetchAccessToken(ClientCredentials credentials)
                             throws HttpError,
                                    InterruptedException,
                                    IOException

Throws:: HttpError; InterruptedException; IOException

getAccessToken

public AccessToken getAccessToken(ClientCredentials credentials)
                           throws HttpError,
                                  InterruptedException,
                                  IOException

Throws:: HttpError; InterruptedException; IOException

request

public Object request(String method,
                      String path,
                      QueryParams params)
               throws HttpError,
                      InterruptedException,
                      IOException

Throws:: HttpError; InterruptedException; IOException

request

public Object request(String method,
                      String path,
                      Map<String,String> headers,
                      QueryParams params,
                      String body)
               throws HttpError,
                      InterruptedException,
                      IOException

Throws:: HttpError; InterruptedException; IOException

delete

public Object delete(String path)
              throws HttpError,
                     InterruptedException,
                     IOException

Throws:: HttpError; InterruptedException; IOException

delete

public Object delete(String path,
                     QueryParams params,
                     String body)
              throws HttpError,
                     InterruptedException,
                     IOException

Throws:: HttpError; InterruptedException; IOException

get

public Object get(String path)
           throws HttpError,
                  InterruptedException,
                  IOException

Throws:: HttpError; InterruptedException; IOException

get

public Object get(String path,
                  QueryParams params)
           throws HttpError,
                  IOException,
                  InterruptedException

Throws:: HttpError; IOException; InterruptedException

get

public Object get(String path,
                  Map<String,String> headers)
           throws HttpError,
                  IOException,
                  InterruptedException

Throws:: HttpError; IOException; InterruptedException

get

public Object get(String path,
                  Map<String,String> headers,
                  QueryParams params)
           throws HttpError,
                  InterruptedException,
                  IOException

Throws:: HttpError; InterruptedException; IOException

patch

public Object patch(String path,
                    QueryParams params,
                    String body)
             throws HttpError,
                    InterruptedException,
                    IOException

Throws:: HttpError; InterruptedException; IOException

post

public Object post(String path,
                   QueryParams params,
                   String body)
            throws HttpError,
                   InterruptedException,
                   IOException

Throws:: HttpError; InterruptedException; IOException

put

public Object put(String path,
                  QueryParams params,
                  String body)
           throws HttpError,
                  InterruptedException,
                  IOException

Throws:: HttpError; InterruptedException; IOException

createDatabase

public Database createDatabase(String database,
                               String engine)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

createDatabase

public Database createDatabase(String database,
                               String engine,
                               boolean overwrite)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

cloneDatabase

public Database cloneDatabase(String database,
                              String engine,
                              String source)
                       throws HttpError,
                              InterruptedException,
                              IOException

Throws:: HttpError; InterruptedException; IOException

cloneDatabase

public Database cloneDatabase(String database,
                              String engine,
                              String source,
                              boolean overwrite)
                       throws HttpError,
                              InterruptedException,
                              IOException

Throws:: HttpError; InterruptedException; IOException

deleteDatabase

public DeleteDatabaseResponse deleteDatabase(String database)
                                      throws HttpError,
                                             InterruptedException,
                                             IOException

Throws:: HttpError; InterruptedException; IOException

getDatabase

public Database getDatabase(String database)
                     throws HttpError,
                            InterruptedException,
                            IOException

Throws:: HttpError; InterruptedException; IOException

listDatabases

public Database[] listDatabases()
                         throws HttpError,
                                InterruptedException,
                                IOException

Throws:: HttpError; InterruptedException; IOException

listDatabases

public Database[] listDatabases(String state)
                         throws HttpError,
                                InterruptedException,
                                IOException

Throws:: HttpError; InterruptedException; IOException

createEngine

public Engine createEngine(String engine)
                    throws HttpError,
                           InterruptedException,
                           IOException

Throws:: HttpError; InterruptedException; IOException

createEngine

public Engine createEngine(String engine,
                           String size)
                    throws HttpError,
                           InterruptedException,
                           IOException

Throws:: HttpError; InterruptedException; IOException

createEngineWait

public Engine createEngineWait(String engine)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

createEngineWait

public Engine createEngineWait(String engine,
                               String size)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

deleteEngine

public Engine deleteEngine(String engine)
                    throws HttpError,
                           InterruptedException,
                           IOException

Throws:: HttpError; InterruptedException; IOException

deleteEngineWait

public Engine deleteEngineWait(String engine)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

getEngine

public Engine getEngine(String engine)
                 throws HttpError,
                        InterruptedException,
                        IOException

Throws:: HttpError; InterruptedException; IOException

listEngines

public Engine[] listEngines()
                     throws HttpError,
                            InterruptedException,
                            IOException

Throws:: HttpError; InterruptedException; IOException

listEngines

public Engine[] listEngines(String state)
                     throws HttpError,
                            InterruptedException,
                            IOException

Throws:: HttpError; InterruptedException; IOException

createOAuthClient

public OAuthClientExtra createOAuthClient(String name)
                                   throws HttpError,
                                          InterruptedException,
                                          IOException

Throws:: HttpError; InterruptedException; IOException

createOAuthClient

public OAuthClientExtra createOAuthClient(String name,
                                          String[] permissions)
                                   throws HttpError,
                                          InterruptedException,
                                          IOException

Throws:: HttpError; InterruptedException; IOException

deleteOAuthClient

public DeleteOAuthClientResponse deleteOAuthClient(String id)
                                            throws HttpError,
                                                   InterruptedException,
                                                   IOException

Throws:: HttpError; InterruptedException; IOException

findOAuthClient

public OAuthClient findOAuthClient(String name)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

getOAuthClient

public OAuthClientExtra getOAuthClient(String id)
                                throws HttpError,
                                       InterruptedException,
                                       IOException

Throws:: HttpError; InterruptedException; IOException

listOAuthClients

public OAuthClient[] listOAuthClients()
                               throws HttpError,
                                      InterruptedException,
                                      IOException

Throws:: HttpError; InterruptedException; IOException

createUser

public User createUser(String email)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

createUser

public User createUser(String email,
                       String[] roles)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

deleteUser

public DeleteUserResponse deleteUser(String id)
                              throws HttpError,
                                     InterruptedException,
                                     IOException

Throws:: HttpError; InterruptedException; IOException

disableUser

public User disableUser(String id)
                 throws HttpError,
                        InterruptedException,
                        IOException

Throws:: HttpError; InterruptedException; IOException

enableUser

public User enableUser(String id)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

findUser

public User findUser(String email)
              throws HttpError,
                     InterruptedException,
                     IOException

Throws:: HttpError; InterruptedException; IOException

getUser

public User getUser(String id)
             throws HttpError,
                    InterruptedException,
                    IOException

Throws:: HttpError; InterruptedException; IOException

listUsers

public User[] listUsers()
                 throws HttpError,
                        InterruptedException,
                        IOException

Throws:: HttpError; InterruptedException; IOException

updateUser

public User updateUser(String id,
                       String status)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

updateUser

public User updateUser(String id,
                       String[] roles)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

updateUser

public User updateUser(String id,
                       String status,
                       String[] roles)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

updateUser

public User updateUser(String id,
                       UpdateUserRequest req)
                throws HttpError,
                       InterruptedException,
                       IOException

Throws:: HttpError; InterruptedException; IOException

executeV1

public TransactionResult executeV1(String database,
                                   String engine,
                                   String source)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

executeV1

public TransactionResult executeV1(String database,
                                   String engine,
                                   String source,
                                   boolean readonly)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

executeV1

public TransactionResult executeV1(String database,
                                   String engine,
                                   String source,
                                   boolean readonly,
                                   Map<String,String> inputs)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

execute

public TransactionAsyncResult execute(String database,
                                      String engine,
                                      String source,
                                      boolean readonly)
                               throws HttpError,
                                      IOException,
                                      InterruptedException

Throws:: HttpError; IOException; InterruptedException

execute

public TransactionAsyncResult execute(String database,
                                      String engine,
                                      String source,
                                      boolean readonly,
                                      Map<String,String> inputs)
                               throws HttpError,
                                      IOException,
                                      InterruptedException

Throws:: HttpError; IOException; InterruptedException

executeAsync

public TransactionAsyncResult executeAsync(String database,
                                           String engine,
                                           String source,
                                           boolean readonly)
                                    throws HttpError,
                                           IOException,
                                           InterruptedException

Throws:: HttpError; IOException; InterruptedException

executeAsync

public TransactionAsyncResult executeAsync(String database,
                                           String engine,
                                           String source,
                                           boolean readonly,
                                           Map<String,String> inputs)
                                    throws HttpError,
                                           IOException,
                                           InterruptedException

Throws:: HttpError; IOException; InterruptedException

getTransaction

public TransactionAsyncSingleResponse getTransaction(String id)
                                              throws HttpError,
                                                     IOException,
                                                     InterruptedException

Throws:: HttpError; IOException; InterruptedException

getTransactions

public TransactionsAsyncMultipleResponses getTransactions()
                                                   throws HttpError,
                                                          IOException,
                                                          InterruptedException

Throws:: HttpError; IOException; InterruptedException

getTransactionResults

public List<ArrowRelation> getTransactionResults(String id)
                                          throws HttpError,
                                                 IOException,
                                                 InterruptedException

Throws:: HttpError; IOException; InterruptedException

getTransactionMetadata

public Message.MetadataInfo getTransactionMetadata(String id)
                                            throws HttpError,
                                                   IOException,
                                                   InterruptedException

Throws:: HttpError; IOException; InterruptedException

getTransactionProblems

public List<Object> getTransactionProblems(String id)
                                    throws HttpError,
                                           IOException,
                                           InterruptedException

Throws:: HttpError; IOException; InterruptedException

cancelTransaction

public TransactionAsyncCancelResponse cancelTransaction(String id)
                                                 throws HttpError,
                                                        IOException,
                                                        InterruptedException

Throws:: HttpError; IOException; InterruptedException

listEdbs

public Edb[] listEdbs(String database,
                      String engine)
               throws HttpError,
                      InterruptedException,
                      IOException

Throws:: HttpError; InterruptedException; IOException

deleteModel

public TransactionResult deleteModel(String database,
                                     String engine,
                                     String name)
                              throws HttpError,
                                     InterruptedException,
                                     IOException

Throws:: HttpError; InterruptedException; IOException

deleteModel

public TransactionResult deleteModel(String database,
                                     String engine,
                                     String[] names)
                              throws HttpError,
                                     InterruptedException,
                                     IOException

Throws:: HttpError; InterruptedException; IOException

getModel

public com.relationalai.Model getModel(String database,
                                       String engine,
                                       String name)
                                throws HttpError,
                                       InterruptedException,
                                       IOException

Throws:: HttpError; InterruptedException; IOException

loadModel

public TransactionResult loadModel(String database,
                                   String engine,
                                   String name,
                                   InputStream model)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

loadModel

public TransactionResult loadModel(String database,
                                   String engine,
                                   String name,
                                   String model)
                            throws HttpError,
                                   InterruptedException,
                                   IOException

Throws:: HttpError; InterruptedException; IOException

loadModels

public TransactionResult loadModels(String database,
                                    String engine,
                                    Map<String,String> models)
                             throws HttpError,
                                    InterruptedException,
                                    IOException

Throws:: HttpError; InterruptedException; IOException

listModelNames

public String[] listModelNames(String database,
                               String engine)
                        throws HttpError,
                               InterruptedException,
                               IOException

Throws:: HttpError; InterruptedException; IOException

listModels

public com.relationalai.Model[] listModels(String database,
                                           String engine)
                                    throws HttpError,
                                           InterruptedException,
                                           IOException

Throws:: HttpError; InterruptedException; IOException

loadCsv

public TransactionResult loadCsv(String database,
                                 String engine,
                                 String relation,
                                 InputStream data)
                          throws HttpError,
                                 InterruptedException,
                                 IOException

Throws:: HttpError; InterruptedException; IOException

loadCsv

public TransactionResult loadCsv(String database,
                                 String engine,
                                 String relation,
                                 String data)
                          throws HttpError,
                                 InterruptedException,
                                 IOException

Throws:: HttpError; InterruptedException; IOException

loadCsv

public TransactionResult loadCsv(String database,
                                 String engine,
                                 String relation,
                                 InputStream data,
                                 CsvOptions options)
                          throws HttpError,
                                 InterruptedException,
                                 IOException

Throws:: HttpError; InterruptedException; IOException

loadCsv

public TransactionResult loadCsv(String database,
                                 String engine,
                                 String relation,
                                 String data,
                                 CsvOptions options)
                          throws HttpError,
                                 InterruptedException,
                                 IOException

Throws:: HttpError; InterruptedException; IOException

loadJson

public TransactionResult loadJson(String database,
                                  String engine,
                                  String relation,
                                  InputStream data)
                           throws HttpError,
                                  InterruptedException,
                                  IOException

Throws:: HttpError; InterruptedException; IOException

loadJson

public TransactionResult loadJson(String database,
                                  String engine,
                                  String relation,
                                  String data)
                           throws HttpError,
                                  InterruptedException,
                                  IOException

Throws:: HttpError; InterruptedException; IOException

Constructor	Description
`Client()`
`Client(Config cfg)`
`Client(Config cfg, org.slf4j.Logger logger)`

Class Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_REGION

DEFAULT_SCHEME

DEFAULT_HOST

DEFAULT_PORT

region

scheme

host

port

credentials

Constructor Detail

Client

Client

Client

Method Detail

getHttpClient

setHttpClient

getDefaultHttpHeaders

setAccessTokenHandler

fetchAccessToken

getAccessToken

request

request

delete

delete

get

get

get

get

patch

post

put

createDatabase

createDatabase

cloneDatabase

cloneDatabase

deleteDatabase

getDatabase

listDatabases

listDatabases

createEngine

createEngine

createEngineWait

createEngineWait

deleteEngine

deleteEngineWait

getEngine

listEngines

listEngines

createOAuthClient

createOAuthClient

deleteOAuthClient

findOAuthClient

getOAuthClient

listOAuthClients

createUser

createUser

deleteUser

disableUser

enableUser

findUser

getUser

listUsers

updateUser

updateUser

updateUser

updateUser

executeV1

executeV1

executeV1

execute

execute

executeAsync

executeAsync

getTransaction