Struct gapi_grpc::google::firestore::v1::CreateDocumentRequest

[+] Show declaration

pub struct CreateDocumentRequest {
    pub parent: String,
    pub collection_id: String,
    pub document_id: String,
    pub document: Option<Document>,
    pub mask: Option<DocumentMask>,
}

[−] Expand description

The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

Fields

parent: String

[−] Expand description

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

collection_id: String

[−] Expand description

Required. The collection ID, relative to parent, to list. For example: chatrooms.

document_id: String

[−] Expand description

The client-assigned document ID to use for this document.

Optional. If not specified, an ID will be assigned by the service.

document: Option<Document>

[−] Expand description

Required. The document to create. name must not be set.

mask: Option<DocumentMask>

[−] Expand description

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

Trait Implementations

impl Clone for CreateDocumentRequest[+]

[+] Show hidden undocumented items

fn clone(&self) -> CreateDocumentRequest[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for CreateDocumentRequest[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for CreateDocumentRequest[+]

[+] Show hidden undocumented items

fn default() -> CreateDocumentRequest[−]

Returns the “default value” for a type.

impl Message for CreateDocumentRequest[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub 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.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

impl PartialEq<CreateDocumentRequest> for CreateDocumentRequest[+]

[+] Show hidden undocumented items

fn eq(&self, other: &CreateDocumentRequest) -> bool[−]

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

fn ne(&self, other: &CreateDocumentRequest) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for CreateDocumentRequest