Package google.bytestream

索引

• ByteStream (介面)
• RestByteStream (介面)
• Media (訊息)
• UpdateMediaRequest (訊息)
• WriteRequest (訊息)
• WriteResponse (訊息)

ByteStream

Byte Stream API 可讓用戶端讀取及寫入資源的位元組串流。資源具有名稱，這些名稱會在下方的 API 呼叫中提供，以識別讀取或寫入的資源。

Byte Stream API 匯出介面定義的所有實作項目：

• Read()：讀取資源的內容。

• Write()：寫入資源的內容。用戶端可以使用相同的資源多次呼叫 Write()，並可呼叫 QueryWriteStatus() 來檢查寫入狀態。

ByteStream API 無法直接存取/修改與資源相關聯的任何中繼資料。

服務傳回的錯誤位於 Google 標準錯誤空間中。

撰寫

rpc Write(WriteRequest) returns (WriteResponse) Write() 可用來以位元組序列傳送資源內容。這些位元組會透過用戶端串流 RPC 的要求原型序列傳送。 Write() 動作可繼續。如果在 Write() 期間發生錯誤或連線中斷，用戶端應呼叫 QueryWriteStatus() 並繼續從傳回的 committed_size 寫入，藉此檢查 Write() 的狀態。這個數值可能少於用戶端先前傳送的資料量。 針對先前編寫且最終的資源名稱呼叫 Write() 可能會導致錯誤，具體取決於基礎服務是否允許覆寫先前寫入的資源。 當用戶端關閉要求管道時，服務會回應 WriteResponse。在用戶端傳送 finish_write 設為 true 的 WriteRequest 之前，服務不會將這項資源顯示為 complete。傳送 finish_write 設為 true 的要求後，如果在串流上傳送任何要求，就會導致錯誤。用戶端應檢查其收到的 WriteResponse，以確認服務能夠修訂的資料量，以及服務是否將資源視為 complete。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage 詳情請參閱 OAuth 2.0 總覽。

RestByteStream

UpdateMedia
rpc UpdateMedia(UpdateMediaRequest) returns (Media) 上傳媒體。URI /upload/v1/media/{+name} 支援上傳功能。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage 詳情請參閱 OAuth 2.0 總覽。

媒體

媒體資源。

欄位
resource_name	string 媒體資源名稱。

UpdateMediaRequest

上傳媒體時要求訊息。

欄位
resource_name	string 所下載的媒體名稱。查看《ReadRequest.resource_name》。
media	Media 代表上傳的媒體。

WriteRequest

ByteStream.Write 的要求物件。

欄位
resource_name	string 要寫入的資源名稱。這個做法必須在每個 Write() 動作的第一個 WriteRequest 上設定。如果是在後續的呼叫中設定，則「必須」與第一個要求的值相符。
write_offset	int64 與應寫入資料的資源開頭之間的偏移值。所有 WriteRequest 都必須提供這項資訊。 在 Write() 動作的第一個 WriteRequest 中，表示 Write() 呼叫的初始偏移。這個值必須等於呼叫 QueryWriteStatus() 會傳回的 committed_size。 後續呼叫時，您必須設定這個值，且必須等於這個串流先前傳送的所有 data 組合大小的總和。write_offset 不正確的值會導致錯誤發生。
finish_write	bool 如果為 true，表示寫入完成。如果後續傳送任何 WriteRequest，但函式 finish_write 為 true，就會發生錯誤。
data	bytes 資源資料的一部分。用戶端可將任何指定 WriteRequest 的 data 留空。這可讓用戶端通知服務，而要求仍在執行中，以便產生更多資料。

WriteResponse

ByteStream.Write 的回應物件。

欄位
committed_size	int64 已針對特定資源處理的位元組數。