name |
str |
The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. |
[optional] |
display_label |
str |
The user friendly label for the property. |
[optional] |
display_label_plural |
str |
The user friendly label for the property that will be used if a plural context. |
[optional] |
property_type |
str |
The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. |
[optional] |
ui_options |
str |
|
[optional] |
hide_ui_facet |
bool |
If true then the property will not show up as a facet in the UI. |
[optional] |
show_ui_facet |
bool |
If true then the property will show up as a facet in the UI. This will be used for native datasources only. Eventually hideUiFacet will migrate to showUiFacet for custom datasources as well. |
[optional] |
ui_facet_order |
int |
Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. |
[optional] |
skip_indexing |
bool |
If true then the property will not be indexed for retrieval and ranking. |
[optional] |
targetable |
bool |
If true then the property can be used for targeting UGC like announcements. |
[optional] |
object_property_options |
[ObjectPropertyOptions] |
|
[optional] |
group |
str |
The unique identifier of the `PropertyGroup` to which this property belongs. |
[optional] |
any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |