Class CreateDocumentRequest (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class CreateDocumentRequest : IMessage<CreateDocumentRequest>, IEquatable<CreateDocumentRequest>, IDeepCloneable<CreateDocumentRequest>, IBufferMessage, IMessage

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

Inheritance

Object > CreateDocumentRequest

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

CreateDocumentRequest()

public CreateDocumentRequest()

CreateDocumentRequest(CreateDocumentRequest)

public CreateDocumentRequest(CreateDocumentRequest other)
Parameter
NameDescription
otherCreateDocumentRequest

Properties

CollectionId

public string CollectionId { get; set; }

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

Property Value
TypeDescription
String

Document

public Document Document { get; set; }

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

Property Value
TypeDescription
Document

DocumentId

public string DocumentId { get; set; }

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

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

Property Value
TypeDescription
String

Mask

public DocumentMask Mask { get; set; }

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.

Property Value
TypeDescription
DocumentMask

Parent

public string Parent { get; set; }

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

Property Value
TypeDescription
String