Package org.hihn.listenbrainz

Class LbMiscApi.APIgetDumpInfoRequest

java.lang.Object

org.hihn.listenbrainz.LbMiscApi.APIgetDumpInfoRequest

Enclosing class:

LbMiscApi

public class LbMiscApi.APIgetDumpInfoRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getDumpInfo
GetDumpInfo	execute()	Execute getDumpInfo request
okhttp3.Call	executeAsync(ApiCallback<GetDumpInfo> _callback)	Execute getDumpInfo request (asynchronously)
ApiResponse<GetDumpInfo>	executeWithHttpInfo()	Execute getDumpInfo request with HTTP info returned
LbMiscApi.APIgetDumpInfoRequest	id(Integer id)	Set id

Methods inherited from class java.lang.Object

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

Method Details

id

public LbMiscApi.APIgetDumpInfoRequest id(Integer id)

Set id

Parameters:

id - Integer specifying the ID of the dump, if not provided, the endpoint returns information about the latest data dump. (optional)

Returns:

APIgetDumpInfoRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getDumpInfo

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success.	-
400	You did not provide a valid dump ID. See error message for details.	-
404	Dump with given ID does not exist.	-

execute

public GetDumpInfo execute()
                    throws ApiException

Execute getDumpInfo request

Returns:

GetDumpInfo

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	Success.	-
400	You did not provide a valid dump ID. See error message for details.	-
404	Dump with given ID does not exist.	-

executeWithHttpInfo

public ApiResponse<GetDumpInfo> executeWithHttpInfo()
                                             throws ApiException

Execute getDumpInfo request with HTTP info returned

Returns:

ApiResponse<GetDumpInfo>

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	Success.	-
400	You did not provide a valid dump ID. See error message for details.	-
404	Dump with given ID does not exist.	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<GetDumpInfo> _callback)
                          throws ApiException

Execute getDumpInfo request (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

Http Response Details:

Status Code	Description	Response Headers
200	Success.	-
400	You did not provide a valid dump ID. See error message for details.	-
404	Dump with given ID does not exist.	-