Class protos.google.cloud.contentwarehouse.v1.DocumentService (1.7.0)

Represents a DocumentService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.contentwarehouse.v1.DocumentService

Package

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

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.

createDocument(request, callback)

public createDocument(request: google.cloud.contentwarehouse.v1.ICreateDocumentRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.CreateDocumentCallback): void;

Calls CreateDocument.

Parameters
Name	Description
`request`	`ICreateDocumentRequest` CreateDocumentRequest message or plain object
`callback`	`CreateDocumentCallback` Node-style callback called with the error, if any, and CreateDocumentResponse

Returns
Type	Description
`void`

createDocument(request)

public createDocument(request: google.cloud.contentwarehouse.v1.ICreateDocumentRequest): Promise<google.cloud.contentwarehouse.v1.CreateDocumentResponse>;

Calls CreateDocument.

Parameter
Name	Description
`request`	`ICreateDocumentRequest` CreateDocumentRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.CreateDocumentResponse>`	Promise

deleteDocument(request, callback)

public deleteDocument(request: google.cloud.contentwarehouse.v1.IDeleteDocumentRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.DeleteDocumentCallback): void;

Calls DeleteDocument.

Parameters
Name	Description
`request`	`IDeleteDocumentRequest` DeleteDocumentRequest message or plain object
`callback`	`DeleteDocumentCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteDocument(request)

public deleteDocument(request: google.cloud.contentwarehouse.v1.IDeleteDocumentRequest): Promise<google.protobuf.Empty>;

Calls DeleteDocument.

Parameter
Name	Description
`request`	`IDeleteDocumentRequest` DeleteDocumentRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

fetchAcl(request, callback)

public fetchAcl(request: google.cloud.contentwarehouse.v1.IFetchAclRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.FetchAclCallback): void;

Calls FetchAcl.

Parameters
Name	Description
`request`	`IFetchAclRequest` FetchAclRequest message or plain object
`callback`	`FetchAclCallback` Node-style callback called with the error, if any, and FetchAclResponse

Returns
Type	Description
`void`

fetchAcl(request)

public fetchAcl(request: google.cloud.contentwarehouse.v1.IFetchAclRequest): Promise<google.cloud.contentwarehouse.v1.FetchAclResponse>;

Calls FetchAcl.

Parameter
Name	Description
`request`	`IFetchAclRequest` FetchAclRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.FetchAclResponse>`	Promise

getDocument(request, callback)

public getDocument(request: google.cloud.contentwarehouse.v1.IGetDocumentRequest, callback: google.cloud.contentwarehouse.v1.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 Document

Returns
Type	Description
`void`

getDocument(request)

public getDocument(request: google.cloud.contentwarehouse.v1.IGetDocumentRequest): Promise<google.cloud.contentwarehouse.v1.Document>;

Calls GetDocument.

Parameter
Name	Description
`request`	`IGetDocumentRequest` GetDocumentRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.Document>`	Promise

lockDocument(request, callback)

public lockDocument(request: google.cloud.contentwarehouse.v1.ILockDocumentRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.LockDocumentCallback): void;

Calls LockDocument.

Parameters
Name	Description
`request`	`ILockDocumentRequest` LockDocumentRequest message or plain object
`callback`	`LockDocumentCallback` Node-style callback called with the error, if any, and Document

Returns
Type	Description
`void`

lockDocument(request)

public lockDocument(request: google.cloud.contentwarehouse.v1.ILockDocumentRequest): Promise<google.cloud.contentwarehouse.v1.Document>;

Calls LockDocument.

Parameter
Name	Description
`request`	`ILockDocumentRequest` LockDocumentRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.Document>`	Promise

searchDocuments(request, callback)

public searchDocuments(request: google.cloud.contentwarehouse.v1.ISearchDocumentsRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.SearchDocumentsCallback): void;

Calls SearchDocuments.

Parameters
Name	Description
`request`	`ISearchDocumentsRequest` SearchDocumentsRequest message or plain object
`callback`	`SearchDocumentsCallback` Node-style callback called with the error, if any, and SearchDocumentsResponse

Returns
Type	Description
`void`

searchDocuments(request)

public searchDocuments(request: google.cloud.contentwarehouse.v1.ISearchDocumentsRequest): Promise<google.cloud.contentwarehouse.v1.SearchDocumentsResponse>;

Calls SearchDocuments.

Parameter
Name	Description
`request`	`ISearchDocumentsRequest` SearchDocumentsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.SearchDocumentsResponse>`	Promise

setAcl(request, callback)

public setAcl(request: google.cloud.contentwarehouse.v1.ISetAclRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.SetAclCallback): void;

Calls SetAcl.

Parameters
Name	Description
`request`	`ISetAclRequest` SetAclRequest message or plain object
`callback`	`SetAclCallback` Node-style callback called with the error, if any, and SetAclResponse

Returns
Type	Description
`void`

setAcl(request)

public setAcl(request: google.cloud.contentwarehouse.v1.ISetAclRequest): Promise<google.cloud.contentwarehouse.v1.SetAclResponse>;

Calls SetAcl.

Parameter
Name	Description
`request`	`ISetAclRequest` SetAclRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.SetAclResponse>`	Promise

updateDocument(request, callback)

public updateDocument(request: google.cloud.contentwarehouse.v1.IUpdateDocumentRequest, callback: google.cloud.contentwarehouse.v1.DocumentService.UpdateDocumentCallback): void;

Calls UpdateDocument.

Parameters
Name	Description
`request`	`IUpdateDocumentRequest` UpdateDocumentRequest message or plain object
`callback`	`UpdateDocumentCallback` Node-style callback called with the error, if any, and UpdateDocumentResponse

Returns
Type	Description
`void`

updateDocument(request)

public updateDocument(request: google.cloud.contentwarehouse.v1.IUpdateDocumentRequest): Promise<google.cloud.contentwarehouse.v1.UpdateDocumentResponse>;

Calls UpdateDocument.

Parameter
Name	Description
`request`	`IUpdateDocumentRequest` UpdateDocumentRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.contentwarehouse.v1.UpdateDocumentResponse>`	Promise