GoodData (gooddata-java 0.23.0 API)

java.lang.Object
- com.gooddata.GoodData

```
public class GoodData
extends Object
```
Entry point for GoodData SDK usage.
Configure connection to GoodData using one of constructors. One can then get initialized service he needs from the newly constructed instance. This instance can be also used later for logout from GoodData Platform.
Usage example:
```
     GoodData gd = new GoodData("roman@gooddata.com", "Roman1");
     // do something useful like: gd.getSomeService().doSomething()
     gd.logout();
 
```

Field Summary

Fields
Modifier and Type Field and Description

static String GDC_REQUEST_ID_HEADER

protected static String HOSTNAME

protected static int PORT

protected static String PROTOCOL

Fields
Modifier and Type	Field and Description
`static String`	`GDC_REQUEST_ID_HEADER`
`protected static String`	`HOSTNAME`
`protected static int`	`PORT`
`protected static String`	`PROTOCOL`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GoodData(String login, String password)` Create instance configured to communicate with GoodData Platform under user with given credentials.
	`GoodData(String login, String password, GoodDataSettings settings)` Create instance configured to communicate with GoodData Platform under user with given credentials.
	`GoodData(String hostname, String login, String password)` Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
	`GoodData(String hostname, String login, String password, GoodDataSettings settings)` Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
	`GoodData(String hostname, String login, String password, int port)` Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
	`GoodData(String hostname, String login, String password, int port, GoodDataSettings settings)` Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
`protected`	`GoodData(String hostname, String login, String password, int port, String protocol, GoodDataSettings settings)` Create instance configured to communicate with GoodData Platform running on given host, port and protocol using given user's credentials.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.http.client.HttpClient`	`createHttpClient(String login, String password, String hostname, int port, String protocol, org.apache.http.impl.client.HttpClientBuilder builder)`
`AccountService`	`getAccountService()` Get initialized service for account management (to get current account information, logout, ...)
`ConnectorService`	`getConnectorService()` Get initialized service for connector integration management (create, update, start process, ...).
`DatasetService`	`getDatasetService()` Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)
`DataStoreService`	`getDataStoreService()` Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)
`GdcService`	`getGdcService()` Get initialized service for API root management (to get API root links, ...)
`MetadataService`	`getMetadataService()` Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)
`ModelService`	`getModelService()` Get initialized service for model management (to get model diff, update model, ...)
`ProcessService`	`getProcessService()` Get initialized service for dataload processes management and process executions.
`ProjectService`	`getProjectService()` Get initialized service for project management (to list projects, create a project, ...)
`ReportService`	`getReportService()` Get initialized service for report management (to execute and export report, ...)
`protected org.springframework.web.client.RestTemplate`	`getRestTemplate()` Get the configured `RestTemplate` used by the library.
`WarehouseService`	`getWarehouseService()` Get initialized service for ADS management (create, access and delete ads instances).
`void`	`logout()` Logout from GoodData Platform

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

- Field Detail
  - GDC_REQUEST_ID_HEADER
```
public static final String GDC_REQUEST_ID_HEADER
```
    See Also:
    
    Constant Field Values
  - PROTOCOL
```
protected static final String PROTOCOL
```
    See Also:
    
    Constant Field Values
  - PORT
```
protected static final int PORT
```
    See Also:
    
    Constant Field Values
  - HOSTNAME
```
protected static final String HOSTNAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GoodData
```
public GoodData(String login,
                String password)
```
    Create instance configured to communicate with GoodData Platform under user with given credentials.
    
    Parameters:
    
    login - GoodData user's login
    
    password - GoodData user's password
  - GoodData
```
public GoodData(String login,
                String password,
                GoodDataSettings settings)
```
    Create instance configured to communicate with GoodData Platform under user with given credentials.
    
    Parameters:
    
    login - GoodData user's login
    
    password - GoodData user's password
    
    settings - additional settings
  - GoodData
```
public GoodData(String hostname,
                String login,
                String password)
```
    Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
    
    Parameters:
    
    hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
    
    login - GoodData user's login
    
    password - GoodData user's password
  - GoodData
```
public GoodData(String hostname,
                String login,
                String password,
                GoodDataSettings settings)
```
    Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
    
    Parameters:
    
    hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
    
    login - GoodData user's login
    
    password - GoodData user's password
    
    settings - additional settings
  - GoodData
```
public GoodData(String hostname,
                String login,
                String password,
                int port)
```
    Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
    
    Parameters:
    
    hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
    
    login - GoodData user's login
    
    password - GoodData user's password
    
    port - GoodData Platform's API port (e.g. 443)
  - GoodData
```
public GoodData(String hostname,
                String login,
                String password,
                int port,
                GoodDataSettings settings)
```
    Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
    
    Parameters:
    
    hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
    
    login - GoodData user's login
    
    password - GoodData user's password
    
    port - GoodData Platform's API port (e.g. 443)
    
    settings - additional settings
  - GoodData
```
protected GoodData(String hostname,
                   String login,
                   String password,
                   int port,
                   String protocol,
                   GoodDataSettings settings)
```
    Create instance configured to communicate with GoodData Platform running on given host, port and protocol using given user's credentials.
    
    Parameters:
    
    hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
    
    login - GoodData user's login
    
    password - GoodData user's password
    
    port - GoodData Platform's API port (e.g. 443)
    
    protocol - GoodData Platform's API protocol (e.g. https)
    
    settings - additional settings
- Method Detail
  - createHttpClient
```
protected org.apache.http.client.HttpClient createHttpClient(String login,
                                                             String password,
                                                             String hostname,
                                                             int port,
                                                             String protocol,
                                                             org.apache.http.impl.client.HttpClientBuilder builder)
```
  - getRestTemplate
```
protected final org.springframework.web.client.RestTemplate getRestTemplate()
```
    Get the configured RestTemplate used by the library. This is the extension point for inheriting classes providing additional services.
    
    Returns:
    
    REST template
  - logout
```
public void logout()
```
    Logout from GoodData Platform
  - getProjectService
```
public ProjectService getProjectService()
```
    Get initialized service for project management (to list projects, create a project, ...)
    
    Returns:
    
    initialized service for project management
  - getAccountService
```
public AccountService getAccountService()
```
    Get initialized service for account management (to get current account information, logout, ...)
    
    Returns:
    
    initialized service for account management
  - getMetadataService
```
public MetadataService getMetadataService()
```
    Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)
    
    Returns:
    
    initialized service for metadata management
  - getModelService
```
public ModelService getModelService()
```
    Get initialized service for model management (to get model diff, update model, ...)
    
    Returns:
    
    initialized service for model management
  - getGdcService
```
public GdcService getGdcService()
```
    Get initialized service for API root management (to get API root links, ...)
    
    Returns:
    
    initialized service for API root management
  - getDataStoreService
```
public DataStoreService getDataStoreService()
```
    Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)
    
    Returns:
    
    initialized service for data store management
  - getDatasetService
```
public DatasetService getDatasetService()
```
    Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)
    
    Returns:
    
    initialized service for dataset management
  - getReportService
```
public ReportService getReportService()
```
    Get initialized service for report management (to execute and export report, ...)
    
    Returns:
    
    initialized service for report management
  - getProcessService
```
public ProcessService getProcessService()
```
    Get initialized service for dataload processes management and process executions.
    
    Returns:
    
    initialized service for dataload processes management and process executions
  - getWarehouseService
```
public WarehouseService getWarehouseService()
```
    Get initialized service for ADS management (create, access and delete ads instances).
    
    Returns:
    
    initialized service for ADS management
  - getConnectorService
```
public ConnectorService getConnectorService()
```
    Get initialized service for connector integration management (create, update, start process, ...).
    
    Returns:
    
    initialized service for connector integration management

Class GoodData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GDC_REQUEST_ID_HEADER

PROTOCOL

PORT

HOSTNAME

Constructor Detail

GoodData

GoodData

GoodData

GoodData

GoodData

GoodData

GoodData

Method Detail

createHttpClient

getRestTemplate

logout

getProjectService

getAccountService

getMetadataService

getModelService

getGdcService

getDataStoreService

getDatasetService

getReportService

getProcessService

getWarehouseService

getConnectorService