opencloud/docs/grpc.md

title, date, weight, geekdocRepo, geekdocEditPath, geekdocFilePath

title	date	weight	geekdocRepo	geekdocEditPath	geekdocFilePath
GRPC API	2018-05-02T00:00:00+00:00	40	https://github.com/owncloud/ocis-thumbnails	edit/master/docs	grpc.md

Table of Contents

• pkg/proto/v0/thumbnails.proto

  • GetRequest

  • GetResponse

  • GetRequest.FileType

  • ThumbnailService

• Scalar Value Types

Top

pkg/proto/v0/thumbnails.proto

GetRequest

A request to retrieve a thumbnail

Field	Type	Label	Description
filepath	string		The path to the source image
filetype	GetRequest.FileType		The type to which the thumbnail should get encoded to.
etag	string		The etag of the source image
width	int32		The width of the thumbnail
height	int32		The height of the thumbnail
authorization	string		The authorization token

GetResponse

The service response

Field	Type	Label	Description
thumbnail	bytes		The thumbnail as a binary
mimetype	string		The mimetype of the thumbnail

GetRequest.FileType

The file types to which the thumbnail cna get encoded to.

Name	Number	Description
PNG	0	Represents PNG type
JPG	1	Represents JPG type

ThumbnailService

A Service for handling thumbnail generation

Method Name	Request Type	Response Type	Description
GetThumbnail	GetRequest	GetResponse	Generates the thumbnail and returns it.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)