Class DocumentsGrpc.DocumentsStub (4.23.0)

public static final class DocumentsGrpc.DocumentsStub extends AbstractAsyncStub<DocumentsGrpc.DocumentsStub>

A stub to allow clients to do asynchronous rpc calls to service Documents.

Service for managing knowledge Documents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > DocumentsGrpc.DocumentsStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentsGrpc.DocumentsStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`DocumentsGrpc.DocumentsStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request, StreamObserver<Operation> responseObserver)

public void createDocument(CreateDocumentRequest request, StreamObserver<Operation> responseObserver)

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

Parameters
Name	Description
`request`	`CreateDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteDocument(DeleteDocumentRequest request, StreamObserver<Operation> responseObserver)

public void deleteDocument(DeleteDocumentRequest request, StreamObserver<Operation> responseObserver)

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: An Empty message

Parameters
Name	Description
`request`	`DeleteDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

exportDocument(ExportDocumentRequest request, StreamObserver<Operation> responseObserver)

public void exportDocument(ExportDocumentRequest request, StreamObserver<Operation> responseObserver)

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

Parameters
Name	Description
`request`	`ExportDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

public void getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

Retrieves the specified document.

Parameters
Name	Description
`request`	`GetDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Document>`

importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)

public void importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: ImportDocumentsResponse

Parameters
Name	Description
`request`	`ImportDocumentsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

public void listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

Returns the list of all documents of the knowledge base.

Parameters
Name	Description
`request`	`ListDocumentsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListDocumentsResponse>`

reloadDocument(ReloadDocumentRequest request, StreamObserver<Operation> responseObserver)

public void reloadDocument(ReloadDocumentRequest request, StreamObserver<Operation> responseObserver)

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
`request`	`ReloadDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateDocument(UpdateDocumentRequest request, StreamObserver<Operation> responseObserver)

public void updateDocument(UpdateDocumentRequest request, StreamObserver<Operation> responseObserver)

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

Parameters
Name	Description
`request`	`UpdateDocumentRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`