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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.HttpMethod

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.MethodName

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Firestore.v1beta1.Data.Document>.GetBody()

InitParameters()

Initializes CreateDocument parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements