Class ProjectsResource.DatabasesResource.DocumentsResource.GetRequest

Gets a single document.

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

Constructors

GetRequest(IClientService, string)

Constructs a new Get request.

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

Properties

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

Name

Required. The resource name of the Document to get. 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

ReadTime

Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Declaration
[RequestParameter("readTime", RequestParameterType.Query)]
public virtual object ReadTime { get; set; }
Property Value
Type Description
object

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

Transaction

Reads the document in a transaction.

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

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements