Class ProjectsResource.DatabasesResource.DocumentsResource.CreateDocumentRequest

Creates a new document.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Document>
FirestoreBaseServiceRequest<Document>
ProjectsResource.DatabasesResource.DocumentsResource.CreateDocumentRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1beta1
Assembly: Google.Apis.Firestore.v1beta1.dll
Syntax
public class ProjectsResource.DatabasesResource.DocumentsResource.CreateDocumentRequest : FirestoreBaseServiceRequest<Document>, IClientServiceRequest<Document>, IClientServiceRequest

Constructors

CreateDocumentRequest(IClientService, Document, string, string)

Constructs a new CreateDocument request.

Declaration
public CreateDocumentRequest(IClientService service, Document body, string parent, string collectionId)
Parameters
Type Name Description
IClientService service
Document body
string parent
string collectionId

Properties

CollectionId

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

Declaration
[RequestParameter("collectionId", RequestParameterType.Path)]
public virtual string CollectionId { get; }
Property Value
Type Description
string

DocumentId

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

Declaration
[RequestParameter("documentId", RequestParameterType.Query)]
public virtual string DocumentId { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaskFieldPaths

The list of field paths in the mask. See Document.fields for a field path syntax reference.

Declaration
[RequestParameter("mask.fieldPaths", RequestParameterType.Query)]
public virtual Repeatable<string> MaskFieldPaths { get; set; }
Property Value
Type Description
Repeatable<string>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RequestOptionsRequestTags

Optional. The request tags for the request. Request tags are user-provided strings used for usage monitoring, cost management, and observability. Callers can associate custom application context (such as component, microservice, feature name, or operation type) with database requests. These tags are collected and aggregated in usage and monitoring reports, allowing billable operations and usage metrics to be sliced and analyzed by tag. These tags only show up in monitoring and are visible in administrative operations (such as usage reports). They do not affect data storage, query semantics, or request execution. Cardinality and Best Practices:

  • Request tags are most effective when using a bounded set of distinct values (e.g., fewer than 100 distinct tags across an entire database). Using a large number of distinct tags may result in tags being omitted from top usage dashboards. - Use structured identifiers (for example: app=cart, env=prod, service=checkout) and avoid high-cardinality values such as UUIDs, request IDs, timestamps, user IDs, or document keys. - Do not include sensitive data or personally identifiable information (PII) in request tags, as they show up in administrative monitoring. The tags are processed as follows: - Leading and trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out. - Truncated to a maximum of 510 characters. - Deduplicated within the same request. - Limited to a maximum of 50 tags per request (excess tags are silently discarded).
Declaration
[RequestParameter("requestOptions.requestTags", RequestParameterType.Query)]
public virtual Repeatable<string> RequestOptionsRequestTags { get; set; }
Property Value
Type Description
Repeatable<string>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes CreateDocument parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements