ocis.services.search.v0

ocis/services/search/v0/search.proto

IndexSpaceRequest

Field	Type	Label	Description
space_id	string
user_id	string

IndexSpaceResponse

SearchIndexRequest

Field	Type	Label	Description
page_size	int32		Optional. The maximum number of entries to return in the response
page_token	string		Optional. A pagination token returned from a previous call to `Get` that indicates from where search should continue
query	string
ref	ocis.messages.search.v0.Reference

SearchIndexResponse

Field	Type	Label	Description
matches	ocis.messages.search.v0.Match	repeated
next_page_token	string		Token to retrieve the next page of results, or empty if there are no more results in the list
total_matches	int32

SearchRequest

Field	Type	Label	Description
page_size	int32		Optional. The maximum number of entries to return in the response
page_token	string		Optional. A pagination token returned from a previous call to `Get` that indicates from where search should continue
query	string
ref	ocis.messages.search.v0.Reference

SearchResponse

Field	Type	Label	Description
matches	ocis.messages.search.v0.Match	repeated
next_page_token	string		Token to retrieve the next page of results, or empty if there are no more results in the list
total_matches	int32

IndexProvider

Method Name	Request Type	Response Type	Description
Search	SearchIndexRequest	SearchIndexResponse

SearchProvider

Method Name	Request Type	Response Type	Description
Search	SearchRequest	SearchResponse
IndexSpace	IndexSpaceRequest	IndexSpaceResponse

Scalar Value Types

.proto Type	Notes	C++	Java
double		double	double
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
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long
uint32	Uses variable-length encoding.	uint32	int
uint64	Uses variable-length encoding.	uint64	long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long
sfixed32	Always four bytes.	int32	int
sfixed64	Always eight bytes.	int64	long
bool		bool	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String
bytes	May contain any arbitrary sequence of bytes.	string	ByteString