Class PropertyDefinition (0.2.1)

Version 0.2.1

• 0.7.12 (latest)
• 0.7.11
• 0.6.0
• 0.5.1
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.0

PropertyDefinition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines the metadata for a schema property.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
name	str Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, \_, and .
display_name	str The display-name for the property, used for front-end.
is_repeatable	bool Whether the property can have multiple values.
is_filterable	bool Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
is_searchable	bool Indicates that the property should be included in a global search.
is_metadata	bool Whether the property is user supplied metadata.
is_required	bool Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
integer_type_options	google.cloud.contentwarehouse_v1.types.IntegerTypeOptions Integer property. This field is a member of oneof_ value_type_options.
float_type_options	google.cloud.contentwarehouse_v1.types.FloatTypeOptions Float property. This field is a member of oneof_ value_type_options.
text_type_options	google.cloud.contentwarehouse_v1.types.TextTypeOptions Text/string property. This field is a member of oneof_ value_type_options.
property_type_options	google.cloud.contentwarehouse_v1.types.PropertyTypeOptions Nested structured data property. This field is a member of oneof_ value_type_options.
enum_type_options	google.cloud.contentwarehouse_v1.types.EnumTypeOptions Enum/categorical property. This field is a member of oneof_ value_type_options.
date_time_type_options	google.cloud.contentwarehouse_v1.types.DateTimeTypeOptions Date time property. It is not supported by CMEK compliant deployment. This field is a member of oneof_ value_type_options.
map_type_options	google.cloud.contentwarehouse_v1.types.MapTypeOptions Map property. This field is a member of oneof_ value_type_options.
timestamp_type_options	google.cloud.contentwarehouse_v1.types.TimestampTypeOptions Timestamp property. It is not supported by CMEK compliant deployment. This field is a member of oneof_ value_type_options.