Mulai 27 Maret 2025, sebaiknya gunakan android-latest-release, bukan aosp-main, untuk mem-build dan berkontribusi pada AOSP. Untuk mengetahui informasi selengkapnya, lihat Perubahan pada AOSP.

Halaman ini diterjemahkan oleh Cloud Translation API.

RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

Class helper untuk melakukan panggilan REST API.

Ringkasan

Konstanta
`int`	`DEFAULT_NUMBER_OF_RETRIES`

Kolom
`protected static final JsonFactory`	`JSON_FACTORY`
`protected static final String`	`JSON_MIME`

Konstruktor publik
`RestApiHelper(HttpRequestFactory requestFactory, String baseUri)` Membuat instance helper API dengan informasi yang diberikan.

Metode publik
`GenericUrl`	`buildQueryUri(String[] uriParts, options)` Membuat URI untuk panggilan API dengan bagian dan opsi URI yang diberikan.
`HttpResponse`	`execute(String method, String[] uriParts, options, JSONObject data)` Menjalankan permintaan API.
`HttpRequestFactory`	`getRequestFactory()` Menampilkan HttpRequestFactory.
`static RestApiHelper`	`newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, scopes)` Membuat instance helper API yang menggunakan `Credential` untuk autentikasi.

Konstanta

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Nilai Konstanta: 2 (0x00000002)

Kolom

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Konstruktor publik

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Membuat instance helper API dengan informasi yang diberikan.

Parameter
`requestFactory`	`HttpRequestFactory`: factory yang akan digunakan saat membuat `HttpRequest`.
`baseUri`	`String`: URI dasar API

Metode publik

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Buat URI untuk panggilan API dengan bagian dan opsi URI yang diberikan. uriParts harus sudah dienkode URL, sedangkan opsi harus berupa String yang tidak dienkode.

Parameter
`uriParts`	`String`
`options`

Hasil
`GenericUrl`

execute

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

Menjalankan permintaan API.

Parameter
`method`	`String`: metode HTTP permintaan
`uriParts`	`String`: Bagian URI yang dienkode URL yang akan digunakan untuk membuat URI permintaan.
`options`	: nama dan nilai parameter yang tidak dienkode yang digunakan untuk membuat string kueri
`data`	`JSONObject`: data yang akan dikirim dengan permintaan

Hasil
`HttpResponse`	objek HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Menampilkan HttpRequestFactory.

Ditampilkan untuk pengujian.

Hasil
`HttpRequestFactory`

newInstanceWithGoogleCredential

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

Membuat instance helper API yang menggunakan Credential untuk autentikasi.

Parameter
`baseUri`	`String`: URI dasar API
`jsonKeyFile`	`File`: file kunci json akun layanan
`scopes`	: kumpulan cakupan OAuth yang akan digunakan dengan akun layanan

Hasil
`RestApiHelper`

Menampilkan
	GeneralSecurityException
	IOException