Package google.bytestream

Indeks

ByteStream

Byte Stream API memungkinkan klien untuk membaca dan menulis aliran byte ke dan dari resource. Resource memiliki nama, dan nama-nama ini diberikan dalam panggilan API di bawah untuk mengidentifikasi resource yang sedang dibaca atau ditulis.

Semua implementasi Byte Stream API mengekspor antarmuka yang ditentukan di sini:

  • Read(): Membaca konten resource.

  • Write(): Menulis konten resource. Klien dapat memanggil Write() beberapa kali dengan resource yang sama dan dapat memeriksa status penulisan dengan memanggil QueryWriteStatus().

ByteStream API tidak menyediakan cara langsung untuk mengakses/mengubah metadata apa pun yang terkait dengan resource.

Error yang ditampilkan oleh layanan ada di ruang error kanonis Google.

Tulis

rpc Write(WriteRequest) returns (WriteResponse)

Write() digunakan untuk mengirim konten resource sebagai urutan byte. Byte dikirim dalam urutan proto permintaan RPC streaming sisi klien.

Tindakan Write() dapat dilanjutkan. Jika terjadi error atau koneksi terputus selama Write(), klien harus memeriksa status Write() dengan memanggil QueryWriteStatus() dan melanjutkan menulis dari committed_size yang ditampilkan. Ini mungkin kurang dari jumlah data yang dikirim klien sebelumnya.

Memanggil Write() pada nama resource yang sebelumnya ditulis dan diselesaikan dapat menyebabkan error, tergantung pada apakah layanan yang mendasarinya memungkinkan penulisan lebih banyak resource yang ditulis sebelumnya.

Saat klien menutup saluran permintaan, layanan akan merespons dengan WriteResponse. Layanan tidak akan melihat resource sebagai complete hingga klien telah mengirim WriteRequest dengan finish_write yang disetel ke true. Mengirim permintaan apa pun pada stream setelah mengirim permintaan dengan finish_write yang ditetapkan ke true akan menyebabkan error. Klien harus memeriksa WriteResponse yang diterima untuk menentukan berapa banyak data yang dapat dilakukan layanan dan apakah layanan melihat resource sebagai complete atau tidak.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

RestByteStream

UpdateMedia

rpc UpdateMedia(UpdateMediaRequest) returns (Media)

Mengupload media. Upload didukung di URI /upload/v1/media/{+name}.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Media

Resource media.

Kolom
resource_name

string

Nama resource media.

UpdateMediaRequest

Pesan permintaan untuk mengupload media.

Kolom
resource_name

string

Nama media yang sedang didownload. Lihat ReadRequest.resource_name.
media

Media

Representasi media yang sedang diupload.

WriteRequest

Minta objek untuk ByteStream.Write.

Kolom
resource_name

string

Nama resource yang akan ditulis. Ini harus ditetapkan pada WriteRequest pertama setiap tindakan Write(). Jika ditetapkan pada panggilan berikutnya, nilai tersebut harus cocok dengan nilai permintaan pertama.
write_offset

int64

Offset dari awal resource tempat data harus ditulis. Wajib ada di semua WriteRequest.

Pada WriteRequest pertama dari tindakan Write(), parameter ini menunjukkan offset awal untuk panggilan Write(). Nilai harus sama dengan committed_size yang akan ditampilkan oleh panggilan ke QueryWriteStatus().

Pada panggilan berikutnya, nilai ini harus ditetapkan dan harus sama dengan jumlah write_offset pertama dan ukuran semua paket data yang dikirim sebelumnya pada streaming ini.

Nilai yang salah akan menyebabkan error.
finish_write

bool

Jika true, ini menunjukkan bahwa penulisan selesai. Mengirim WriteRequest berikutnya dengan finish_write yang berupa true akan menyebabkan error.
data

bytes

Sebagian dari data untuk resource. Klien dapat membiarkan data kosong untuk setiap WriteRequest tertentu. Hal ini memungkinkan klien untuk memberi tahu layanan bahwa permintaan masih aktif saat menjalankan operasi untuk menghasilkan lebih banyak data.

WriteResponse

Objek respons untuk ByteStream.Write.

Kolom
committed_size

int64

Jumlah byte yang telah diproses untuk resource yang diberikan.