Package org.camunda.community.rest.client.api

Class SchemaLogApi

java.lang.Object

org.camunda.community.rest.client.api.SchemaLogApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class SchemaLogApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SchemaLogApi()
SchemaLogApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
List<SchemaLogEntryDto>	getSchemaLog(String version, String sortBy, String sortOrder, Integer firstResult, Integer maxResults)	Get List Queries for schema log entries that fulfill given parameters.
List<SchemaLogEntryDto>	getSchemaLog(String version, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders)	Get List Queries for schema log entries that fulfill given parameters.
List<SchemaLogEntryDto>	querySchemaLog(Integer firstResult, Integer maxResults, SchemaLogQueryDto schemaLogQueryDto)	Get List (POST) Queries for schema log entries that fulfill given parameters.
List<SchemaLogEntryDto>	querySchemaLog(Integer firstResult, Integer maxResults, SchemaLogQueryDto schemaLogQueryDto, Map<String,String> additionalHeaders)	Get List (POST) Queries for schema log entries that fulfill given parameters.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaLogApi

public SchemaLogApi()

SchemaLogApi

public SchemaLogApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSchemaLog

public List<SchemaLogEntryDto> getSchemaLog(String version,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults)
                                     throws ApiException

Get List Queries for schema log entries that fulfill given parameters.

Parameters:

version - Only return schema log entries with a specific version. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

Returns:

List<SchemaLogEntryDto>

Throws:

ApiException - if fails to make API call

getSchemaLog

public List<SchemaLogEntryDto> getSchemaLog(String version,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Get List Queries for schema log entries that fulfill given parameters.

Parameters:

version - Only return schema log entries with a specific version. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<SchemaLogEntryDto>

Throws:

ApiException - if fails to make API call

querySchemaLog

public List<SchemaLogEntryDto> querySchemaLog(Integer firstResult,
 Integer maxResults,
 SchemaLogQueryDto schemaLogQueryDto)
                                       throws ApiException

Get List (POST) Queries for schema log entries that fulfill given parameters.

Parameters:

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

schemaLogQueryDto - (optional)

Returns:

List<SchemaLogEntryDto>

Throws:

ApiException - if fails to make API call

querySchemaLog

public List<SchemaLogEntryDto> querySchemaLog(Integer firstResult,
 Integer maxResults,
 SchemaLogQueryDto schemaLogQueryDto,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Get List (POST) Queries for schema log entries that fulfill given parameters.

Parameters:

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

schemaLogQueryDto - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<SchemaLogEntryDto>

Throws:

ApiException - if fails to make API call