Firestore v1 API - Class CreateDocumentRequest (3.3.0)

public sealed class CreateDocumentRequest : IMessage<CreateDocumentRequest>, IEquatable<CreateDocumentRequest>, IDeepCloneable<CreateDocumentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class CreateDocumentRequest.

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

Inheritance

object > CreateDocumentRequest

Implements

IMessage CreateDocumentRequest, IEquatable CreateDocumentRequest, IDeepCloneable CreateDocumentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

CreateDocumentRequest()

public CreateDocumentRequest()

CreateDocumentRequest(CreateDocumentRequest)

public CreateDocumentRequest(CreateDocumentRequest other)

Parameter
Name	Description
`other`	`CreateDocumentRequest`

Properties

CollectionId

public string CollectionId { get; set; }

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

Property Value
Type	Description
`string`

Document

public Document Document { get; set; }

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

Property Value
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`string`