Struct google_api_proto::google::cloud::contentwarehouse::v1::PropertyDefinition

pub struct PropertyDefinition {
    pub name: String,
    pub display_name: String,
    pub is_repeatable: bool,
    pub is_filterable: bool,
    pub is_searchable: bool,
    pub is_metadata: bool,
    pub is_required: bool,
    pub retrieval_importance: i32,
    pub schema_sources: Vec<SchemaSource>,
    pub value_type_options: Option<ValueTypeOptions>,
}

Defines the metadata for a schema property.

Fields

name: String

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: String

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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.

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.

retrieval_importance: i32

The retrieval importance of the property during search.

schema_sources: Vec<SchemaSource>

The mapping information between this property to another schema source.

value_type_options: Option<ValueTypeOptions>

Type of the property.

Implementations

impl PropertyDefinition

pub fn retrieval_importance(&self) -> RetrievalImportance

Returns the enum value of retrieval_importance, or the default if the field is set to an invalid enum value.

pub fn set_retrieval_importance(&mut self, value: RetrievalImportance)

Sets retrieval_importance to the provided enum value.

Trait Implementations

impl Clone for PropertyDefinition

fn clone(&self) -> PropertyDefinition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PropertyDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PropertyDefinition

fn default() -> Self

Returns the “default value” for a type.

impl Message for PropertyDefinition

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PropertyDefinition

fn eq(&self, other: &PropertyDefinition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PropertyDefinition