Class protos.google.cloud.documentai.v1beta3.DocumentService (9.2.0)

Represents a DocumentService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.documentai.v1beta3.DocumentService

Package

@google-cloud/documentai

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DocumentService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchDeleteDocuments(request, callback)

public batchDeleteDocuments(request: google.cloud.documentai.v1beta3.IBatchDeleteDocumentsRequest, callback: google.cloud.documentai.v1beta3.DocumentService.BatchDeleteDocumentsCallback): void;

Calls BatchDeleteDocuments.

Parameters
Name Description
request IBatchDeleteDocumentsRequest

BatchDeleteDocumentsRequest message or plain object
callback BatchDeleteDocumentsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchDeleteDocuments(request)

public batchDeleteDocuments(request: google.cloud.documentai.v1beta3.IBatchDeleteDocumentsRequest): Promise<google.longrunning.Operation>;

Calls BatchDeleteDocuments.

Parameter
Name Description
request IBatchDeleteDocumentsRequest

BatchDeleteDocumentsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DocumentService;

Creates new DocumentService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
DocumentService

RPC service. Useful where requests and/or responses are streamed.

getDatasetSchema(request, callback)

public getDatasetSchema(request: google.cloud.documentai.v1beta3.IGetDatasetSchemaRequest, callback: google.cloud.documentai.v1beta3.DocumentService.GetDatasetSchemaCallback): void;

Calls GetDatasetSchema.

Parameters
Name Description
request IGetDatasetSchemaRequest

GetDatasetSchemaRequest message or plain object
callback GetDatasetSchemaCallback

Node-style callback called with the error, if any, and DatasetSchema
Returns
Type Description
void

getDatasetSchema(request)

public getDatasetSchema(request: google.cloud.documentai.v1beta3.IGetDatasetSchemaRequest): Promise<google.cloud.documentai.v1beta3.DatasetSchema>;

Calls GetDatasetSchema.

Parameter
Name Description
request IGetDatasetSchemaRequest

GetDatasetSchemaRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.DatasetSchema>

Promise

getDocument(request, callback)

public getDocument(request: google.cloud.documentai.v1beta3.IGetDocumentRequest, callback: google.cloud.documentai.v1beta3.DocumentService.GetDocumentCallback): void;

Calls GetDocument.

Parameters
Name Description
request IGetDocumentRequest

GetDocumentRequest message or plain object
callback GetDocumentCallback

Node-style callback called with the error, if any, and GetDocumentResponse
Returns
Type Description
void

getDocument(request)

public getDocument(request: google.cloud.documentai.v1beta3.IGetDocumentRequest): Promise<google.cloud.documentai.v1beta3.GetDocumentResponse>;

Calls GetDocument.

Parameter
Name Description
request IGetDocumentRequest

GetDocumentRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.GetDocumentResponse>

Promise

importDocuments(request, callback)

public importDocuments(request: google.cloud.documentai.v1beta3.IImportDocumentsRequest, callback: google.cloud.documentai.v1beta3.DocumentService.ImportDocumentsCallback): void;

Calls ImportDocuments.

Parameters
Name Description
request IImportDocumentsRequest

ImportDocumentsRequest message or plain object
callback ImportDocumentsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

importDocuments(request)

public importDocuments(request: google.cloud.documentai.v1beta3.IImportDocumentsRequest): Promise<google.longrunning.Operation>;

Calls ImportDocuments.

Parameter
Name Description
request IImportDocumentsRequest

ImportDocumentsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listDocuments(request, callback)

public listDocuments(request: google.cloud.documentai.v1beta3.IListDocumentsRequest, callback: google.cloud.documentai.v1beta3.DocumentService.ListDocumentsCallback): void;

Calls ListDocuments.

Parameters
Name Description
request IListDocumentsRequest

ListDocumentsRequest message or plain object
callback ListDocumentsCallback

Node-style callback called with the error, if any, and ListDocumentsResponse
Returns
Type Description
void

listDocuments(request)

public listDocuments(request: google.cloud.documentai.v1beta3.IListDocumentsRequest): Promise<google.cloud.documentai.v1beta3.ListDocumentsResponse>;

Calls ListDocuments.

Parameter
Name Description
request IListDocumentsRequest

ListDocumentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.ListDocumentsResponse>

Promise

updateDataset(request, callback)

public updateDataset(request: google.cloud.documentai.v1beta3.IUpdateDatasetRequest, callback: google.cloud.documentai.v1beta3.DocumentService.UpdateDatasetCallback): void;

Calls UpdateDataset.

Parameters
Name Description
request IUpdateDatasetRequest

UpdateDatasetRequest message or plain object
callback UpdateDatasetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateDataset(request)

public updateDataset(request: google.cloud.documentai.v1beta3.IUpdateDatasetRequest): Promise<google.longrunning.Operation>;

Calls UpdateDataset.

Parameter
Name Description
request IUpdateDatasetRequest

UpdateDatasetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateDatasetSchema(request, callback)

public updateDatasetSchema(request: google.cloud.documentai.v1beta3.IUpdateDatasetSchemaRequest, callback: google.cloud.documentai.v1beta3.DocumentService.UpdateDatasetSchemaCallback): void;

Calls UpdateDatasetSchema.

Parameters
Name Description
request IUpdateDatasetSchemaRequest

UpdateDatasetSchemaRequest message or plain object
callback UpdateDatasetSchemaCallback

Node-style callback called with the error, if any, and DatasetSchema
Returns
Type Description
void

updateDatasetSchema(request)

public updateDatasetSchema(request: google.cloud.documentai.v1beta3.IUpdateDatasetSchemaRequest): Promise<google.cloud.documentai.v1beta3.DatasetSchema>;

Calls UpdateDatasetSchema.

Parameter
Name Description
request IUpdateDatasetSchemaRequest

UpdateDatasetSchemaRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.DatasetSchema>

Promise