Package org.openapitools.client.api

Class DatasetApi

java.lang.Object

org.openapitools.client.api.DatasetApi

public class DatasetApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DatasetApi()
DatasetApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Dataset	createDataset(String trOrganization, CreateDatasetRequest createDatasetRequest)	Create dataset Create dataset Create a new dataset.
okhttp3.Call	createDatasetAsync(String trOrganization, CreateDatasetRequest createDatasetRequest, ApiCallback<Dataset> _callback)	Create dataset (asynchronously) Create dataset Create a new dataset.
okhttp3.Call	createDatasetCall(String trOrganization, CreateDatasetRequest createDatasetRequest, ApiCallback _callback)	Build call for createDataset
ApiResponse<Dataset>	createDatasetWithHttpInfo(@NotNull String trOrganization, @NotNull CreateDatasetRequest createDatasetRequest)	Create dataset Create dataset Create a new dataset.
void	deleteDataset(String trOrganization, DeleteDatasetRequest deleteDatasetRequest)	Delete Dataset Delete Dataset Delete a dataset.
okhttp3.Call	deleteDatasetAsync(String trOrganization, DeleteDatasetRequest deleteDatasetRequest, ApiCallback<Void> _callback)	Delete Dataset (asynchronously) Delete Dataset Delete a dataset.
okhttp3.Call	deleteDatasetCall(String trOrganization, DeleteDatasetRequest deleteDatasetRequest, ApiCallback _callback)	Build call for deleteDataset
ApiResponse<Void>	deleteDatasetWithHttpInfo(@NotNull String trOrganization, @NotNull DeleteDatasetRequest deleteDatasetRequest)	Delete Dataset Delete Dataset Delete a dataset.
ApiClient	getApiClient()
ClientDatasetConfiguration	getClientDatasetConfig(String trDataset)	Get Client Configuration Get Client Configuration Get the client configuration for a dataset.
okhttp3.Call	getClientDatasetConfigAsync(String trDataset, ApiCallback<ClientDatasetConfiguration> _callback)	Get Client Configuration (asynchronously) Get Client Configuration Get the client configuration for a dataset.
okhttp3.Call	getClientDatasetConfigCall(String trDataset, ApiCallback _callback)	Build call for getClientDatasetConfig
ApiResponse<ClientDatasetConfiguration>	getClientDatasetConfigWithHttpInfo(@NotNull String trDataset)	Get Client Configuration Get Client Configuration Get the client configuration for a dataset.
String	getCustomBaseUrl()
Dataset	getDataset(String trOrganization, String trDataset, UUID datasetId)	Get Dataset Get Dataset Get a dataset by id.
okhttp3.Call	getDatasetAsync(String trOrganization, String trDataset, UUID datasetId, ApiCallback<Dataset> _callback)	Get Dataset (asynchronously) Get Dataset Get a dataset by id.
okhttp3.Call	getDatasetCall(String trOrganization, String trDataset, UUID datasetId, ApiCallback _callback)	Build call for getDataset
List<DatasetAndUsage>	getDatasetsFromOrganization(String trOrganization, UUID organizationId)	Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization.
okhttp3.Call	getDatasetsFromOrganizationAsync(String trOrganization, UUID organizationId, ApiCallback<List<DatasetAndUsage>> _callback)	Get Datasets from Organization (asynchronously) Get Datasets from Organization Get all datasets for an organization.
okhttp3.Call	getDatasetsFromOrganizationCall(String trOrganization, UUID organizationId, ApiCallback _callback)	Build call for getDatasetsFromOrganization
ApiResponse<List<DatasetAndUsage>>	getDatasetsFromOrganizationWithHttpInfo(@NotNull String trOrganization, @NotNull UUID organizationId)	Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization.
ApiResponse<Dataset>	getDatasetWithHttpInfo(@NotNull String trOrganization, @NotNull String trDataset, @NotNull UUID datasetId)	Get Dataset Get Dataset Get a dataset by id.
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
Dataset	updateDataset(String trOrganization, UpdateDatasetRequest updateDatasetRequest)	Update Dataset Update Dataset Update a dataset.
okhttp3.Call	updateDatasetAsync(String trOrganization, UpdateDatasetRequest updateDatasetRequest, ApiCallback<Dataset> _callback)	Update Dataset (asynchronously) Update Dataset Update a dataset.
okhttp3.Call	updateDatasetCall(String trOrganization, UpdateDatasetRequest updateDatasetRequest, ApiCallback _callback)	Build call for updateDataset
ApiResponse<Dataset>	updateDatasetWithHttpInfo(@NotNull String trOrganization, @NotNull UpdateDatasetRequest updateDatasetRequest)	Update Dataset Update Dataset Update a dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetApi

public DatasetApi()

DatasetApi

public DatasetApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createDatasetCall

public okhttp3.Call createDatasetCall(String trOrganization,
                                      CreateDatasetRequest createDatasetRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createDataset

Parameters:

trOrganization - The organization id to use for the request (required)

createDatasetRequest - JSON request payload to create a new dataset (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset created successfully	-
400	Service error relating to creating the dataset	-

createDataset

public Dataset createDataset(String trOrganization,
                             CreateDatasetRequest createDatasetRequest)
                      throws ApiException

Create dataset Create dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

createDatasetRequest - JSON request payload to create a new dataset (required)

Returns:

Dataset

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset created successfully	-
400	Service error relating to creating the dataset	-

createDatasetWithHttpInfo

public ApiResponse<Dataset> createDatasetWithHttpInfo(@NotNull
                                                      @NotNull String trOrganization,
                                                      @NotNull
                                                      @NotNull CreateDatasetRequest createDatasetRequest)
                                               throws ApiException

Create dataset Create dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

createDatasetRequest - JSON request payload to create a new dataset (required)

Returns:

ApiResponse<Dataset>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset created successfully	-
400	Service error relating to creating the dataset	-

createDatasetAsync

public okhttp3.Call createDatasetAsync(String trOrganization,
                                       CreateDatasetRequest createDatasetRequest,
                                       ApiCallback<Dataset> _callback)
                                throws ApiException

Create dataset (asynchronously) Create dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

createDatasetRequest - JSON request payload to create a new dataset (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset created successfully	-
400	Service error relating to creating the dataset	-

deleteDatasetCall

public okhttp3.Call deleteDatasetCall(String trOrganization,
                                      DeleteDatasetRequest deleteDatasetRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteDataset

Parameters:

trOrganization - The organization id to use for the request (required)

deleteDatasetRequest - JSON request payload to delete a dataset (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Dataset deleted successfully	-
400	Service error relating to deleting the dataset	-

deleteDataset

public void deleteDataset(String trOrganization,
                          DeleteDatasetRequest deleteDatasetRequest)
                   throws ApiException

Delete Dataset Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

deleteDatasetRequest - JSON request payload to delete a dataset (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Dataset deleted successfully	-
400	Service error relating to deleting the dataset	-

deleteDatasetWithHttpInfo

public ApiResponse<Void> deleteDatasetWithHttpInfo(@NotNull
                                                   @NotNull String trOrganization,
                                                   @NotNull
                                                   @NotNull DeleteDatasetRequest deleteDatasetRequest)
                                            throws ApiException

Delete Dataset Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

deleteDatasetRequest - JSON request payload to delete a dataset (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Dataset deleted successfully	-
400	Service error relating to deleting the dataset	-

deleteDatasetAsync

public okhttp3.Call deleteDatasetAsync(String trOrganization,
                                       DeleteDatasetRequest deleteDatasetRequest,
                                       ApiCallback<Void> _callback)
                                throws ApiException

Delete Dataset (asynchronously) Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

deleteDatasetRequest - JSON request payload to delete a dataset (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Dataset deleted successfully	-
400	Service error relating to deleting the dataset	-

getClientDatasetConfigCall

public okhttp3.Call getClientDatasetConfigCall(String trDataset,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getClientDatasetConfig

Parameters:

trDataset - The dataset id to use for the request (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset environment variables	-
400	Service error relating to retrieving the dataset. Typically this only happens when your auth credentials are invalid.	-

getClientDatasetConfig

public ClientDatasetConfiguration getClientDatasetConfig(String trDataset)
                                                  throws ApiException

Get Client Configuration Get Client Configuration Get the client configuration for a dataset. Will use the TR-D

Parameters:

trDataset - The dataset id to use for the request (required)

Returns:

ClientDatasetConfiguration

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset environment variables	-
400	Service error relating to retrieving the dataset. Typically this only happens when your auth credentials are invalid.	-

getClientDatasetConfigWithHttpInfo

public ApiResponse<ClientDatasetConfiguration> getClientDatasetConfigWithHttpInfo(@NotNull
                                                                                  @NotNull String trDataset)
                                                                           throws ApiException

Get Client Configuration Get Client Configuration Get the client configuration for a dataset. Will use the TR-D

Parameters:

trDataset - The dataset id to use for the request (required)

Returns:

ApiResponse<ClientDatasetConfiguration>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset environment variables	-
400	Service error relating to retrieving the dataset. Typically this only happens when your auth credentials are invalid.	-

getClientDatasetConfigAsync

public okhttp3.Call getClientDatasetConfigAsync(String trDataset,
                                                ApiCallback<ClientDatasetConfiguration> _callback)
                                         throws ApiException

Get Client Configuration (asynchronously) Get Client Configuration Get the client configuration for a dataset. Will use the TR-D

Parameters:

trDataset - The dataset id to use for the request (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset environment variables	-
400	Service error relating to retrieving the dataset. Typically this only happens when your auth credentials are invalid.	-

getDatasetCall

public okhttp3.Call getDatasetCall(String trOrganization,
                                   String trDataset,
                                   UUID datasetId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getDataset

Parameters:

trOrganization - The organization id to use for the request (required)

trDataset - The dataset id to use for the request (required)

datasetId - The id of the dataset you want to retrieve. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDataset

public Dataset getDataset(String trOrganization,
                          String trDataset,
                          UUID datasetId)
                   throws ApiException

Get Dataset Get Dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

trDataset - The dataset id to use for the request (required)

datasetId - The id of the dataset you want to retrieve. (required)

Returns:

Dataset

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetWithHttpInfo

public ApiResponse<Dataset> getDatasetWithHttpInfo(@NotNull
                                                   @NotNull String trOrganization,
                                                   @NotNull
                                                   @NotNull String trDataset,
                                                   @NotNull
                                                   @NotNull UUID datasetId)
                                            throws ApiException

Get Dataset Get Dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

trDataset - The dataset id to use for the request (required)

datasetId - The id of the dataset you want to retrieve. (required)

Returns:

ApiResponse<Dataset>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetAsync

public okhttp3.Call getDatasetAsync(String trOrganization,
                                    String trDataset,
                                    UUID datasetId,
                                    ApiCallback<Dataset> _callback)
                             throws ApiException

Get Dataset (asynchronously) Get Dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

trDataset - The dataset id to use for the request (required)

datasetId - The id of the dataset you want to retrieve. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetsFromOrganizationCall

public okhttp3.Call getDatasetsFromOrganizationCall(String trOrganization,
                                                    UUID organizationId,
                                                    ApiCallback _callback)
                                             throws ApiException

Build call for getDatasetsFromOrganization

Parameters:

trOrganization - The organization id to use for the request (required)

organizationId - id of the organization you want to retrieve datasets for (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Datasets retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetsFromOrganization

public List<DatasetAndUsage> getDatasetsFromOrganization(String trOrganization,
                                                         UUID organizationId)
                                                  throws ApiException

Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.

Parameters:

trOrganization - The organization id to use for the request (required)

organizationId - id of the organization you want to retrieve datasets for (required)

Returns:

List<DatasetAndUsage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Datasets retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetsFromOrganizationWithHttpInfo

public ApiResponse<List<DatasetAndUsage>> getDatasetsFromOrganizationWithHttpInfo(@NotNull
                                                                                  @NotNull String trOrganization,
                                                                                  @NotNull
                                                                                  @NotNull UUID organizationId)
                                                                           throws ApiException

Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.

Parameters:

trOrganization - The organization id to use for the request (required)

organizationId - id of the organization you want to retrieve datasets for (required)

Returns:

ApiResponse<List<DatasetAndUsage>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Datasets retrieved successfully	-
400	Service error relating to retrieving the dataset	-

getDatasetsFromOrganizationAsync

public okhttp3.Call getDatasetsFromOrganizationAsync(String trOrganization,
                                                     UUID organizationId,
                                                     ApiCallback<List<DatasetAndUsage>> _callback)
                                              throws ApiException

Get Datasets from Organization (asynchronously) Get Datasets from Organization Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.

Parameters:

trOrganization - The organization id to use for the request (required)

organizationId - id of the organization you want to retrieve datasets for (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Datasets retrieved successfully	-
400	Service error relating to retrieving the dataset	-

updateDatasetCall

public okhttp3.Call updateDatasetCall(String trOrganization,
                                      UpdateDatasetRequest updateDatasetRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateDataset

Parameters:

trOrganization - The organization id to use for the request (required)

updateDatasetRequest - JSON request payload to update a dataset (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset updated successfully	-
400	Service error relating to updating the dataset	-

updateDataset

public Dataset updateDataset(String trOrganization,
                             UpdateDatasetRequest updateDatasetRequest)
                      throws ApiException

Update Dataset Update Dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

updateDatasetRequest - JSON request payload to update a dataset (required)

Returns:

Dataset

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset updated successfully	-
400	Service error relating to updating the dataset	-

updateDatasetWithHttpInfo

public ApiResponse<Dataset> updateDatasetWithHttpInfo(@NotNull
                                                      @NotNull String trOrganization,
                                                      @NotNull
                                                      @NotNull UpdateDatasetRequest updateDatasetRequest)
                                               throws ApiException

Update Dataset Update Dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

updateDatasetRequest - JSON request payload to update a dataset (required)

Returns:

ApiResponse<Dataset>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Dataset updated successfully	-
400	Service error relating to updating the dataset	-

updateDatasetAsync

public okhttp3.Call updateDatasetAsync(String trOrganization,
                                       UpdateDatasetRequest updateDatasetRequest,
                                       ApiCallback<Dataset> _callback)
                                throws ApiException

Update Dataset (asynchronously) Update Dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.

Parameters:

trOrganization - The organization id to use for the request (required)

updateDatasetRequest - JSON request payload to update a dataset (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Dataset updated successfully	-
400	Service error relating to updating the dataset	-