Package google.bytestream

Índice

• ByteStream (interfaz)
• RestByteStream (interfaz)
• Media (mensaje)
• UpdateMediaRequest (mensaje)
• WriteRequest (mensaje)
• WriteResponse (mensaje)

ByteStream

La API de Byte Stream permite que un cliente lea y escriba un flujo de bytes desde y hacia un recurso. Los recursos tienen nombres, que se proporcionan en las llamadas a la API a continuación para identificar el recurso en el que se lee o se escribe.

Todas las implementaciones de la API de Byte Stream exportan la interfaz que se define aquí:

• Read(): Lee el contenido de un recurso.

• Write(): Escribe el contenido de un recurso. El cliente puede llamar a Write() varias veces con el mismo recurso y puede llamar a QueryWriteStatus() para verificar el estado de la escritura.

La API de ByteStream no proporciona una forma directa de acceder o modificar ningún metadato asociado con el recurso.

Los errores que muestra el servicio están en el espacio de error canónico de Google.

Escritura

rpc Write(WriteRequest) returns (WriteResponse) Write() se usa para enviar el contenido de un recurso como una secuencia de bytes. Los bytes se envían en una secuencia de protocolos de solicitud de una RPC de transmisión del lado del cliente. Una acción Write() se puede reanudar. Si se produce un error o la conexión se interrumpe durante Write(), el cliente debe verificar el estado del Write() llamando a QueryWriteStatus() y seguir escribiendo desde el committed_size que se muestra. Puede ser inferior a la cantidad de datos que el cliente envió anteriormente. Llamar a Write() en un nombre de recurso que se escribió y finalizó antes podría causar un error, en función de si el servicio subyacente permite el reemplazo de recursos escritos con anterioridad. Cuando el cliente cierre el canal de solicitud, el servicio responderá con WriteResponse. El servicio no verá el recurso como complete hasta que el cliente haya enviado un WriteRequest con finish_write establecido en true. Si envías cualquier solicitud en una transmisión después de enviar una solicitud con finish_write configurado como true, se producirá un error. El cliente debe verificar el WriteResponse que recibe para determinar cuántos datos pudo confirmar el servicio y si ve el recurso como complete o no. Alcances de la autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage Para obtener más información, consulta la Descripción general de OAuth 2.0.

RestByteStream

UpdateMedia
rpc UpdateMedia(UpdateMediaRequest) returns (Media) Sube contenido multimedia. La carga es compatible con el URI /upload/v1/media/{+name}. Alcances de la autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage Para obtener más información, consulta la Descripción general de OAuth 2.0.

Medios

Recurso multimedia.

Campos
resource_name	string Es el nombre del recurso multimedia.

UpdateMediaRequest

Mensaje de solicitud para subir contenido multimedia.

Campos
resource_name	string El nombre del contenido multimedia que se está descargando. Consulta los ReadRequest.resource_name.
media	Media Representación de los medios que se suben.

WriteRequest

Objeto de solicitud para ByteStream.Write.

Campos
resource_name	string Es el nombre del recurso que se escribirá. Esto debe configurarse en la primera WriteRequest de cada acción Write(). Si se configura en llamadas posteriores, debe coincidir con el valor de la primera solicitud.
write_offset	int64 El desplazamiento desde el principio del recurso en el que se deben escribir los datos. Es obligatorio en todos los objetos WriteRequest. En el primer WriteRequest de una acción Write(), indica el desplazamiento inicial para la llamada a Write(). El valor debe ser igual al committed_size que mostraría una llamada a QueryWriteStatus(). En las llamadas posteriores, se debe establecer este valor y debe ser igual a la suma del primer write_offset y los tamaños de todos los paquetes de data enviados anteriormente en esta transmisión. Un valor incorrecto generará un error.
finish_write	bool Si es true, indica que se completó la escritura. Si envías cualquier WriteRequest posterior a uno en el que finish_write sea true, se producirá un error.
data	bytes Es una parte de los datos del recurso. El cliente puede dejar data vacío para cualquier WriteRequest determinado. Esto permite que el cliente informe al servicio que la solicitud aún está activa mientras se ejecuta una operación para generar más datos.

WriteResponse

Objeto de respuesta para ByteStream.Write.

Campos
committed_size	int64 La cantidad de bytes que se procesaron para el recurso determinado.