Package google.bytestream

Indice

• ByteStream (interfaccia)
• RestByteStream (interfaccia)
• Media (messaggio)
• UpdateMediaRequest (messaggio)
• WriteRequest (messaggio)
• WriteResponse (messaggio)

ByteStream

L'API Byte Stream consente a un client di leggere e scrivere un flusso di byte da e verso una risorsa. Le risorse hanno dei nomi, che vengono forniti nelle chiamate API seguenti per identificare la risorsa da cui viene letta o scritta.

Tutte le implementazioni dell'API Byte Stream esportano l'interfaccia definita qui:

• Read(): legge i contenuti di una risorsa.

• Write(): scrive i contenuti di una risorsa. Il client può chiamare Write() più volte con la stessa risorsa e può controllare lo stato della scrittura chiamando QueryWriteStatus().

L'API ByteStream non fornisce un modo diretto per accedere/modificare i metadati associati alla risorsa.

Gli errori restituiti dal servizio si trovano nello spazio di errore canonico di Google.

Scrivi

rpc Write(WriteRequest) returns (WriteResponse) Write() viene utilizzato per inviare i contenuti di una risorsa sotto forma di sequenza di byte. I byte vengono inviati in una sequenza di prototipi di richieste di una RPC con flussi di dati lato client. È possibile ripristinare un'azione Write(). Se si verifica un errore o la connessione si interrompe durante Write(), il client deve controllare lo stato di Write() chiamando QueryWriteStatus() e continuare a scrivere dal committed_size restituito. Potrebbe essere inferiore alla quantità di dati inviati in precedenza dal cliente. La chiamata di Write() su un nome di risorsa precedentemente scritto e finalizzato potrebbe causare un errore, a seconda che il servizio sottostante consenta la sovrascrittura di risorse scritte in precedenza. Quando il client chiude il canale di richiesta, il servizio risponde con un WriteResponse. Il servizio non visualizzerà la risorsa come complete finché il client non avrà inviato un WriteRequest con finish_write impostato su true. L'invio di richieste in uno stream dopo l'invio di una richiesta con il criterio finish_write impostato su true causerà un errore. Il client deve controllare il WriteResponse che riceve per determinare la quantità di dati che il servizio è stato in grado di eseguire e se il servizio visualizza la risorsa come complete o meno. Ambiti di autorizzazione Richiede uno dei seguenti ambiti OAuth: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

RestByteStream

UpdateMedia
rpc UpdateMedia(UpdateMediaRequest) returns (Media) Carica contenuti multimediali. Il caricamento è supportato nell'URI /upload/v1/media/{+name}. Ambiti di autorizzazione Richiede uno dei seguenti ambiti OAuth: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

Contenuti multimediali

Risorsa multimediale.

Campi
resource_name	string Nome della risorsa multimediale.

UpdateMediaRequest

Messaggio di richiesta per il caricamento di contenuti multimediali.

Campi
resource_name	string Nome dell'elemento multimediale scaricato. Leggi i ReadRequest.resource_name.
media	Media Rappresentazione dei contenuti multimediali che vengono caricati.

WriteRequest

Oggetto della richiesta per ByteStream.Write.

Campi
resource_name	string Il nome della risorsa da scrivere. Deve essere impostato al primo WriteRequest di ogni azione Write(). Se impostato per le chiamate successive, deve corrispondere al valore della prima richiesta.
write_offset	int64 L'offset dall'inizio della risorsa in cui devono essere scritti i dati. È obbligatorio su tutti i WriteRequest. Nella prima WriteRequest di un'azione Write(), indica l'offset iniziale per la chiamata Write(). Il valore deve essere uguale al committed_size che restituirebbe una chiamata a QueryWriteStatus(). Nelle chiamate successive, questo valore deve essere impostato e deve essere uguale alla somma dei primi write_offset e delle dimensioni di tutti i data pacchetti inviati in precedenza nello stream. Un valore errato causerà un errore.
finish_write	bool Se true, significa che la scrittura è stata completata. L'invio di WriteRequest successivi a uno in cui finish_write è true causerà un errore.
data	bytes Una parte dei dati per la risorsa. Il client potrebbe lasciare il campo data vuoto per ogni WriteRequest specificato. Ciò consente al client di informare il servizio che la richiesta è ancora attiva mentre è in esecuzione un'operazione per generare altri dati.

WriteResponse

Oggetto risposta per ByteStream.Write.

Campi
committed_size	int64 Il numero di byte elaborati per la risorsa specificata.