Struct googapis::google::firestore::admin::v1beta2::Field [−][src]
pub struct Field {
pub name: String,
pub index_config: Option<IndexConfig>,
}
Expand description
Represents a single field in the database.
Fields are grouped by their “Collection Group”, which represent all collections in the database with the same id.
Fields
name: String
A field name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may be a simple field name, e.g. address
or a path to fields
within map_value , e.g. address.city
,
or a special field path. The only valid special field is *
, which
represents any field.
Field paths may be quoted using (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:
*,
., ``` (backtick),
[,
]`, as well as any ascii symbolic characters.
Examples:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
\
address.city`represents a field named
address.city, not the map key
cityin the field
address.
``represents a field named
`, not any field.
A special Field
contains the default indexing settings for all fields.
This field’s resource name is:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*
Indexes defined on this Field
will be applied to all fields which do not
have their own Field
index configuration.
index_config: Option<IndexConfig>
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by the ancestor_field
. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Field
impl UnwindSafe for Field
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more