Package org.genesys.amphibian.client.api

Class DatasetsApi

java.lang.Object

org.genesys.amphibian.client.api.DatasetsApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
@Component("org.genesys.amphibian.client.api.DatasetsApi")
public class DatasetsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DatasetsApi()
DatasetsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ObservationRegistration	addObservations(String tableKey, ObservationRegistration observationRegistration)	Add observations, returns result of update Add accession observations
org.springframework.http.ResponseEntity<ObservationRegistration>	addObservationsWithHttpInfo(String tableKey, ObservationRegistration observationRegistration)	Add observations, returns result of update Add accession observations
DatasetTable	createTable(DatasetTable datasetTable)	Create a new table
org.springframework.http.ResponseEntity<DatasetTable>	createTableWithHttpInfo(DatasetTable datasetTable)	Create a new table
DatasetTable	dropTable(DatasetTable datasetTable)	Drop a table
org.springframework.http.ResponseEntity<DatasetTable>	dropTableWithHttpInfo(DatasetTable datasetTable)	Drop a table
ApiClient	getApiClient()
DatasetTable	getDataset(String tableKey)	Get dataset information
org.springframework.http.ResponseEntity<DatasetTable>	getDatasetWithHttpInfo(String tableKey)	Get dataset information
HeatMap	getHeatMapData(String tableKey, UUID xCategory, UUID yCategory, TraitDataFilter traitDataFilter)	Generate a heat map Calculate a heat map of observations for two selected categorical descriptors in DatasetTable
org.springframework.http.ResponseEntity<HeatMap>	getHeatMapDataWithHttpInfo(String tableKey, UUID xCategory, UUID yCategory, TraitDataFilter traitDataFilter)	Generate a heat map Calculate a heat map of observations for two selected categorical descriptors in DatasetTable
ResponsePage	getObservations(String tableKey, List<UUID> fields, Integer p, Integer l, TraitDataFilter traitDataFilter)	Get accession observations from this dataset
List<ObservationChart>	getObservationsCharts(String tableKey, List<UUID> fields, TraitDataFilter traitDataFilter)	Generate charts Get charts of integer and coded observations from this dataset
org.springframework.http.ResponseEntity<List<ObservationChart>>	getObservationsChartsWithHttpInfo(String tableKey, List<UUID> fields, TraitDataFilter traitDataFilter)	Generate charts Get charts of integer and coded observations from this dataset
List<ObservationHistogram>	getObservationsHistogram(String tableKey, List<UUID> fields, Integer bins, TraitDataFilter traitDataFilter)	Generate histograms Get histogram of numerical observations from this dataset
org.springframework.http.ResponseEntity<List<ObservationHistogram>>	getObservationsHistogramWithHttpInfo(String tableKey, List<UUID> fields, Integer bins, TraitDataFilter traitDataFilter)	Generate histograms Get histogram of numerical observations from this dataset
org.springframework.http.ResponseEntity<ResponsePage>	getObservationsWithHttpInfo(String tableKey, List<UUID> fields, Integer p, Integer l, TraitDataFilter traitDataFilter)	Get accession observations from this dataset
Set<Object>	ingestFromPreview(String tableKey, UUID descriptorUuid, UUID previewUuid, Integer sheet, Long startRow, IngestColumnRequest ingestColumnRequest)	Ingest column values from Preview to Table
org.springframework.http.ResponseEntity<Set<Object>>	ingestFromPreviewWithHttpInfo(String tableKey, UUID descriptorUuid, UUID previewUuid, Integer sheet, Long startRow, IngestColumnRequest ingestColumnRequest)	Ingest column values from Preview to Table
DatasetTable	removeDescriptorData(String tableKey, UUID descriptorUuid)	Remove descriptor data from table
org.springframework.http.ResponseEntity<DatasetTable>	removeDescriptorDataWithHttpInfo(String tableKey, UUID descriptorUuid)	Remove descriptor data from table
void	setApiClient(ApiClient apiClient)
DatasetTable	updateTable(DatasetTable datasetTable)	Update table
org.springframework.http.ResponseEntity<DatasetTable>	updateTableWithHttpInfo(DatasetTable datasetTable)	Update table

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetsApi

public DatasetsApi()

DatasetsApi

@Autowired
public DatasetsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addObservations

public ObservationRegistration addObservations(String tableKey,
                                               ObservationRegistration observationRegistration)
                                        throws org.springframework.web.client.RestClientException

Add observations, returns result of update Add accession observations

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

observationRegistration - (required)

Returns:

ObservationRegistration

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

addObservationsWithHttpInfo

public org.springframework.http.ResponseEntity<ObservationRegistration> addObservationsWithHttpInfo(String tableKey,
                                                                                                    ObservationRegistration observationRegistration)
                                                                                             throws org.springframework.web.client.RestClientException

Add observations, returns result of update Add accession observations

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

observationRegistration - (required)

Returns:

ResponseEntity<ObservationRegistration>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createTable

public DatasetTable createTable(DatasetTable datasetTable)
                         throws org.springframework.web.client.RestClientException

Create a new table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

DatasetTable

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createTableWithHttpInfo

public org.springframework.http.ResponseEntity<DatasetTable> createTableWithHttpInfo(DatasetTable datasetTable)
                                                                              throws org.springframework.web.client.RestClientException

Create a new table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

ResponseEntity<DatasetTable>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

dropTable

public DatasetTable dropTable(DatasetTable datasetTable)
                       throws org.springframework.web.client.RestClientException

Drop a table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

DatasetTable

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

dropTableWithHttpInfo

public org.springframework.http.ResponseEntity<DatasetTable> dropTableWithHttpInfo(DatasetTable datasetTable)
                                                                            throws org.springframework.web.client.RestClientException

Drop a table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

ResponseEntity<DatasetTable>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getDataset

public DatasetTable getDataset(String tableKey)
                        throws org.springframework.web.client.RestClientException

Get dataset information

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

Returns:

DatasetTable

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getDatasetWithHttpInfo

public org.springframework.http.ResponseEntity<DatasetTable> getDatasetWithHttpInfo(String tableKey)
                                                                             throws org.springframework.web.client.RestClientException

Get dataset information

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

Returns:

ResponseEntity<DatasetTable>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getHeatMapData

public HeatMap getHeatMapData(String tableKey,
                              UUID xCategory,
                              UUID yCategory,
                              TraitDataFilter traitDataFilter)
                       throws org.springframework.web.client.RestClientException

Generate a heat map Calculate a heat map of observations for two selected categorical descriptors in DatasetTable

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

xCategory - X category field UUID (required)

yCategory - Y category field UUID (required)

traitDataFilter - (optional)

Returns:

HeatMap

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getHeatMapDataWithHttpInfo

public org.springframework.http.ResponseEntity<HeatMap> getHeatMapDataWithHttpInfo(String tableKey,
                                                                                   UUID xCategory,
                                                                                   UUID yCategory,
                                                                                   TraitDataFilter traitDataFilter)
                                                                            throws org.springframework.web.client.RestClientException

Generate a heat map Calculate a heat map of observations for two selected categorical descriptors in DatasetTable

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

xCategory - X category field UUID (required)

yCategory - Y category field UUID (required)

traitDataFilter - (optional)

Returns:

ResponseEntity<HeatMap>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservations

public ResponsePage getObservations(String tableKey,
                                    List<UUID> fields,
                                    Integer p,
                                    Integer l,
                                    TraitDataFilter traitDataFilter)
                             throws org.springframework.web.client.RestClientException

Get accession observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (optional)

p - Page you want to retrieve (0..N) (optional)

l - Number of records per page. (optional)

traitDataFilter - (optional)

Returns:

ResponsePage

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservationsWithHttpInfo

public org.springframework.http.ResponseEntity<ResponsePage> getObservationsWithHttpInfo(String tableKey,
                                                                                         List<UUID> fields,
                                                                                         Integer p,
                                                                                         Integer l,
                                                                                         TraitDataFilter traitDataFilter)
                                                                                  throws org.springframework.web.client.RestClientException

Get accession observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (optional)

p - Page you want to retrieve (0..N) (optional)

l - Number of records per page. (optional)

traitDataFilter - (optional)

Returns:

ResponseEntity<ResponsePage>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservationsCharts

public List<ObservationChart> getObservationsCharts(String tableKey,
                                                    List<UUID> fields,
                                                    TraitDataFilter traitDataFilter)
                                             throws org.springframework.web.client.RestClientException

Generate charts Get charts of integer and coded observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (required)

traitDataFilter - (optional)

Returns:

List<ObservationChart>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservationsChartsWithHttpInfo

public org.springframework.http.ResponseEntity<List<ObservationChart>> getObservationsChartsWithHttpInfo(String tableKey,
                                                                                                         List<UUID> fields,
                                                                                                         TraitDataFilter traitDataFilter)
                                                                                                  throws org.springframework.web.client.RestClientException

Generate charts Get charts of integer and coded observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (required)

traitDataFilter - (optional)

Returns:

ResponseEntity<List<ObservationChart>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservationsHistogram

public List<ObservationHistogram> getObservationsHistogram(String tableKey,
                                                           List<UUID> fields,
                                                           Integer bins,
                                                           TraitDataFilter traitDataFilter)
                                                    throws org.springframework.web.client.RestClientException

Generate histograms Get histogram of numerical observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (required)

bins - Number of bins (optional, default to 4)

traitDataFilter - (optional)

Returns:

List<ObservationHistogram>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getObservationsHistogramWithHttpInfo

public org.springframework.http.ResponseEntity<List<ObservationHistogram>> getObservationsHistogramWithHttpInfo(String tableKey,
                                                                                                                List<UUID> fields,
                                                                                                                Integer bins,
                                                                                                                TraitDataFilter traitDataFilter)
                                                                                                         throws org.springframework.web.client.RestClientException

Generate histograms Get histogram of numerical observations from this dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

fields - Specify fields to return (required)

bins - Number of bins (optional, default to 4)

traitDataFilter - (optional)

Returns:

ResponseEntity<List<ObservationHistogram>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

ingestFromPreview

public Set<Object> ingestFromPreview(String tableKey,
                                     UUID descriptorUuid,
                                     UUID previewUuid,
                                     Integer sheet,
                                     Long startRow,
                                     IngestColumnRequest ingestColumnRequest)
                              throws org.springframework.web.client.RestClientException

Ingest column values from Preview to Table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

descriptorUuid - Descriptor UUID (required)

previewUuid - Preview UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row in the Preview (required)

ingestColumnRequest - (required)

Returns:

Set<Object>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

ingestFromPreviewWithHttpInfo

public org.springframework.http.ResponseEntity<Set<Object>> ingestFromPreviewWithHttpInfo(String tableKey,
                                                                                          UUID descriptorUuid,
                                                                                          UUID previewUuid,
                                                                                          Integer sheet,
                                                                                          Long startRow,
                                                                                          IngestColumnRequest ingestColumnRequest)
                                                                                   throws org.springframework.web.client.RestClientException

Ingest column values from Preview to Table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

descriptorUuid - Descriptor UUID (required)

previewUuid - Preview UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row in the Preview (required)

ingestColumnRequest - (required)

Returns:

ResponseEntity<Set<Object>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

removeDescriptorData

public DatasetTable removeDescriptorData(String tableKey,
                                         UUID descriptorUuid)
                                  throws org.springframework.web.client.RestClientException

Remove descriptor data from table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

descriptorUuid - Descriptor UUID (required)

Returns:

DatasetTable

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

removeDescriptorDataWithHttpInfo

public org.springframework.http.ResponseEntity<DatasetTable> removeDescriptorDataWithHttpInfo(String tableKey,
                                                                                              UUID descriptorUuid)
                                                                                       throws org.springframework.web.client.RestClientException

Remove descriptor data from table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

tableKey - Table key (required)

descriptorUuid - Descriptor UUID (required)

Returns:

ResponseEntity<DatasetTable>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateTable

public DatasetTable updateTable(DatasetTable datasetTable)
                         throws org.springframework.web.client.RestClientException

Update table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

DatasetTable

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateTableWithHttpInfo

public org.springframework.http.ResponseEntity<DatasetTable> updateTableWithHttpInfo(DatasetTable datasetTable)
                                                                              throws org.springframework.web.client.RestClientException

Update table

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

datasetTable - (required)

Returns:

ResponseEntity<DatasetTable>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API