Package org.genesys.amphibian.client.api

Class PreviewApi

java.lang.Object

org.genesys.amphibian.client.api.PreviewApi

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

Constructor Summary

Constructors

Constructor	Description
PreviewApi()
PreviewApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Long	addMetadata(UUID uuid, List<RowMetadata> rowMetadata)	Add metadata to ingested rows
org.springframework.http.ResponseEntity<Long>	addMetadataWithHttpInfo(UUID uuid, List<RowMetadata> rowMetadata)	Add metadata to ingested rows
void	deletePreview(UUID uuid)	Remove the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
org.springframework.http.ResponseEntity<Void>	deletePreviewWithHttpInfo(UUID uuid)	Remove the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
void	generateDescriptors(UUID uuid)	Generate descriptors for all PreviewSheets of given Preview
org.springframework.http.ResponseEntity<Void>	generateDescriptorsWithHttpInfo(UUID uuid)	Generate descriptors for all PreviewSheets of given Preview
ApiClient	getApiClient()
List<Object>	getData(UUID uuid, Integer sheet, Long startRow, Integer limit, List<String> fields, PreviewDataFilter previewDataFilter)	Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
org.springframework.http.ResponseEntity<List<Object>>	getDataWithHttpInfo(UUID uuid, Integer sheet, Long startRow, Integer limit, List<String> fields, PreviewDataFilter previewDataFilter)	Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
Preview	getPreview(UUID uuid)	Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
org.springframework.http.ResponseEntity<Preview>	getPreviewWithHttpInfo(UUID uuid)	Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
List<StatisticsData>	getStatisticsData(UUID uuid, Integer sheet, List<String> fields, Long startRow, Integer limit)	Get the statistics of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
org.springframework.http.ResponseEntity<List<StatisticsData>>	getStatisticsDataWithHttpInfo(UUID uuid, Integer sheet, List<String> fields, Long startRow, Integer limit)	Get the statistics of the parsed dataset Use the same reference UUID as provided when ingesting a dataset
Preview	ingest(UUID uuid, Date expires, String encoding, String contentType, File _file)	Ingest a new dataset Ingests Excel, CSV or TSV files for preview
org.springframework.http.ResponseEntity<Preview>	ingestWithHttpInfo(UUID uuid, Date expires, String encoding, String contentType, File _file)	Ingest a new dataset Ingests Excel, CSV or TSV files for preview
Preview	longToWide(UUID uuid, LongToWide longToWide)	Generate a sheet with wide data from long data
org.springframework.http.ResponseEntity<Preview>	longToWideWithHttpInfo(UUID uuid, LongToWide longToWide)	Generate a sheet with wide data from long data
void	setApiClient(ApiClient apiClient)
Set<Object>	validateCategorical(UUID uuid, Integer sheet, Long startRow, ValidateCategoricalRequest validateCategoricalRequest)	Assert that field values correspond to constraints for CATEGORICAL data
org.springframework.http.ResponseEntity<Set<Object>>	validateCategoricalWithHttpInfo(UUID uuid, Integer sheet, Long startRow, ValidateCategoricalRequest validateCategoricalRequest)	Assert that field values correspond to constraints for CATEGORICAL data
Set<Object>	validateNumeric(UUID uuid, Integer sheet, Long startRow, ValidateNumericRequest validateNumericRequest)	Assert that field values correspond to constraints for TEXT data
org.springframework.http.ResponseEntity<Set<Object>>	validateNumericWithHttpInfo(UUID uuid, Integer sheet, Long startRow, ValidateNumericRequest validateNumericRequest)	Assert that field values correspond to constraints for TEXT data
Set<Object>	validateText(UUID uuid, Integer sheet, Long startRow, ValidateTextRequest validateTextRequest)	Assert that field values correspond to constraints for TEXT data
org.springframework.http.ResponseEntity<Set<Object>>	validateTextWithHttpInfo(UUID uuid, Integer sheet, Long startRow, ValidateTextRequest validateTextRequest)	Assert that field values correspond to constraints for TEXT data

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewApi

public PreviewApi()

PreviewApi

@Autowired
public PreviewApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addMetadata

public Long addMetadata(UUID uuid,
                        List<RowMetadata> rowMetadata)
                 throws org.springframework.web.client.RestClientException

Add metadata to ingested rows

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - The number of Preview rows updated

Parameters:

uuid - Your reference UUID by which you can refer back to the dataset (required)

rowMetadata - (required)

Returns:

Long

Throws:

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

addMetadataWithHttpInfo

public org.springframework.http.ResponseEntity<Long> addMetadataWithHttpInfo(UUID uuid,
                                                                             List<RowMetadata> rowMetadata)
                                                                      throws org.springframework.web.client.RestClientException

Add metadata to ingested rows

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - The number of Preview rows updated

Parameters:

uuid - Your reference UUID by which you can refer back to the dataset (required)

rowMetadata - (required)

Returns:

ResponseEntity<Long>

Throws:

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

deletePreview

public void deletePreview(UUID uuid)
                   throws org.springframework.web.client.RestClientException

Remove the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Throws:

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

deletePreviewWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deletePreviewWithHttpInfo(UUID uuid)
                                                                        throws org.springframework.web.client.RestClientException

Remove the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Returns:

ResponseEntity<Void>

Throws:

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

generateDescriptors

public void generateDescriptors(UUID uuid)
                         throws org.springframework.web.client.RestClientException

Generate descriptors for all PreviewSheets of given Preview

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Throws:

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

generateDescriptorsWithHttpInfo

public org.springframework.http.ResponseEntity<Void> generateDescriptorsWithHttpInfo(UUID uuid)
                                                                              throws org.springframework.web.client.RestClientException

Generate descriptors for all PreviewSheets of given Preview

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Returns:

ResponseEntity<Void>

Throws:

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

getData

public List<Object> getData(UUID uuid,
                            Integer sheet,
                            Long startRow,
                            Integer limit,
                            List<String> fields,
                            PreviewDataFilter previewDataFilter)
                     throws org.springframework.web.client.RestClientException

Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

limit - Number of rows to return (optional)

fields - Specify fields to return (optional)

previewDataFilter - (optional)

Returns:

List<Object>

Throws:

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

getDataWithHttpInfo

public org.springframework.http.ResponseEntity<List<Object>> getDataWithHttpInfo(UUID uuid,
                                                                                 Integer sheet,
                                                                                 Long startRow,
                                                                                 Integer limit,
                                                                                 List<String> fields,
                                                                                 PreviewDataFilter previewDataFilter)
                                                                          throws org.springframework.web.client.RestClientException

Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

limit - Number of rows to return (optional)

fields - Specify fields to return (optional)

previewDataFilter - (optional)

Returns:

ResponseEntity<List<Object>>

Throws:

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

getPreview

public Preview getPreview(UUID uuid)
                   throws org.springframework.web.client.RestClientException

Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Returns:

Preview

Throws:

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

getPreviewWithHttpInfo

public org.springframework.http.ResponseEntity<Preview> getPreviewWithHttpInfo(UUID uuid)
                                                                        throws org.springframework.web.client.RestClientException

Get the overview of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

Returns:

ResponseEntity<Preview>

Throws:

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

getStatisticsData

public List<StatisticsData> getStatisticsData(UUID uuid,
                                              Integer sheet,
                                              List<String> fields,
                                              Long startRow,
                                              Integer limit)
                                       throws org.springframework.web.client.RestClientException

Get the statistics of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

fields - Specify fields to analyze (required)

startRow - Index of the first row (required)

limit - Number of distinct values to return (required)

Returns:

List<StatisticsData>

Throws:

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

getStatisticsDataWithHttpInfo

public org.springframework.http.ResponseEntity<List<StatisticsData>> getStatisticsDataWithHttpInfo(UUID uuid,
                                                                                                   Integer sheet,
                                                                                                   List<String> fields,
                                                                                                   Long startRow,
                                                                                                   Integer limit)
                                                                                            throws org.springframework.web.client.RestClientException

Get the statistics of the parsed dataset Use the same reference UUID as provided when ingesting a dataset

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

fields - Specify fields to analyze (required)

startRow - Index of the first row (required)

limit - Number of distinct values to return (required)

Returns:

ResponseEntity<List<StatisticsData>>

Throws:

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

ingest

public Preview ingest(UUID uuid,
                      Date expires,
                      String encoding,
                      String contentType,
                      File _file)
               throws org.springframework.web.client.RestClientException

Ingest a new dataset Ingests Excel, CSV or TSV files for preview

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - The overview of the parsed dataset

Parameters:

uuid - Your reference UUID by which you can refer back to the dataset (required)

expires - Set the date after the ingested file may be removed from the database (defaults to default expiration period) (optional)

encoding - Optionally provide character encoding (optional)

contentType - Optionally provide file content type (optional)

_file - The file to ingest into the database (required)

Returns:

Preview

Throws:

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

ingestWithHttpInfo

public org.springframework.http.ResponseEntity<Preview> ingestWithHttpInfo(UUID uuid,
                                                                           Date expires,
                                                                           String encoding,
                                                                           String contentType,
                                                                           File _file)
                                                                    throws org.springframework.web.client.RestClientException

Ingest a new dataset Ingests Excel, CSV or TSV files for preview

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - The overview of the parsed dataset

Parameters:

uuid - Your reference UUID by which you can refer back to the dataset (required)

expires - Set the date after the ingested file may be removed from the database (defaults to default expiration period) (optional)

encoding - Optionally provide character encoding (optional)

contentType - Optionally provide file content type (optional)

_file - The file to ingest into the database (required)

Returns:

ResponseEntity<Preview>

Throws:

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

longToWide

public Preview longToWide(UUID uuid,
                          LongToWide longToWide)
                   throws org.springframework.web.client.RestClientException

Generate a sheet with wide data from long data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

longToWide - (required)

Returns:

Preview

Throws:

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

longToWideWithHttpInfo

public org.springframework.http.ResponseEntity<Preview> longToWideWithHttpInfo(UUID uuid,
                                                                               LongToWide longToWide)
                                                                        throws org.springframework.web.client.RestClientException

Generate a sheet with wide data from long data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

longToWide - (required)

Returns:

ResponseEntity<Preview>

Throws:

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

validateCategorical

public Set<Object> validateCategorical(UUID uuid,
                                       Integer sheet,
                                       Long startRow,
                                       ValidateCategoricalRequest validateCategoricalRequest)
                                throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for CATEGORICAL data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateCategoricalRequest - (required)

Returns:

Set<Object>

Throws:

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

validateCategoricalWithHttpInfo

public org.springframework.http.ResponseEntity<Set<Object>> validateCategoricalWithHttpInfo(UUID uuid,
                                                                                            Integer sheet,
                                                                                            Long startRow,
                                                                                            ValidateCategoricalRequest validateCategoricalRequest)
                                                                                     throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for CATEGORICAL data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateCategoricalRequest - (required)

Returns:

ResponseEntity<Set<Object>>

Throws:

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

validateNumeric

public Set<Object> validateNumeric(UUID uuid,
                                   Integer sheet,
                                   Long startRow,
                                   ValidateNumericRequest validateNumericRequest)
                            throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for TEXT data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateNumericRequest - (required)

Returns:

Set<Object>

Throws:

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

validateNumericWithHttpInfo

public org.springframework.http.ResponseEntity<Set<Object>> validateNumericWithHttpInfo(UUID uuid,
                                                                                        Integer sheet,
                                                                                        Long startRow,
                                                                                        ValidateNumericRequest validateNumericRequest)
                                                                                 throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for TEXT data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateNumericRequest - (required)

Returns:

ResponseEntity<Set<Object>>

Throws:

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

validateText

public Set<Object> validateText(UUID uuid,
                                Integer sheet,
                                Long startRow,
                                ValidateTextRequest validateTextRequest)
                         throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for TEXT data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateTextRequest - (required)

Returns:

Set<Object>

Throws:

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

validateTextWithHttpInfo

public org.springframework.http.ResponseEntity<Set<Object>> validateTextWithHttpInfo(UUID uuid,
                                                                                     Integer sheet,
                                                                                     Long startRow,
                                                                                     ValidateTextRequest validateTextRequest)
                                                                              throws org.springframework.web.client.RestClientException

Assert that field values correspond to constraints for TEXT data

400 - Bad Request

405 - Method Not Allowed

500 - Internal Server Error

404 - Not Found

401 - Unauthorized

200 - OK

Parameters:

uuid - Your reference UUID (required)

sheet - Sheet index (required)

startRow - Index of the first row (required)

validateTextRequest - (required)

Returns:

ResponseEntity<Set<Object>>

Throws:

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