Class ProjectsResource.DatabasesResource.DocumentsResource.DeleteRequest

Deletes a document.

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

Constructors

DeleteRequest(IClientService, string)

Constructs a new Delete request.

Declaration
public DeleteRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

CurrentDocumentExists

When set to true, the target document must exist. When set to false, the target document must not exist.

Declaration
[RequestParameter("currentDocument.exists", RequestParameterType.Query)]
public virtual bool? CurrentDocumentExists { get; set; }
Property Value
Type Description
bool?

CurrentDocumentUpdateTime

object representation of CurrentDocumentUpdateTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use CurrentDocumentUpdateTimeDateTimeOffset instead.")]
public virtual object CurrentDocumentUpdateTime { get; set; }
Property Value
Type Description
object

CurrentDocumentUpdateTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? CurrentDocumentUpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CurrentDocumentUpdateTimeRaw

String representation of CurrentDocumentUpdateTimeDateTimeOffset, formatted for inclusion in the HTTP request.

Declaration
[RequestParameter("currentDocument.updateTime", RequestParameterType.Query)]
public virtual string CurrentDocumentUpdateTimeRaw { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

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

MethodName

Gets the method name.

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

Name

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

RestPath

Gets the REST path.

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

Methods

InitParameters()

Initializes Delete parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements