org.corpus_tools.annis.api

Class AdministrationApi

java.lang.Object

org.corpus_tools.annis.api.AdministrationApi

public class AdministrationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AdministrationApi()
AdministrationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteGroup(String name) Delete the user group given by its name
okhttp3.Call	deleteGroupAsync(String name, ApiCallback<Void> _callback) Delete the user group given by its name (asynchronously)
okhttp3.Call	deleteGroupCall(String name, ApiCallback _callback) Build call for deleteGroup
ApiResponse<Void>	deleteGroupWithHttpInfo(String name) Delete the user group given by its name
InlineResponse202	exportPost(InlineObject inlineObject) Get all requested corpora as ZIP-file
okhttp3.Call	exportPostAsync(InlineObject inlineObject, ApiCallback<InlineResponse202> _callback) Get all requested corpora as ZIP-file (asynchronously)
okhttp3.Call	exportPostCall(InlineObject inlineObject, ApiCallback _callback) Build call for exportPost
ApiResponse<InlineResponse202>	exportPostWithHttpInfo(InlineObject inlineObject) Get all requested corpora as ZIP-file
ApiClient	getApiClient()
void	getJob(String uuid) Get the status of the background job with the UUID
okhttp3.Call	getJobAsync(String uuid, ApiCallback<Void> _callback) Get the status of the background job with the UUID (asynchronously)
okhttp3.Call	getJobCall(String uuid, ApiCallback _callback) Build call for getJob
ApiResponse<Void>	getJobWithHttpInfo(String uuid) Get the status of the background job with the UUID
ImportResult	importPost(File body, Boolean overrideExisting) Import all corpora which are part of the uploaded ZIP-file This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.
okhttp3.Call	importPostAsync(File body, Boolean overrideExisting, ApiCallback<ImportResult> _callback) Import all corpora which are part of the uploaded ZIP-file (asynchronously) This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.
okhttp3.Call	importPostCall(File body, Boolean overrideExisting, ApiCallback _callback) Build call for importPost
ApiResponse<ImportResult>	importPostWithHttpInfo(File body, Boolean overrideExisting) Import all corpora which are part of the uploaded ZIP-file This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.
List<Group>	listGroups() Get all available user groups
okhttp3.Call	listGroupsAsync(ApiCallback<List<Group>> _callback) Get all available user groups (asynchronously)
okhttp3.Call	listGroupsCall(ApiCallback _callback) Build call for listGroups
ApiResponse<List<Group>>	listGroupsWithHttpInfo() Get all available user groups
void	putGroup(String name, Group group) Add or replace the user group given by its name
okhttp3.Call	putGroupAsync(String name, Group group, ApiCallback<Void> _callback) Add or replace the user group given by its name (asynchronously)
okhttp3.Call	putGroupCall(String name, Group group, ApiCallback _callback) Build call for putGroup
ApiResponse<Void>	putGroupWithHttpInfo(String name, Group group) Add or replace the user group given by its name
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministrationApi

public AdministrationApi()

AdministrationApi

public AdministrationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteGroupCall

public okhttp3.Call deleteGroupCall(String name,
                                    ApiCallback _callback)
                             throws ApiException

Build call for deleteGroup

Parameters:

name - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteGroup

public void deleteGroup(String name)
                 throws ApiException

Delete the user group given by its name

Parameters:

name - (required)

Throws:

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

deleteGroupWithHttpInfo

public ApiResponse<Void> deleteGroupWithHttpInfo(String name)
                                          throws ApiException

Delete the user group given by its name

Parameters:

name - (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteGroupAsync

public okhttp3.Call deleteGroupAsync(String name,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Delete the user group given by its name (asynchronously)

Parameters:

name - (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

exportPostCall

public okhttp3.Call exportPostCall(InlineObject inlineObject,
                                   ApiCallback _callback)
                            throws ApiException

Build call for exportPost

Parameters:

inlineObject - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportPost

public InlineResponse202 exportPost(InlineObject inlineObject)
                             throws ApiException

Get all requested corpora as ZIP-file

Parameters:

inlineObject - (required)

Returns:

InlineResponse202

Throws:

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

exportPostWithHttpInfo

public ApiResponse<InlineResponse202> exportPostWithHttpInfo(InlineObject inlineObject)
                                                      throws ApiException

Get all requested corpora as ZIP-file

Parameters:

inlineObject - (required)

Returns:

ApiResponse<InlineResponse202>

Throws:

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

exportPostAsync

public okhttp3.Call exportPostAsync(InlineObject inlineObject,
                                    ApiCallback<InlineResponse202> _callback)
                             throws ApiException

Get all requested corpora as ZIP-file (asynchronously)

Parameters:

inlineObject - (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

getJobCall

public okhttp3.Call getJobCall(String uuid,
                               ApiCallback _callback)
                        throws ApiException

Build call for getJob

Parameters:

uuid - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getJob

public void getJob(String uuid)
            throws ApiException

Get the status of the background job with the UUID

Parameters:

uuid - (required)

Throws:

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

getJobWithHttpInfo

public ApiResponse<Void> getJobWithHttpInfo(String uuid)
                                     throws ApiException

Get the status of the background job with the UUID

Parameters:

uuid - (required)

Returns:

ApiResponse<Void>

Throws:

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

getJobAsync

public okhttp3.Call getJobAsync(String uuid,
                                ApiCallback<Void> _callback)
                         throws ApiException

Get the status of the background job with the UUID (asynchronously)

Parameters:

uuid - (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

importPostCall

public okhttp3.Call importPostCall(File body,
                                   Boolean overrideExisting,
                                   ApiCallback _callback)
                            throws ApiException

Build call for importPost

Parameters:

body - (required)

overrideExisting - If true, existing corpora will be overwritten by the uploaded ones. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importPost

public ImportResult importPost(File body,
                               Boolean overrideExisting)
                        throws ApiException

Import all corpora which are part of the uploaded ZIP-file This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.

Parameters:

body - (required)

overrideExisting - If true, existing corpora will be overwritten by the uploaded ones. (optional, default to false)

Returns:

ImportResult

Throws:

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

importPostWithHttpInfo

public ApiResponse<ImportResult> importPostWithHttpInfo(File body,
                                                        Boolean overrideExisting)
                                                 throws ApiException

Import all corpora which are part of the uploaded ZIP-file This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.

Parameters:

body - (required)

overrideExisting - If true, existing corpora will be overwritten by the uploaded ones. (optional, default to false)

Returns:

ApiResponse<ImportResult>

Throws:

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

importPostAsync

public okhttp3.Call importPostAsync(File body,
                                    Boolean overrideExisting,
                                    ApiCallback<ImportResult> _callback)
                             throws ApiException

Import all corpora which are part of the uploaded ZIP-file (asynchronously) This will search for all GraphML and relANNIS files in the uploaded ZIP file and imports them.

Parameters:

body - (required)

overrideExisting - If true, existing corpora will be overwritten by the uploaded ones. (optional, default to false)

_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

listGroupsCall

public okhttp3.Call listGroupsCall(ApiCallback _callback)
                            throws ApiException

Build call for listGroups

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listGroups

public List<Group> listGroups()
                       throws ApiException

Get all available user groups

Returns:

List<Group>

Throws:

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

listGroupsWithHttpInfo

public ApiResponse<List<Group>> listGroupsWithHttpInfo()
                                                throws ApiException

Get all available user groups

Returns:

ApiResponse<List<Group>>

Throws:

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

listGroupsAsync

public okhttp3.Call listGroupsAsync(ApiCallback<List<Group>> _callback)
                             throws ApiException

Get all available user groups (asynchronously)

Parameters:

_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

putGroupCall

public okhttp3.Call putGroupCall(String name,
                                 Group group,
                                 ApiCallback _callback)
                          throws ApiException

Build call for putGroup

Parameters:

name - (required)

group - The group to add (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

putGroup

public void putGroup(String name,
                     Group group)
              throws ApiException

Add or replace the user group given by its name

Parameters:

name - (required)

group - The group to add (required)

Throws:

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

putGroupWithHttpInfo

public ApiResponse<Void> putGroupWithHttpInfo(String name,
                                              Group group)
                                       throws ApiException

Add or replace the user group given by its name

Parameters:

name - (required)

group - The group to add (required)

Returns:

ApiResponse<Void>

Throws:

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

putGroupAsync

public okhttp3.Call putGroupAsync(String name,
                                  Group group,
                                  ApiCallback<Void> _callback)
                           throws ApiException

Add or replace the user group given by its name (asynchronously)

Parameters:

name - (required)

group - The group to add (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