com.alibaba.dashscope.api

类 GeneralApi<ParamT extends HalfDuplexParamBase>

java.lang.Object

com.alibaba.dashscope.api.GeneralApi<ParamT>

public final class GeneralApi<ParamT extends HalfDuplexParamBase>
extends Object

Support DashScope async task CRUD.

构造器概要

构造器

构造器和说明
GeneralApi() Create default http client.
GeneralApi(ConnectionOptions connectionOptions) Create custom http client

方法概要

限定符和类型	方法和说明
DashScopeResult	call(ParamT param, ServiceOption serviceOptions) Call the server to get the whole result.
void	call(ParamT param, ServiceOption serviceOptions, ResultCallback<DashScopeResult> callback) Call the server to get the result in the callback function.
DashScopeResult	delete(HalfDuplexParamBase param, ServiceOption serviceOption) Make a Delete request.
DashScopeResult	get(HalfDuplexParamBase param, ServiceOption serviceOption) Make a get request.
io.reactivex.Flowable<DashScopeResult>	streamCall(ParamT param, ServiceOption serviceOptions) Call the server to get the result by stream.
void	streamCall(ParamT param, ServiceOption serviceOptions, ResultCallback<DashScopeResult> callback) Call the server to get the result by stream.

从类继承的方法 java.lang.Object

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

构造器详细资料

GeneralApi

public GeneralApi()

Create default http client.

GeneralApi

public GeneralApi(ConnectionOptions connectionOptions)

Create custom http client

参数:

connectionOptions - The client option.

方法详细资料

call

public DashScopeResult call(ParamT param,
                            ServiceOption serviceOptions)
                     throws ApiException,
                            NoApiKeyException

Call the server to get the whole result.

参数:

param - The input param, should be the subclass of `Param`.

serviceOptions - The service option.

返回:

The output structure, should be the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

call

public void call(ParamT param,
                 ServiceOption serviceOptions,
                 ResultCallback<DashScopeResult> callback)
          throws ApiException,
                 NoApiKeyException

Call the server to get the result in the callback function.

参数:

param - The input param, should be the subclass of `Param`.

serviceOptions - The service options

callback - The callback to receive response, should be the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

streamCall

public io.reactivex.Flowable<DashScopeResult> streamCall(ParamT param,
                                                         ServiceOption serviceOptions)
                                                  throws ApiException,
                                                         NoApiKeyException

Call the server to get the result by stream.

参数:

param - The input param, should be the subclass of `Param`.

serviceOptions - The service options

返回:

A `Flowable` of the output structure, which is the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

streamCall

public void streamCall(ParamT param,
                       ServiceOption serviceOptions,
                       ResultCallback<DashScopeResult> callback)
                throws ApiException,
                       NoApiKeyException

Call the server to get the result by stream.

参数:

param - The input param, should be the subclass of `Param`.

serviceOptions - The service options

callback - The result callback.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

get

public DashScopeResult get(HalfDuplexParamBase param,
                           ServiceOption serviceOption)
                    throws ApiException,
                           NoApiKeyException

Make a get request.

参数:

param - The param

serviceOption - The service options

返回:

The task result.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

delete

public DashScopeResult delete(HalfDuplexParamBase param,
                              ServiceOption serviceOption)
                       throws ApiException,
                              NoApiKeyException

Make a Delete request.

参数:

param - The param.

serviceOption - The service options

返回:

The task result or status information.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.