Skip to content

Latest commit

 

History

History
429 lines (190 loc) · 11.4 KB

File metadata and controls

429 lines (190 loc) · 11.4 KB

Protocol Documentation

Table of Contents

Top

tensorbeat/common.proto

AddFile

Field Type Label Description
name string
uri string
mimeType string
tags AddFile.TagsEntry repeated

AddFile.TagsEntry

Field Type Label Description
key string
value string

File

Field Type Label Description
id string
name string
uri string
mimeType string
tags File.TagsEntry repeated

File.TagsEntry

Field Type Label Description
key string
value string

Top

tensorbeat/datalake.proto

AddSongsRequest

Field Type Label Description
songs tensorbeat.common.AddFile repeated

AddSongsResponse

Field Type Label Description
successful bool

AddTagsRequest

Field Type Label Description
id string
tags AddTagsRequest.TagsEntry repeated

AddTagsRequest.TagsEntry

Field Type Label Description
key string
value string

AddTagsResponse

Field Type Label Description
successful bool

GetAllSongsRequest

Field Type Label Description
page_token int64 optional
page_size int64 optional

GetAllSongsResponse

Field Type Label Description
songs tensorbeat.common.File repeated
next_page_token int64
total_size int64

GetSongsByIDsRequest

Field Type Label Description
ids string repeated
page_token int64 optional
page_size int64 optional

GetSongsByIDsResponse

Field Type Label Description
songs tensorbeat.common.File repeated
next_page_token int64
total_size int64

GetSongsByTagsRequest

Field Type Label Description
tags GetSongsByTagsRequest.TagsEntry repeated Pass in map of tags to be matched on returned songs EX: { "genre": "rock", "spectrogram_id": "*", } The tags will be combined using the filter: - ANY means songs matching any of the tags will be returned. - ALL means songs matching all of the tags will be returned. - NONE means songs that dont match any of the tags will be returned.

Using an * for the value will return any song with that tag set. Using a specific value for the tag will return only songs with that exact combination of Key/Value | | filter | Filter | | | | page_token | int64 | optional | | | page_size | int64 | optional | |

GetSongsByTagsRequest.TagsEntry

Field Type Label Description
key string
value string

GetSongsByTagsResponse

Field Type Label Description
songs tensorbeat.common.File repeated
next_page_token int64
total_size int64

RemoveTagsRequest

Field Type Label Description
id string
tags RemoveTagsRequest.TagsEntry repeated

RemoveTagsRequest.TagsEntry

Field Type Label Description
key string
value string

RemoveTagsResponse

Field Type Label Description
successful bool

Filter

Name Number Description
ANY 0
ALL 1
NONE 2

DatalakeService

Method Name Request Type Response Type Description
GetAllSongs GetAllSongsRequest GetAllSongsResponse
GetSongsByIDs GetSongsByIDsRequest GetSongsByIDsResponse
GetSongsByTags GetSongsByTagsRequest GetSongsByTagsResponse
AddSongs AddSongsRequest AddSongsResponse
AddTags AddTagsRequest AddTagsResponse
RemoveTags RemoveTagsRequest RemoveTagsResponse

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)