Class ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource.GetDocumentRequest

Returns relevant fields present in the requested document.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDocumentaiV1beta3GetDocumentResponse>
DocumentBaseServiceRequest<GoogleCloudDocumentaiV1beta3GetDocumentResponse>
ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource.GetDocumentRequest
Implements
Inherited Members
Namespace: Google.Apis.Document.v1beta3
Assembly: Google.Apis.Document.v1beta3.dll
Syntax
public class ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource.GetDocumentRequest : DocumentBaseServiceRequest<GoogleCloudDocumentaiV1beta3GetDocumentResponse>, IClientServiceRequest<GoogleCloudDocumentaiV1beta3GetDocumentResponse>, IClientServiceRequest

Constructors

GetDocumentRequest(IClientService, string)

Constructs a new GetDocument request.

Declaration
public GetDocumentRequest(IClientService service, string dataset)
Parameters
Type Name Description
IClientService service
string dataset

Properties

Dataset

Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset

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

DocumentIdGcsManagedDocIdCwDocId

Id of the document (indexed) managed by Content Warehouse.

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

DocumentIdGcsManagedDocIdGcsUri

Required. The Cloud Storage URI where the actual document is stored.

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

DocumentIdRevisionRefLatestProcessorVersion

Reads the revision generated by the processor version. The format takes the full resource name of processor version. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

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

DocumentIdRevisionRefRevisionCase

Reads the revision by the predefined case.

Declaration
[RequestParameter("documentId.revisionRef.revisionCase", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource.GetDocumentRequest.DocumentIdRevisionRefRevisionCaseEnum? DocumentIdRevisionRefRevisionCase { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource.GetDocumentRequest.DocumentIdRevisionRefRevisionCaseEnum?

DocumentIdRevisionRefRevisionId

Reads the revision given by the id.

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

DocumentIdUnmanagedDocIdDocId

Required. The id of the document.

Declaration
[RequestParameter("documentId.unmanagedDocId.docId", RequestParameterType.Query)]
public virtual string DocumentIdUnmanagedDocIdDocId { get; set; }
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

PageRangeEnd

Last page number (one-based index) to be returned.

Declaration
[RequestParameter("pageRange.end", RequestParameterType.Query)]
public virtual int? PageRangeEnd { get; set; }
Property Value
Type Description
int?

PageRangeStart

First page number (one-based index) to be returned.

Declaration
[RequestParameter("pageRange.start", RequestParameterType.Query)]
public virtual int? PageRangeStart { get; set; }
Property Value
Type Description
int?

ReadMask

If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

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

RestPath

Gets the REST path.

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

Methods

InitParameters()

Initializes GetDocument parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements