com.aliyun.teaopenapi

类 Client

java.lang.Object

com.aliyun.teaopenapi.Client

public class Client
extends Object

字段概要

字段

限定符和类型	字段和说明
String	_ca
String	_cert
Integer	_connectTimeout
com.aliyun.credentials.Client	_credential
Boolean	_disableHttp2
String	_endpoint
Map<String,String>	_endpointMap
String	_endpointRule
String	_endpointType
GlobalParameters	_globalParameters
Map<String,String>	_headers
String	_httpProxy
String	_httpsProxy
String	_key
Integer	_maxIdleConns
String	_method
String	_network
String	_noProxy
String	_openPlatformEndpoint
String	_productId
String	_protocol
Integer	_readTimeout
String	_regionId
String	_signatureAlgorithm
String	_signatureVersion
String	_socks5NetWork
String	_socks5Proxy
com.aliyun.gateway.spi.Client	_spi
String	_suffix
String	_tlsMinVersion
String	_userAgent

构造器概要

构造器

构造器和说明
Client(Config config) description : Init client with Config

方法概要

限定符和类型	方法和说明
void	addRequestInterceptor(com.aliyun.tea.interceptor.RequestInterceptor interceptor)
void	addResponseInterceptor(com.aliyun.tea.interceptor.ResponseInterceptor interceptor)
void	addRuntimeOptionsInterceptor(com.aliyun.tea.interceptor.RuntimeOptionsInterceptor interceptor)
Map<String,?>	callApi(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime)
void	checkConfig(Config config) description : If the endpointRule and config.endpoint are empty, throw error
static Object	defaultAny(Object inputValue, Object defaultValue) description : If inputValue is not null, return it or return defaultValue
Map<String,?>	doRequest(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) description : Encapsulate the request and invoke the network
Map<String,?>	doROARequest(String action, String version, String protocol, String method, String authType, String pathname, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) description : Encapsulate the request and invoke the network
Map<String,?>	doROARequestWithForm(String action, String version, String protocol, String method, String authType, String pathname, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) description : Encapsulate the request and invoke the network with form body
Map<String,?>	doRPCRequest(String action, String version, String protocol, String method, String authType, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) description : Encapsulate the request and invoke the network
Map<String,?>	execute(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) description : Encapsulate the request and invoke the network
String	getAccessKeyId() description : Get accesskey id by using credential
String	getAccessKeySecret() description : Get accesskey secret by using credential
String	getBearerToken() description : Get bearer token by credential
Map<String,String>	getRpcHeaders() description : get RPC header for debug
String	getSecurityToken() description : Get security token by using credential
String	getType() description : Get credential type by credential
String	getUserAgent() description : Get user agent
void	setGatewayClient(com.aliyun.gateway.spi.Client spi) description : set gateway client
void	setRpcHeaders(Map<String,String> headers) description : set RPC header for debug

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

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

字段详细资料

_endpoint

public String _endpoint

_regionId

public String _regionId

_protocol

public String _protocol

_method

public String _method

_userAgent

public String _userAgent

_endpointRule

public String _endpointRule

_endpointMap

public Map<String,String> _endpointMap

_suffix

public String _suffix

_readTimeout

public Integer _readTimeout

_connectTimeout

public Integer _connectTimeout

_httpProxy

public String _httpProxy

_httpsProxy

public String _httpsProxy

_socks5Proxy

public String _socks5Proxy

_socks5NetWork

public String _socks5NetWork

_noProxy

public String _noProxy

_network

public String _network

_productId

public String _productId

_maxIdleConns

public Integer _maxIdleConns

_endpointType

public String _endpointType

_openPlatformEndpoint

public String _openPlatformEndpoint

_credential

public com.aliyun.credentials.Client _credential

_signatureVersion

public String _signatureVersion

_signatureAlgorithm

public String _signatureAlgorithm

_headers

public Map<String,String> _headers

_spi

public com.aliyun.gateway.spi.Client _spi

_globalParameters

public GlobalParameters _globalParameters

_key

public String _key

_cert

public String _cert

_ca

public String _ca

_disableHttp2

public Boolean _disableHttp2

_tlsMinVersion

public String _tlsMinVersion

构造器详细资料

Client

public Client(Config config)
       throws Exception

description :

Init client with Config

参数:

config - config contains the necessary information to create a client

抛出:

Exception

方法详细资料

doRPCRequest

public Map<String,?> doRPCRequest(String action,
                                  String version,
                                  String protocol,
                                  String method,
                                  String authType,
                                  String bodyType,
                                  OpenApiRequest request,
                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                           throws Exception

description :

Encapsulate the request and invoke the network

参数:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

返回:

the response

抛出:

Exception

doROARequest

public Map<String,?> doROARequest(String action,
                                  String version,
                                  String protocol,
                                  String method,
                                  String authType,
                                  String pathname,
                                  String bodyType,
                                  OpenApiRequest request,
                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                           throws Exception

description :

Encapsulate the request and invoke the network

参数:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

pathname - pathname of every api

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

返回:

the response

抛出:

Exception

doROARequestWithForm

public Map<String,?> doROARequestWithForm(String action,
                                          String version,
                                          String protocol,
                                          String method,
                                          String authType,
                                          String pathname,
                                          String bodyType,
                                          OpenApiRequest request,
                                          com.aliyun.teautil.models.RuntimeOptions runtime)
                                   throws Exception

description :

Encapsulate the request and invoke the network with form body

参数:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

pathname - pathname of every api

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

返回:

the response

抛出:

Exception

doRequest

public Map<String,?> doRequest(Params params,
                               OpenApiRequest request,
                               com.aliyun.teautil.models.RuntimeOptions runtime)
                        throws Exception

description :

Encapsulate the request and invoke the network

参数:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

返回:

the response

抛出:

Exception

execute

public Map<String,?> execute(Params params,
                             OpenApiRequest request,
                             com.aliyun.teautil.models.RuntimeOptions runtime)
                      throws Exception

description :

Encapsulate the request and invoke the network

参数:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

返回:

the response

抛出:

Exception

addRuntimeOptionsInterceptor

public void addRuntimeOptionsInterceptor(com.aliyun.tea.interceptor.RuntimeOptionsInterceptor interceptor)

addRequestInterceptor

public void addRequestInterceptor(com.aliyun.tea.interceptor.RequestInterceptor interceptor)

addResponseInterceptor

public void addResponseInterceptor(com.aliyun.tea.interceptor.ResponseInterceptor interceptor)

callApi

public Map<String,?> callApi(Params params,
                             OpenApiRequest request,
                             com.aliyun.teautil.models.RuntimeOptions runtime)
                      throws Exception

抛出:

Exception

getUserAgent

public String getUserAgent()
                    throws Exception

description :

Get user agent

返回:

user agent

抛出:

Exception

getAccessKeyId

public String getAccessKeyId()
                      throws Exception

description :

Get accesskey id by using credential

返回:

accesskey id

抛出:

Exception

getAccessKeySecret

public String getAccessKeySecret()
                          throws Exception

description :

Get accesskey secret by using credential

返回:

accesskey secret

抛出:

Exception

getSecurityToken

public String getSecurityToken()
                        throws Exception

description :

Get security token by using credential

返回:

security token

抛出:

Exception

getBearerToken

public String getBearerToken()
                      throws Exception

description :

Get bearer token by credential

返回:

bearer token

抛出:

Exception

getType

public String getType()
               throws Exception

description :

Get credential type by credential

返回:

credential type e.g. access_key

抛出:

Exception

defaultAny

public static Object defaultAny(Object inputValue,
                                Object defaultValue)
                         throws Exception

description :

If inputValue is not null, return it or return defaultValue

参数:

inputValue - users input value

defaultValue - default value

返回:

the final result

抛出:

Exception

checkConfig

public void checkConfig(Config config)
                 throws Exception

description :

If the endpointRule and config.endpoint are empty, throw error

参数:

config - config contains the necessary information to create a client

抛出:

Exception

setGatewayClient

public void setGatewayClient(com.aliyun.gateway.spi.Client spi)
                      throws Exception

description :

set gateway client

参数:

spi - .

抛出:

Exception

setRpcHeaders

public void setRpcHeaders(Map<String,String> headers)
                   throws Exception

description :

set RPC header for debug

参数:

headers - headers for debug, this header can be used only once.

抛出:

Exception

getRpcHeaders

public Map<String,String> getRpcHeaders()
                                 throws Exception

description :

get RPC header for debug

抛出:

Exception