此页面由 Cloud Translation API 翻译。

RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
↳	com.android.tradefed.util.RestApiHelper

用于执行 REST API 调用的帮助程序类。

概括

常量
`int`	`DEFAULT_NUMBER_OF_RETRIES`

字段
`protected static final JsonFactory`	`JSON_FACTORY`
`protected static final String`	`JSON_MIME`

公共构造函数
`RestApiHelper (HttpRequestFactory requestFactory, String baseUri)` 使用给定的信息创建一个 API 帮助程序实例。

公共方法
`GenericUrl`	`buildQueryUri (String[] uriParts, options)` `buildQueryUri (String[] uriParts, options)` 使用给定的 URI 部分和选项为 API 调用构造 URI。
`HttpResponse`	`execute (String method, String[] uriParts, options, JSONObject data)` `execute (String method, String[] uriParts, options, JSONObject data)` 执行 API 请求。
`HttpRequestFactory`	`getRequestFactory ()` 返回 HttpRequestFactory。
`static RestApiHelper`	`newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes)` `newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes)` 创建一个 API 帮助程序实例，它使用`Credential`进行身份验证。
`static RestApiHelper`	`newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)` `newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)` 创建一个 API 帮助程序实例，它使用`Credential`进行身份验证。

常量

默认_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

常量值：2 (0x00000002)

字段

JSON_工厂

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

公共构造函数

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

使用给定的信息创建一个 API 帮助程序实例。

参数
`requestFactory`	`HttpRequestFactory` ：创建`HttpRequest`时使用的工厂。
`baseUri`	`String` : API 的基础 URI

公共方法

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

使用给定的 URI 部分和选项为 API 调用构造 URI。 uriParts 应该已经进行了 URL 编码，而选项应该是未编码的字符串。

参数
`uriParts`	`String`
`options`

退货
`GenericUrl`

执行

public HttpResponse execute (String method, 
                String[] uriParts, 
                 options, 
                JSONObject data)

执行 API 请求。

参数
`method`	`String` : 请求的 HTTP 方法
`uriParts`	`String` ：用于构造请求 URI 的 URL 编码 URI 部分。
`options`	：用于构造查询字符串的未编码参数名称和值
`data`	`JSONObject` ：要随请求一起发送的数据

退货
`HttpResponse`	一个 HttpResponse 对象

获取请求工厂

public HttpRequestFactory getRequestFactory ()

返回 HttpRequestFactory。

暴露测试。

退货
`HttpRequestFactory`

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 scopes)

创建一个 API 帮助程序实例，它使用Credential进行身份验证。

参数
`baseUri`	`String` : API 的基本 URI
`jsonKeyFile`	`File` ：服务账户 json 密钥文件
`scopes`	：与服务帐户一起使用的 OAuth 范围的集合

退货
`RestApiHelper`

投掷
	一般安全异常
	异常

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                String serviceAccount, 
                File keyFile, 
                 scopes)

创建一个 API 帮助程序实例，它使用Credential进行身份验证。

参数
`baseUri`	`String` : API 的基本 URI
`serviceAccount`	`String` ：要使用的服务帐户的名称
`keyFile`	`File` ：服务帐户密钥文件
`scopes`	：与服务帐户一起使用的 OAuth 范围的集合

退货
`RestApiHelper`

投掷
	一般安全异常
	异常