ocis.messages.settings.v0

ocis/messages/settings/v0/settings.proto

Bool

Field	Type	Label	Description
default	bool		@gotags: yaml:“default”
label	string		@gotags: yaml:“label”

Bundle

Field	Type	Label	Description
id	string		@gotags: yaml:“id”
name	string		@gotags: yaml:“name”
type	Bundle.Type		@gotags: yaml:“type”
extension	string		@gotags: yaml:“extension”
display_name	string		@gotags: yaml:“display_name”
settings	Setting	repeated	@gotags: yaml:“settings”
resource	Resource		@gotags: yaml:“resource”

CollectionOption

Field	Type	Label	Description
key	string		required @gotags: yaml:“key”
int_value	int64		@gotags: yaml:“int_value”
string_value	string		@gotags: yaml:“string_value”
bool_value	bool		@gotags: yaml:“bool_value”

CollectionValue

Field	Type	Label	Description
values	CollectionOption	repeated	@gotags: yaml:“values”

Identifier

Field	Type	Label	Description
extension	string
bundle	string
setting	string

Int

Field	Type	Label	Description
default	int64		@gotags: yaml:“default”
min	int64		@gotags: yaml:“min”
max	int64		@gotags: yaml:“max”
step	int64		@gotags: yaml:“step”
placeholder	string		@gotags: yaml:“placeholder”

ListOption

Field	Type	Label	Description
value	ListOptionValue		@gotags: yaml:“value”
default	bool		@gotags: yaml:“default”
display_value	string		@gotags: yaml:“display_value”

ListOptionValue

Field	Type	Label	Description
string_value	string		@gotags: yaml:“string_value”
int_value	int64		@gotags: yaml:“int_value”
bool_value	bool		@gotags: yaml:“bool_value”

ListValue

Field	Type	Label	Description
values	ListOptionValue	repeated	@gotags: yaml:“values”

MultiChoiceCollection

Field	Type	Label	Description
options	MultiChoiceCollectionOption	repeated	@gotags: yaml:“options”

MultiChoiceCollectionOption

Field	Type	Label	Description
value	MultiChoiceCollectionOptionValue		@gotags: yaml:“value”
key	string		@gotags: yaml:“key”
attribute	string		@gotags: yaml:“attribute”
display_value	string		@gotags: yaml:“display_value”

MultiChoiceCollectionOptionValue

Field	Type	Label	Description
int_value	Int		@gotags: yaml:“int_value”
string_value	String		@gotags: yaml:“string_value”
bool_value	Bool		@gotags: yaml:“bool_value”

MultiChoiceList

Field	Type	Label	Description
options	ListOption	repeated	@gotags: yaml:“options”

Permission

Field	Type	Label	Description
operation	Permission.Operation		@gotags: yaml:“operation”
constraint	Permission.Constraint		@gotags: yaml:“constraint”

Resource

Field	Type	Label	Description
type	Resource.Type
id	string

Setting

Field	Type	Label	Description
id	string		@gotags: yaml:“id”
name	string		@gotags: yaml:“name”
display_name	string		@gotags: yaml:“display_name”
description	string		@gotags: yaml:“description”
int_value	Int		@gotags: yaml:“int_value”
string_value	String		@gotags: yaml:“string_value”
bool_value	Bool		@gotags: yaml:“bool_value”
single_choice_value	SingleChoiceList		@gotags: yaml:“single_choice_value”
multi_choice_value	MultiChoiceList		@gotags: yaml:“multi_choice_value”
permission_value	Permission		@gotags: yaml:“permission_value”
multi_choice_collection_value	MultiChoiceCollection		@gotags: yaml:“multi_choice_collection_value”
resource	Resource		@gotags: yaml:“resource”

SingleChoiceList

Field	Type	Label	Description
options	ListOption	repeated	@gotags: yaml:“options”

String

Field	Type	Label	Description
default	string		@gotags: yaml:“default”
required	bool		@gotags: yaml:“required”
min_length	int32		@gotags: yaml:“min_length”
max_length	int32		@gotags: yaml:“max_length”
placeholder	string		@gotags: yaml:“placeholder”

UserRoleAssignment

Field	Type	Label	Description
id	string		id is generated upon saving the assignment
account_uuid	string
role_id	string		the role_id is a bundle_id internally

UserRoleAssignmentFilter

Field	Type	Label	Description
type	UserRoleAssignmentFilter.Type
account_uuid	string
role_id	string

Value

Field	Type	Label	Description
id	string		id is the id of the Value. It is generated on saving it. @gotags: yaml:“id”
bundle_id	string		@gotags: yaml:“bundle_id”
setting_id	string		setting_id is the id of the setting from within its bundle. @gotags: yaml:“setting_id”
account_uuid	string		@gotags: yaml:“account_uuid”
resource	Resource		@gotags: yaml:“resource”
bool_value	bool		@gotags: yaml:“bool_value”
int_value	int64		@gotags: yaml:“int_value”
string_value	string		@gotags: yaml:“string_value”
list_value	ListValue		@gotags: yaml:“list_value”
collection_value	CollectionValue		@gotags: yaml:“collection_value”

ValueWithIdentifier

Field	Type	Label	Description
identifier	Identifier
value	Value

Bundle.Type

Name	Number	Description
TYPE_UNKNOWN	0
TYPE_DEFAULT	1
TYPE_ROLE	2

Permission.Constraint

Name	Number	Description
CONSTRAINT_UNKNOWN	0
CONSTRAINT_OWN	1
CONSTRAINT_SHARED	2
CONSTRAINT_ALL	3

Permission.Operation

Name	Number	Description
OPERATION_UNKNOWN	0
OPERATION_CREATE	1
OPERATION_READ	2
OPERATION_UPDATE	3
OPERATION_DELETE	4
OPERATION_WRITE	5	WRITE is a combination of CREATE and UPDATE
OPERATION_READWRITE	6	READWRITE is a combination of READ and WRITE

Resource.Type

Name	Number	Description
TYPE_UNKNOWN	0
TYPE_SYSTEM	1
TYPE_FILE	2
TYPE_SHARE	3
TYPE_SETTING	4
TYPE_BUNDLE	5
TYPE_USER	6
TYPE_GROUP	7

UserRoleAssignmentFilter.Type

Name	Number	Description
TYPE_UNKNOWN	0
TYPE_ACCOUNT	1
TYPE_ROLE	2

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